Skip to main content
GET
Get Agent

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agent_id
string
required

Response

Request fulfilled, document follows

agent_id
string
required
workspace_id
string
required
name
string
required
status
enum<string>
required
Available options:
active,
archived
publication_state
enum<string>
required

live once at least one version is published; draft agents cannot take sessions yet.

Available options:
live,
draft
created_at
string<date-time>
required
updated_at
string<date-time>
required
description
string
default:""
public_enabled
boolean
default:false
allowed_origins
string[]
overrides_allowed
enum<string>[]
Available options:
first_message,
system_prompt,
voice_profile_id,
language