Skip to main content
GET
JavaScript

Authorizations

X-API-Key
string
header
required

Path Parameters

agent_id
string<uuid>
required

The ID of the agent to retrieve.

Query Parameters

version
enum<string>
default:published

Version of the agent to retrieve. Use published for the live version, or draft for the latest unpublished changes for the same agent. Defaults to published.

Available options:
published,
draft

Response

Successful Response

Detailed information for an agent.

id
string<uuid>
required

Unique ID for the agent.

organization_id
string<uuid>
required

Unique ID of the organization that owns the agent.

name
string
required

Display name of the agent.

status
enum<string>
required

Current status of the agent.

Available options:
draft,
published,
unknown
created_at
string<date-time>
required

When the agent was created.

description
string | null

Short description of the agent, if provided.

schema
AgentSchema · object | null

Input and output schemas for this agent. Omitted while the agent's graph cannot be previewed (e.g. an empty or structurally-invalid draft); check validation to see what needs fixing.

validation
AgentValidation · object | null

Validation report for the agent's graph, when available. Use validation.valid to check the agent is publishable.