Skip to main content
POST
TypeScript (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
roleName
string

Exact, case-sensitive role name, unique within the caller's organization. Supply role_name or role_id. For updates, name is the new name.

name
string
description
string
allowedModels
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_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_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
defaultModel
enum<string> | null
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_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_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
allowModelChoice
boolean

Wrapper message for bool.

The JSON representation for BoolValue is JSON true and false.

Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.

clearAllowedModelIds
boolean

Clears allowed_models back to "all models allowed". Needed because proto3 cannot distinguish an empty repeated field from an absent one.

color
string | null

Omitted preserves the existing value; empty resets to the default.

icon
string | null
roleId
string

Existing role ID. Prefer role_name; if both are supplied they must match.

Response

Success

role
role · object