---
title: "List Custom Agents"
method: GET
path: "/v3/custom-agents"
tags: ["Custom Agents"]
---

# List Custom Agents

`GET /v3/custom-agents`

## Request

- Base URL: `https://api.heygen.com`
- URL: `https://api.heygen.com/v3/custom-agents`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Returns the installed custom agents. Each entry carries id, name, description, and the internal workflow_type.

## Response `200`

Successful response

- object
  - `data` CustomAgentListResponse: 200 response body for GET /v3/custom-agents.
    - `agents` CustomAgentDetail[], required
      - `id` string, required: Agent id used in the URL path (e.g. `chiron`).
      - `name` string, required: Human-readable name.
      - `description` string, required: What the agent produces.
      - `workflow_type` string, required: Internal Temporal workflow type executed for this agent.

## Other responses

- `400`: Invalid request parameters
- `401`: Authentication failed
- `429`: Rate limit exceeded

## Changes

- **2026-11-03** `7dfa5e59b4f5`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/heygen/apis/heygen-external-api/changes/v3/custom-agents/get.md)

---

[API](https://skmtc.dev/heygen/apis/heygen-external-api.md) - [All operations](https://skmtc.dev/heygen/apis/heygen-external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/heygen/apis/heygen-external-api/revisions/7dfa5e59b4f5?raw)