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": [
    {}
  ]
}
'
{
  "task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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>