GET
/
agents
/
external-chat
curl --request GET \
  --url http://localhost/api/v1/agents/external-chat \
  --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,
    "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.

Query Parameters

​
include_hidden
boolean
default:false
​
ids
string[] | null
​
names
string[] | null

Response

200
application/json

Successful Response

The response is of type ExternalChatAgent · object[].