--- title: "CreateChat" method: POST path: "/textql.rpc.public.chat.ChatService/CreateChat" tags: ["ChatService"] --- # CreateChat `POST /textql.rpc.public.chat.ChatService/CreateChat` ## Headers - `Connect-Protocol-Version` 1, required — Define the version of the Connect protocol - `Connect-Timeout-Ms` number — Define the timeout, in ms ## Request body - TextqlRpcPublicChatCreateRequest - `paradigm` TextqlRpcPublicParadigmParadigm — ChatParadigm includes paradigm options - `type` 'TYPE_UNKNOWN' | 'TYPE_UNIVERSAL' - `version` integer - `options` TextqlRpcPublicParadigmParadigmOptions - `universal` TextqlRpcPublicParadigmUniversalOptions, required - `connectorIds` integer[] - `datasetId` string, nullable - `webSearchEnabled` boolean - `sqlEnabled` boolean - `ontologyEnabled` boolean - `ontologyEditingEnabled` boolean - `pythonEnabled` boolean - `autoApproveEnabled` boolean - `googleDriveEnabled` boolean - `powerbiEnabled` boolean - `contextEditingEnabled` boolean - `formEditorEnabled` boolean - `playbookToolsEnabled` boolean - `microsoft365Enabled` boolean - `feedExplorerEnabled` boolean - `bashEnabled` boolean - `javascriptEnabled` boolean - `feedPostEnabled` boolean - `feedCommentEnabled` boolean - `feedEngageEnabled` boolean - `streamlitEnabled` boolean - `compactionDisabled` boolean - `gmailEnabled` boolean - `chatHistorySearchEnabled` boolean - `googleCalendarEnabled` boolean - `emailOutputEnabled` boolean - `powerbiSelections` TextqlRpcPowerbiSelectionPowerBISelection[] - `workspaceId` string - `reportIds` string[] - `datasetIds` string[] - `workspaceName` string - `connectorId` integer - `smsMode` boolean - `apiAccessKeyIds` string[] - `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' - `message` string, nullable — optionally pre-fill first message - `playbookId` string, nullable — optionally associate with a playbook - `research` boolean, nullable — whether to enable report mode for this chat - `dashboardMode` boolean, nullable — whether to enable dashboard mode for this chat - `methodology` 'METHODOLOGY_UNKNOWN' | 'METHODOLOGY_ADAPTIVE' | 'METHODOLOGY_PRESCRIPTIVE' | 'METHODOLOGY_THOROUGH' | 'METHODOLOGY_CAREFUL' | 'METHODOLOGY_ONTOLOGY_BUILDING' - `vllmModelId` string, 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. - `fastMode` boolean, 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. - `maxThinking` boolean, nullable — max_thinking runs extended thinking at max effort with visible reasoning. Supported on Sonnet 5, Fable 5, and Opus 4.8. ## Response `200` Success - TextqlRpcPublicChatCreateResponse - `chat` TextqlRpcPublicChatChat - `id` string — UUID - `paradigm` TextqlRpcPublicParadigmParadigm — ChatParadigm includes paradigm options - `type` 'TYPE_UNKNOWN' | 'TYPE_UNIVERSAL' - `version` integer - `options` TextqlRpcPublicParadigmParadigmOptions - `universal` TextqlRpcPublicParadigmUniversalOptions, required - `connectorIds` integer[] - `datasetId` string, nullable - `webSearchEnabled` boolean - `sqlEnabled` boolean - `ontologyEnabled` boolean - `ontologyEditingEnabled` boolean - `pythonEnabled` boolean - `autoApproveEnabled` boolean - `googleDriveEnabled` boolean - `powerbiEnabled` boolean - `contextEditingEnabled` boolean - `formEditorEnabled` boolean - `playbookToolsEnabled` boolean - `microsoft365Enabled` boolean - `feedExplorerEnabled` boolean - `bashEnabled` boolean - `javascriptEnabled` boolean - `feedPostEnabled` boolean - `feedCommentEnabled` boolean - `feedEngageEnabled` boolean - `streamlitEnabled` boolean - `compactionDisabled` boolean - `gmailEnabled` boolean - `chatHistorySearchEnabled` boolean - `googleCalendarEnabled` boolean - `emailOutputEnabled` boolean - `powerbiSelections` TextqlRpcPowerbiSelectionPowerBISelection[] - `workspaceId` string - `reportIds` string[] - `datasetIds` string[] - `workspaceName` string - `connectorId` integer - `smsMode` boolean - `apiAccessKeyIds` string[] - `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' - `timestamp` string, date-time — A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`]( http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime() ) to obtain a formatter capable of generating timestamps in this format. - `orgId` string - `memberId` string - `summary` string, nullable - `playbookId` string, nullable - `research` boolean, nullable — whether this chat was created with report mode enabled - `creatorEmail` string, nullable - `apiKeyClientId` string, nullable - `updatedAt` string, date-time — A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`]( http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime() ) to obtain a formatter capable of generating timestamps in this format. - `isBookmarked` boolean, nullable — whether this chat is bookmarked by the user - `preferredProvider` string, nullable - `templateDataId` string, nullable — UUID reference to playbook_template_data - `batchRunId` string, nullable — UUID reference to playbook_batch_run - `preview` string, nullable — preview/snippet of first message content - `dashboardMode` boolean, nullable — whether this chat was created with dashboard mode enabled - `source` 'CHAT_SOURCE_UNKNOWN' | 'CHAT_SOURCE_THREAD' | 'CHAT_SOURCE_PLAYBOOK' | 'CHAT_SOURCE_SLACK' | 'CHAT_SOURCE_FEED' | 'CHAT_SOURCE_TEAMS' | 'CHAT_SOURCE_SMS' | 'CHAT_SOURCE_MCP' | 'CHAT_SOURCE_SYSTEM' - `methodology` 'METHODOLOGY_UNKNOWN' | 'METHODOLOGY_ADAPTIVE' | 'METHODOLOGY_PRESCRIPTIVE' | 'METHODOLOGY_THOROUGH' | 'METHODOLOGY_CAREFUL' | 'METHODOLOGY_ONTOLOGY_BUILDING' - `isRunning` boolean, nullable — whether this chat has an active stream - `isUnread` boolean, nullable — whether updated_at > last_read_at for the requesting user - `vllmModelId` string, nullable — vllm_model_id is the per-chat model identifier for the org's vLLM endpoint. Only meaningful when model == MODEL_VLLM. - `fastMode` boolean, nullable — fast_mode enables Anthropic's fast inference mode (speed: "fast"). Currently supported on Opus 4.6 only. Pricing is 6x standard rates. - `agentId` string, nullable — Agent that owns this chat, unset for human-initiated chats. - `agentName` string, nullable - `agentProfileImageUrl` string, nullable - `maxThinking` boolean, nullable — max_thinking runs extended thinking at max effort with visible reasoning. Supported on Sonnet 5, Fable 5, and Opus 4.8. Thinking tokens bill as output tokens. ## Other responses - `default` — Error --- [API](https://skmtc.net/textql/apis/textql-rpc-platform.md) · [All operations](https://skmtc.net/textql/apis/textql-rpc-platform/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/textql/textql-rpc-platform/versions/31ce2b0c4427/schema)