Skip to main content
GET
List agents

Authorizations

Authorization
string
header
required

Headers

X-Account-ID
string

Tenant database (required only when using a Zitadel JWT; sk_live_ keys self-identify).

Response

Array of agents.

active_prompt_id
string
auth_mode
enum<string>

AuthMode gates whether the embeddable widget allows anonymous visitors. public accepts any visitor JWT; authenticated rejects guest tokens.

Available options:
public,
authenticated
Example:

"authenticated"

background_audio_enabled
boolean
Example:

false

background_audio_volume
number
Example:

0.8

category
enum<string>
Available options:
customer_support,
sales,
operations,
custom
Example:

"customer_support"

created_at
string
created_by
string
Example:

"user_01HZ2N…"

description
string
Example:

"Greets web visitors and answers product FAQs."

faqs
object[]
greeting_message
string
Example:

"Hi, this is the ACME front desk — how can I help?"

greeting_mode
enum<string>

GreetingMode controls whether the agent's opening line can be barged-in by the caller (interruptible) or must finish (locked).

Available options:
interruptible,
locked
Example:

"interruptible"

id
string
Example:

"agent_01HZ2N…"

llm_model
enum<string>
Available options:
gpt-4o,
gpt-4o-mini,
claude-3-5-sonnet
Example:

"gpt-4o"

name
string
Example:

"Front Desk"

noise_suppression_enabled
boolean
Example:

true

playbooks
object[]
ringing_enabled
boolean
Example:

true

status
enum<string>
Available options:
draft,
active,
archived
Example:

"active"

system_prompt
string
Example:

"You are a friendly front-desk assistant for ACME Corp."

template_id
string
Example:

"tmpl_general_intake"

updated_at
string
voice_id
string
Example:

"v1_friendly_female"

voice_provider
enum<string>
Available options:
cartesia,
elevenlabs,
deepgram
Example:

"cartesia"