Skip to main content
Get A Registered External Chat Completions Agent By Id.
curl --request GET \
  --url https://{api_endpoint}/api/v1/agents/external-chat/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_id": "<string>",
  "tenant_name": "<string>",
  "title": "<string>",
  "description": "<string>",
  "created_on": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "created_by_username": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "tags": [
    "<string>"
  ],
  "name": "<string>",
  "type": "<string>",
  "provider": "<string>",
  "nickname": "<string>",
  "hidden": false,
  "context_access_enabled": true,
  "context_variables": [
    "<string>"
  ],
  "api_url": "<string>",
  "auth_scheme": "BEARER_TOKEN",
  "instructions": "<string>",
  "auth_config": {},
  "chat_params": {},
  "enable_cot": false,
  "connection_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Response

Successful Response

​
name
string
required
​
type
string
required
​
api_url
string
required
​
id
string<uuid> | null
​
tenant_id
string | null
​
tenant_name
string | null
​
title
string | null
​
description
string | null
​
created_on
string<date-time> | null
​
created_by
string | null
​
created_by_username
string | null
​
updated_at
string<date-time> | null
​
tags
string[] | null
​
provider
string | null
​
nickname
string | null
​
hidden
boolean
default:false
​
context_access_enabled
boolean
default:true

Enable access to context variables for this agent

​
context_variables
string[] | null

List of context variable names that this agent can access

​
auth_scheme
enum<string>
Available options:
BEARER_TOKEN,
API_KEY,
NONE
​
instructions
string | null
​
auth_config
object
​
chat_params
object
​
enable_cot
boolean
default:false
​
connection_id
string | null