Skip to main content
POST
/
v3
/
semantic_model
/
save_documentation_task
/
{rag_config_id}
/
{table_name}
Save Documentation Task Endpoint
curl --request POST \
  --url https://agent-prod.studio.lyzr.ai/v3/semantic_model/save_documentation_task/{rag_config_id}/{table_name} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "descriptions": {
    "table_name": "string",
    "table_description": "string",
    "columns": [
      {
        "name": "string",
        "description": "string",
        "type": "string"
      }
    ]
  },
  "table_preview": [
    {
      "additionalProp1": {}
    }
  ]
}
'
{
  "task_id": "aa1c8ff4-1c39-4a63-9c56-df77eab86eb6"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
rag_config_id
string
required

The configuration ID for RAG

​
table_name
string
required

The name of the table

Body

application/json
​
descriptions
object
​
table_preview
object[]

Response

Task created successfully

​
task_id
string<uuid>