Skip to content

Get agents

GET
/api/v1/gen_agents

Retrieve agents. Options: 1. All agents (default). 2. By organization_id. 3. By agent_id (specific agent).

agent_id
Any of:
string
organization_id
Any of:
string
credit
Credit
boolean
default: true

Successful Response

Response Get Agents Api V1 Gen Agents Get
Array<object>
AgentResponse

Full agent response model

object
id
required
Id
string
name
required
Name
string
description
Any of:
string
credit_amount
Any of:
number
primary_avatar_url
Any of:
string
tiktok_integration
Tiktok Integration
boolean
degods
Degods
boolean
tiktok_social_account
Tiktok Social Account
boolean
role
Any of:
string
organization
Any of:
string
time_zone
Any of:
string
eleven_lab_api_key
Any of:
string
hume_ai_api_key
Any of:
string
key
additional properties
any

Invalid parameters or organization not found

ErrorResponse
object
detail
Any of:
string
error
Any of:
string
error_code
Any of:
string

Permission denied: You do not have permission for this agent.

ErrorResponse
object
detail
Any of:
string
error
Any of:
string
error_code
Any of:
string

Agent not found or UserVoiceResource not found.

ErrorResponse
object
detail
Any of:
string
error
Any of:
string
error_code
Any of:
string

Agent creation/update failed, validation error, or invalid API key (ElevenLabs/HumeAI).

ErrorResponse
object
detail
Any of:
string
error
Any of:
string
error_code
Any of:
string

Internal Server Error

ErrorResponse
object
detail
Any of:
string
error
Any of:
string
error_code
Any of:
string