curl --request POST \
--url https://app.textql.com/v1/chat/get \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"chatId": "<string>"
}
'{
"chat": {
"id": "<string>",
"paradigm": {
"type": "TYPE_UNKNOWN",
"version": 123,
"options": {
"basic": {}
}
},
"model": "MODEL_UNKNOWN",
"timestamp": "2023-11-07T05:31:56Z",
"orgId": "<string>",
"memberId": "<string>",
"summary": "<string>",
"playbookId": "<string>",
"research": true,
"creatorEmail": "<string>",
"apiKeyClientId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"isBookmarked": true,
"preferredProvider": "<string>",
"templateDataId": "<string>",
"batchRunId": "<string>"
}
}Retrieve details of a specific chat by ID
curl --request POST \
--url https://app.textql.com/v1/chat/get \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"chatId": "<string>"
}
'{
"chat": {
"id": "<string>",
"paradigm": {
"type": "TYPE_UNKNOWN",
"version": 123,
"options": {
"basic": {}
}
},
"model": "MODEL_UNKNOWN",
"timestamp": "2023-11-07T05:31:56Z",
"orgId": "<string>",
"memberId": "<string>",
"summary": "<string>",
"playbookId": "<string>",
"research": true,
"creatorEmail": "<string>",
"apiKeyClientId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"isBookmarked": true,
"preferredProvider": "<string>",
"templateDataId": "<string>",
"batchRunId": "<string>"
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Success
Show child attributes
UUID
ChatParadigm includes paradigm options
Show child attributes
TYPE_UNKNOWN, TYPE_SQL, TYPE_RESEARCH, TYPE_ONTOLOGY, TYPE_BASIC, TYPE_TABLEAU, TYPE_EXPERIMENTAL, TYPE_UNIVERSAL MODEL_UNKNOWN, MODEL_DEFAULT_SMALL, MODEL_DEFAULT, MODEL_DEFAULT_LARGE, MODEL_DEFAULT_REASONING, MODEL_HAIKU_3, MODEL_HAIKU_3_5, MODEL_SONNET_3_5, MODEL_SONNET_3_6, MODEL_SONNET_3_7, MODEL_SONNET_4, MODEL_OPUS_4, MODEL_SONNET_4_5, MODEL_HAIKU_4_5, MODEL_GPT_4, MODEL_GPT_4_TURBO, MODEL_GPT_4O, MODEL_GPT_4_1, MODEL_GPT_4_1_MINI, MODEL_GPT_4_1_NANO, MODEL_O_1, MODEL_O_1_MINI, MODEL_O_3, MODEL_O_3_MINI, MODEL_O_4_MINI, MODEL_GPT_5, MODEL_KIMI_K2_INSTRUCT, MODEL_QWEN3_CODER, MODEL_QWEN3_CODER_SMALL, MODEL_GPT_OSS, MODEL_GPT_OSS_SMALL, MODEL_GLM_4_5, MODEL_GLM_4_6, MODEL_KIMI_K2_THINKING RFC 3339 timestamp format (e.g., "2024-12-25T12:00:00Z")
whether this chat was created with report mode enabled
when chat was last updated
whether this chat is bookmarked by the user
UUID reference to playbook_template_data
UUID reference to playbook_batch_run