Release Notes
- What's new
- Known issues
- Troubleshooting
- License reference
Get Started
Environments
Large Language Models (LLMs)
Webchats
Tutorials
API's reference
- watsonx Orchestrate Developer Edition APIs
Legal notices
External Chat Agents
Get A Registered External Chat Completions Agent By Id.
GET
/
agents
/
external-chat
/
{id}
Copy
Ask AI
curl --request GET \
--url http://localhost/api/v1/agents/external-chat/{id} \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Response
200
application/json
Successful Response
The response is of type object
.
Copy
Ask AI
curl --request GET \
--url http://localhost/api/v1/agents/external-chat/{id} \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"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>"
}
Assistant
Responses are generated using AI and may contain mistakes.