Skip to main content
GET
Retrieve a list of voice agents

Authorizations

Authorization
string
header
required

Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '

Query Parameters

skip
integer
default:1
take
integer
default:10

A search query to search agents by name

Example:

"Test Agent"

sortField
enum<string>

Optional sort field

Available options:
createdAt
Example:

"createdAt"

sortOrder
enum<string>

Optional sort order

Available options:
asc,
desc
Example:

"desc"

type
string[]

Multi-select filter on the type of the voice agents to return

Example:
language
string[]

Multi-select filter on the language of the voice agents to return

Example:

Response

Successful response

success
boolean
default:false
message
string
default:success
data
object