---
title: "List Registered External Chat Completions Agants."
method: GET
path: "/v1/agents/external-chat"
tags: ["External Chat Agents"]
---

# List Registered External Chat Completions Agants.

`GET /v1/agents/external-chat`

## Query parameters

- `include_hidden` boolean
- `ids` string[], nullable
- `names` string[], nullable

## Response `200`

Successful Response

- ExternalChatAgent[]
  - `id` string, uuid, nullable
  - `tenant_id` string, nullable
  - `tenant_name` string, nullable
  - `title` string, nullable
  - `description` string, nullable
  - `created_on` string, date-time, nullable
  - `created_by` string, nullable
  - `created_by_username` string, nullable
  - `updated_at` string, date-time, nullable
  - `tags` string[], nullable
  - `name` string, required
  - `type` string, required
  - `provider` string, nullable
  - `nickname` string, nullable
  - `hidden` boolean
  - `context_access_enabled` boolean — Enable access to context variables for this agent
  - `context_variables` string[], nullable — List of context variable names that this agent can access
  - `api_url` string, required
  - `auth_scheme` 'BEARER_TOKEN' | 'API_KEY' | 'NONE'
  - `instructions` string, nullable
  - `auth_config` object
  - `chat_params` object
  - `enable_cot` boolean
  - `connection_id` string, nullable

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/ibm/apis/wxo-server-api.md) · [All operations](https://skmtc.net/ibm/apis/wxo-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ibm/wxo-server-api/revisions/82c114c37196/schema)