Skip to main content
GET
Get agent

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

id
string
required

Agent ID

Response

Successful response

An agent as returned by the API.

Note the asymmetry with the create/update payloads: you write configuration under config, and read it back under standardConfig (or customProvider). The type field tells you which one is present.

id
string
name
string
description
string | null
status
enum<string>

Only ACTIVE agents accept calls.

Available options:
ACTIVE,
INACTIVE,
SUSPENDED
type
enum<string>

standard agents carry standardConfig. custom agents use caller-supplied STT/LLM/TTS providers and carry customProvider.

Available options:
standard,
custom
workspaceId
string | null

The workspace this agent belongs to.

createdAt
string<date-time>
updatedAt
string<date-time>
standardConfig
object

Present when type is standard.

actions
object[]

Actions attached to this agent.

knowledgeBases
object[]

Knowledge bases attached to this agent.