Skip to main content
POST
Python (SDK)

Authorizations

tql_api_key
string
header
required

Headers

Connect-Protocol-Version
enum<number>
default:1
required

Define the version of the Connect protocol

Available options:
1
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json
playbookId
string
name
string | null
prompt
string | null
status
enum<string> | null
Available options:
STATUS_UNKNOWN,
STATUS_ACTIVE,
STATUS_INACTIVE,
STATUS_EMPTY,
ALL_PLAYBOOKS
triggerType
enum<string> | null
Available options:
TRIGGER_TYPE_UNKNOWN,
TRIGGER_TYPE_CRON,
TRIGGER_TYPE_WEBHOOK
cronString
string | null
datasetIds
dataset_ids · object | null
connectorId
integer<int32> | null
deprecated

Deprecated: use connector_ids instead

referenceReportId
string | null
paradigmOptions
paradigm_options · object | null
paradigmType
enum<string> | null
Available options:
TYPE_UNKNOWN,
TYPE_UNIVERSAL
emailAddresses
email_addresses · object | null
slackChannelId
string | null
taggedSlackUserIds
tagged_slack_user_ids · object | null
reportOutputStyle
enum<string> | null
Available options:
REPORT_STYLE_UNKNOWN,
EXECUTIVE_REPORT,
VERBOSE,
CONCISE
templateHeaderId
string | null
selectedTemplateDataIds
selected_template_data_ids · object | null
maxConcurrentTemplates
integer<int32> | null
autoOptimizeConcurrency
boolean | null
connectorIds
connector_ids · object | null
templateDataFilters
template_data_filters · object | null
llmModel
enum<string> | null
Available options:
MODEL_UNKNOWN,
MODEL_DEFAULT_SMALL,
MODEL_DEFAULT,
MODEL_DEFAULT_LARGE,
MODEL_DEFAULT_REASONING,
MODEL_HAIKU_4_5,
MODEL_OPUS_4_8,
MODEL_FABLE_5,
MODEL_SONNET_5,
MODEL_GPT_5_6_SOL,
MODEL_GEMINI_3_FLASH,
MODEL_GEMINI_3_PRO,
MODEL_GEMINI_3_1_PRO,
MODEL_GEMINI_3_5_FLASH,
MODEL_GPT_5_6_TERRA,
MODEL_GPT_5_6_LUNA,
MODEL_DEEPSEEK_3_2,
MODEL_GLM_5,
MODEL_VLLM,
MODEL_KIMI_K2_6,
MODEL_GLM_5_2,
MODEL_KIMI_K2_7_CODE,
MODEL_QWEN3_7_PLUS,
MODEL_MUSE_SPARK_1_1
chatAccessMode
enum<string> | null
Available options:
CHAT_ACCESS_MODE_INHERIT,
CHAT_ACCESS_MODE_CUSTOM
chatAccessOverrides
chat_access_overrides · object | null
chatIsPublic
boolean | null
dashboardIds
dashboard_ids · object | null
recipientEmailColumn
string | null
teamsChannelId
string | null
taggedTeamsUserAadIds
tagged_teams_user_aad_ids · object | null
apiAccessKeyIds
api_access_key_ids · object | null

Response

Success

playbook
playbook · object