Sign in

v1

latestOpenAPI 3.1.02026-07-263971,2281.1 MB
ChatService

CreateChat

post/textql.rpc.public.chat.ChatService/CreateChat

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

model'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'
messagestring nullable

optionally pre-fill first message

playbookIdstring nullable

optionally associate with a playbook

researchboolean nullable

whether to enable report mode for this chat

dashboardModeboolean nullable

whether to enable dashboard mode for this chat

methodology'METHODOLOGY_UNKNOWN' | 'METHODOLOGY_ADAPTIVE' | 'METHODOLOGY_PRESCRIPTIVE' | 'METHODOLOGY_THOROUGH' | 'METHODOLOGY_CAREFUL' | 'METHODOLOGY_ONTOLOGY_BUILDING'
vllmModelIdstring nullable

vllm_model_id is the model identifier forwarded to the org's vLLM endpoint. Only valid when model == MODEL_VLLM. Requires @textql.com superadmin.

fastModeboolean nullable

fast_mode enables Anthropic's fast inference (speed: "fast") for this chat. Currently supported on Opus 4.6 only. Pricing is 6x standard rates.

maxThinkingboolean nullable

max_thinking runs extended thinking at max effort with visible reasoning. Supported on Sonnet 5, Fable 5, and Opus 4.8.

Response

Success

Example response

{
  "chat": {
    "timestamp": "2023-01-15T01:30:15.01Z",
    "updatedAt": "2023-01-15T01:30:15.01Z"
  }
}