curl --request POST \
--url https://app.textql.com/v1/playbooks/get \
--header 'Authorization: Bearer <token>' \
--header 'Connect-Protocol-Version: <connect-protocol-version>' \
--header 'Content-Type: application/json' \
--data '
{
"playbookId": "<string>",
"limit": 1,
"offset": 1
}
'{
"playbook": {
"id": "<string>",
"orgId": "<string>",
"memberId": "<string>",
"connectorId": 123,
"name": "<string>",
"prompt": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"status": "STATUS_UNKNOWN",
"triggerType": "TRIGGER_TYPE_UNKNOWN",
"cronString": "<string>",
"datasetIds": [
"<string>"
],
"referenceReportId": "<string>",
"latestChatId": "<string>",
"emailAddresses": [
"<string>"
],
"slackChannelId": "<string>",
"taggedSlackUserIds": [
"<string>"
],
"llmModel": "MODEL_UNKNOWN",
"paradigmOptions": {
"basic": {}
},
"paradigmType": "TYPE_UNKNOWN",
"isRunning": true,
"owner": {
"memberId": "<string>",
"memberEmail": "<string>",
"memberName": "<string>",
"memberPictureUrl": "<string>"
},
"hasWritePermission": true,
"isSubscribed": true,
"reportOutputStyle": "REPORT_STYLE_UNKNOWN",
"templateHeaderId": "<string>",
"selectedTemplateDataIds": [
"<string>"
],
"maxConcurrentTemplates": 123,
"autoOptimizeConcurrency": true,
"connectorIds": [
123
],
"templateDataFilters": [
{
"field": "<string>",
"operator": "<string>",
"value": "<string>"
}
],
"parentPlaybookId": "<string>",
"originPlaybookId": "<string>",
"duplicatedByMemberId": "<string>",
"duplicatedAt": "2023-11-07T05:31:56Z",
"chatAccessMode": "CHAT_ACCESS_MODE_INHERIT",
"chatAccessOverrides": [
{
"memberId": "<string>",
"roleId": "<string>",
"accessType": "<string>"
}
],
"chatIsPublic": true,
"dashboardIds": [
"<string>"
]
},
"reports": [
{
"id": "<string>",
"chatId": "<string>",
"cellId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"subject": "<string>",
"summary": "<string>",
"blocks": [
{
"card": {
"blocks": "<array>"
}
}
],
"htmlPreview": "<string>",
"playbookId": "<string>",
"readAt": "2023-11-07T05:31:56Z",
"playbookTemplateDataId": "<string>"
}
],
"totalReportsCount": 123
}Get a playbook by playbookId
curl --request POST \
--url https://app.textql.com/v1/playbooks/get \
--header 'Authorization: Bearer <token>' \
--header 'Connect-Protocol-Version: <connect-protocol-version>' \
--header 'Content-Type: application/json' \
--data '
{
"playbookId": "<string>",
"limit": 1,
"offset": 1
}
'{
"playbook": {
"id": "<string>",
"orgId": "<string>",
"memberId": "<string>",
"connectorId": 123,
"name": "<string>",
"prompt": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"status": "STATUS_UNKNOWN",
"triggerType": "TRIGGER_TYPE_UNKNOWN",
"cronString": "<string>",
"datasetIds": [
"<string>"
],
"referenceReportId": "<string>",
"latestChatId": "<string>",
"emailAddresses": [
"<string>"
],
"slackChannelId": "<string>",
"taggedSlackUserIds": [
"<string>"
],
"llmModel": "MODEL_UNKNOWN",
"paradigmOptions": {
"basic": {}
},
"paradigmType": "TYPE_UNKNOWN",
"isRunning": true,
"owner": {
"memberId": "<string>",
"memberEmail": "<string>",
"memberName": "<string>",
"memberPictureUrl": "<string>"
},
"hasWritePermission": true,
"isSubscribed": true,
"reportOutputStyle": "REPORT_STYLE_UNKNOWN",
"templateHeaderId": "<string>",
"selectedTemplateDataIds": [
"<string>"
],
"maxConcurrentTemplates": 123,
"autoOptimizeConcurrency": true,
"connectorIds": [
123
],
"templateDataFilters": [
{
"field": "<string>",
"operator": "<string>",
"value": "<string>"
}
],
"parentPlaybookId": "<string>",
"originPlaybookId": "<string>",
"duplicatedByMemberId": "<string>",
"duplicatedAt": "2023-11-07T05:31:56Z",
"chatAccessMode": "CHAT_ACCESS_MODE_INHERIT",
"chatAccessOverrides": [
{
"memberId": "<string>",
"roleId": "<string>",
"accessType": "<string>"
}
],
"chatIsPublic": true,
"dashboardIds": [
"<string>"
]
},
"reports": [
{
"id": "<string>",
"chatId": "<string>",
"cellId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"subject": "<string>",
"summary": "<string>",
"blocks": [
{
"card": {
"blocks": "<array>"
}
}
],
"htmlPreview": "<string>",
"playbookId": "<string>",
"readAt": "2023-11-07T05:31:56Z",
"playbookTemplateDataId": "<string>"
}
],
"totalReportsCount": 123
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Define the version of the Connect protocol
1 Define the timeout, in ms