Create Chat

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

TypeScript (SDK)

TypeScript

import { Textql } from "@textql/sdk";

const textql = new Textql({
  apiKey: process.env["TEXTQL_API_KEY"] ?? "",
});

async function run() {
  const result = await textql.chats.createChat({
    body: {
      paradigm: {},
    },
  });

  console.log(result);
}

run();

200

{
  "chat": {
    "id": "<string>",
    "paradigm": {
      "type": "TYPE_UNKNOWN",
      "version": 123,
      "options": {
        "universal": {
          "connectorIds": [
            123
          ],
          "datasetId": "<string>",
          "webSearchEnabled": true,
          "sqlEnabled": true,
          "ontologyEnabled": true,
          "ontologyEditingEnabled": true,
          "pythonEnabled": true,
          "autoApproveEnabled": true,
          "googleDriveEnabled": true,
          "powerbiEnabled": true,
          "contextEditingEnabled": true,
          "formEditorEnabled": true,
          "playbookToolsEnabled": true,
          "microsoft365Enabled": true,
          "feedExplorerEnabled": true,
          "bashEnabled": true,
          "javascriptEnabled": true,
          "feedPostEnabled": true,
          "feedCommentEnabled": true,
          "feedEngageEnabled": true,
          "streamlitEnabled": true,
          "compactionDisabled": true,
          "gmailEnabled": true,
          "chatHistorySearchEnabled": true,
          "googleCalendarEnabled": true,
          "emailOutputEnabled": true,
          "powerbiSelections": [
            {
              "workspaceId": "<string>",
              "reportIds": [
                "<string>"
              ],
              "datasetIds": [
                "<string>"
              ],
              "workspaceName": "<string>",
              "connectorId": 123
            }
          ],
          "smsMode": true,
          "apiAccessKeyIds": [
            "<string>"
          ],
          "feedEnabled": true,
          "fileGenerationDisabled": true,
          "readFileEnabled": true,
          "ontologyActionsEnabled": true,
          "ontologyActionsAutoApproveEnabled": true,
          "feedExplorerSelected": true,
          "feedPostSelected": true,
          "feedCommentSelected": true,
          "feedEngageSelected": true
        }
      }
    },
    "model": "MODEL_UNKNOWN",
    "timestamp": "2023-01-15T01:30:15.01Z",
    "orgId": "<string>",
    "memberId": "<string>",
    "summary": "<string>",
    "playbookId": "<string>",
    "research": true,
    "creatorEmail": "<string>",
    "apiKeyClientId": "<string>",
    "updatedAt": "2023-01-15T01:30:15.01Z",
    "isBookmarked": true,
    "preferredProvider": "<string>",
    "templateDataId": "<string>",
    "batchRunId": "<string>",
    "preview": "<string>",
    "dashboardMode": true,
    "source": "CHAT_SOURCE_UNKNOWN",
    "methodology": "METHODOLOGY_UNKNOWN",
    "isRunning": true,
    "isUnread": true,
    "vllmModelId": "<string>",
    "fastMode": true,
    "agentId": "<string>",
    "agentName": "<string>",
    "agentProfileImageUrl": "<string>",
    "maxThinking": true,
    "harness": "<string>",
    "harnessEndpointId": "<string>"
  }
}

Authorizations

tql_api_key · string · header · required

Headers

Connect-Protocol-Version · enum<string> · default: 1 · required

Define the version of the Connect protocol

Available options: 1

Allowed value: "1"

Connect-Timeout-Ms · number

Define the timeout, in ms

Body

application/json

paradigm · paradigm · object · required

ChatParadigm includes paradigm options

Show child attributes

model · enum<string>

Available options: MODEL_UNKNOWN, MODEL_DEFAULT, MODEL_DEFAULT_SYSTEM, MODEL_HAIKU_4_5, MODEL_OPUS_4_8, MODEL_FABLE_5, MODEL_SONNET_5, MODEL_OPUS_5, MODEL_FABLE_5_1, MODEL_OPUS_5_5, MODEL_SONNET_5_5, MODEL_HAIKU_5_5, MODEL_FABLE_5_2, MODEL_GPT_5_6_SOL, MODEL_GEMINI_3_FLASH, MODEL_GEMINI_3_PRO, MODEL_GEMINI_3_1_PRO, MODEL_GEMINI_3_5_FLASH, MODEL_GEMINI_3_8_FLASH, MODEL_GPT_5_6_TERRA, MODEL_GPT_5_6_LUNA, MODEL_GPT_6_ASTRA, MODEL_GPT_6_SOL, MODEL_GPT_6_LUNA, MODEL_GPT_6_1_SOL, MODEL_GPT_6_1_TERRA, 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_KIMI_K3, MODEL_GLM_5_3_FLASH, MODEL_GLM_5_3, MODEL_DEEPSEEK_V4P1_FLASH, MODEL_MUSE_SPARK_1_1, MODEL_MUSE_SPARK_1_2

message · string | null

optionally pre-fill first message

playbookId · string | null

optionally associate with a playbook

research · boolean | null

whether to enable report mode for this chat

dashboardMode · boolean | null

whether to enable dashboard mode for this chat

methodology · enum<string> | null

optionally set chat methodology at creation

Available options: METHODOLOGY_UNKNOWN, METHODOLOGY_ADAPTIVE, METHODOLOGY_PRESCRIPTIVE, METHODOLOGY_THOROUGH, METHODOLOGY_CAREFUL, METHODOLOGY_ONTOLOGY_BUILDING

vllmModelId · string | null

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

fastMode · boolean | null

fast_mode enables Anthropic's fast inference (speed: "fast") for this chat. Supported on Opus 5.5, Opus 5, and Opus 4.8. Pricing is 2x standard rates.

maxThinking · boolean | null · deprecated

max_thinking runs extended thinking at max effort with visible reasoning. Supported on Sonnet 5, Sonnet 5.5, Fable 5, Fable 5.1, Fable 5.2, Opus 4.8, Opus 5, Opus 5.5, GPT 5.6 Sol/Terra/Luna, GPT-6 Astra/Sol/Luna, and GPT-6.1 Sol/Terra.

modelName · string | null

harness · string | null

harnessEndpointId · string | null

Response

200

application/json

Success

chat · chat · object

Show child attributes