Sign in
External Chat Agents

Get A Registered External Chat Completions Agent By Id.

get/v1/agents/external-chat/{id}

Path parameters

idstring required

Response

Successful Response

idstring uuid nullable
tenant_idstring nullable
tenant_namestring nullable
titlestring nullable
descriptionstring nullable
created_onstring date-time nullable
created_bystring nullable
created_by_usernamestring nullable
updated_atstring date-time nullable
tagsstring[] nullable
namestring required
typestring required
providerstring nullable
nicknamestring nullable
hiddenboolean
context_access_enabledboolean

Enable access to context variables for this agent

context_variablesstring[] nullable

List of context variable names that this agent can access

api_urlstring required
auth_scheme'BEARER_TOKEN' | 'API_KEY' | 'NONE'
instructionsstring nullable
auth_configobject
chat_paramsobject
enable_cotboolean
connection_idstring nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.