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
agentId
string
name
string
prompt
string
isActive
boolean
paradigmOptions
paradigm_options · object | null
slackChannelId
string | null
slackDmUserIds
string[]
skipOrgDefaultChannel
boolean
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
fastMode
boolean | null
isStateful
boolean | null
postingFrequencyCrons
string[]
emailRecipientMemberIds
string[]
updateEmailRecipients
boolean | null
channelIds
string[]
updateChannelIds
boolean | null
teamsChannelId
string | null
teamsDmUserAadIds
string[]
slackTrigger
slack_trigger · object | null
postingFrequencyCadences
string[]

Index-aligned with posting_frequency_crons. A non-empty cadence (HOURLY/FOUR-HOUR/EIGHT-HOUR/DAILY/WEEKLY) marks a flexible schedule whose cron the backend generates; "" (or an empty list) means exact.

Response

Success

agent
agent · object
chatId
string