List Agents

import requests

url = "http://localhost:3000/v1/agent/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "data": [
    {
      "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "modified_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version_number": 123,
      "version_created_at": "2023-11-07T05:31:56Z",
      "voice": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "description": "<string>"
      },
      "language": "es",
      "mode": "free",
      "version_name": "<string>",
      "is_draft": false,
      "is_published": false,
      "name": "<string>",
      "description": "<string>",
      "prompt": "<string>",
      "greeting": "<string>",
      "time_before_start": 123,
      "boosted_keywords": [
        "<string>"
      ],
      "redirect_number": "<string>",
      "max_reminder_count": 3,
      "reminder_frequency_ms": 7500,
      "reminder_messages": [],
      "knowledge_base_ids": [],
      "conversational_path_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "integrations": [],
      "call_tools": []
    }
  ],
  "has_more": true,
  "first_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "last_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

GET

agent

List Agents

import requests

url = "http://localhost:3000/v1/agent/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "data": [
    {
      "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "modified_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version_number": 123,
      "version_created_at": "2023-11-07T05:31:56Z",
      "voice": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "description": "<string>"
      },
      "language": "es",
      "mode": "free",
      "version_name": "<string>",
      "is_draft": false,
      "is_published": false,
      "name": "<string>",
      "description": "<string>",
      "prompt": "<string>",
      "greeting": "<string>",
      "time_before_start": 123,
      "boosted_keywords": [
        "<string>"
      ],
      "redirect_number": "<string>",
      "max_reminder_count": 3,
      "reminder_frequency_ms": 7500,
      "reminder_messages": [],
      "knowledge_base_ids": [],
      "conversational_path_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "integrations": [],
      "call_tools": []
    }
  ],
  "has_more": true,
  "first_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "last_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization

string

header

required

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

Query Parameters

after

string<uuid> | null

before

string<uuid> | null

limit

integer

default:10

Rango requerido: 1 <= x <= 100

order

enum<string>

default:desc

Opciones disponibles:

asc,

desc

mode

enum<string> | null

Enum for Agent Modes.

Opciones disponibles:

free,

path

is_published

boolean

default:false

Response

Successful Response

data

AgentResponseSchema · object[]

required

Mostrar atributos secundarios

data.agent_id

string<uuid>

required

The unique identifier for the agent

data.modified_at

string<date-time>

required

The date and time when the agent was last updated

data.created_at

string<date-time>

required

The date and time when the agent was created

data.version_id

string<uuid>

required

The version id of the agent

data.version_number

integer

required

The version number of the agent

data.version_created_at

string<date-time>

required

The date and time when the version was created

data.voice

Voice · object

required

The voice object used by the agent

Mostrar atributos secundarios

data.voice.id

string<uuid>

required

The unique identifier for the voice

data.voice.name

string

required

The name of the voice

data.voice.description

string | null

The description given to the voice

data.language

enum<string>

required

The language used by the agent. Use multi for the agent using both english and spanish in the same call (multi will expand to more languages in the future)

Opciones disponibles:

es,

en,

multi,

fr,

ca,

de,

bg,

zh,

zh-TW,

zh-HK,

cs,

da,

nl,

et,

fi,

nl-BE,

de-CH,

el,

hi,

hu,

id,

it,

ja,

ko,

lv,

lt,

ms,

no,

pl,

pt,

ro,

ru,

sk,

sv,

th,

tr,

uk,

vi

data.mode

enum<string>

required

The mode of the agent. Can be 'free' or 'path'

Opciones disponibles:

free,

path

data.version_name

string | null

The version name of the agent

data.is_draft

boolean

default:false

Indicates if the agent is a draft version

data.is_published

boolean

default:false

Indicates if the agent is published

data.name

string | null

The name of the agent

data.description

string | null

The description given to the agent

data.prompt

string | null

The prompt given to the agent

data.greeting

string | null

The greeting message said by the agent to the caller at the beginning of the call. If set, the agent will always speak first both in inbound and outbound calls

data.time_before_start

number | null

The time in seconds before the agent starts to speak

data.boosted_keywords

string[] | null

he list of keywords that are boosted for the agent speech recognition. Use this to improve the agent's recognition of domain-specific terms. For example, ['bradycardia']

data.redirect_number

string | null

The phone number to use by the agent if the call needs to be redirected. If not provided, you won't be able to redirect the call even if the tool is present

data.max_reminder_count

integer

default:3

The maximum number of reminders that can be sent to the caller. If not provided, the default value is 3. Set this value to 0 to disable reminders

Rango requerido: x >= 0

data.reminder_frequency_ms

integer

default:7500

The frequency in milliseconds to send reminders to the caller. If not provided, the default value is 7500.

data.reminder_messages

string[]

The list of messages to send to the caller as reminders. If not provided, the default value is an empty list which makes the model to generate the reminder messages by itself. Please, note that when using an empty list, the reminder_frequency_ms can be a little bit higher than specified since it has to generate the messages

data.knowledge_base_ids

string<uuid>[] | null

The list of knowledge bases available for the agent to use

data.conversational_path_id

string<uuid> | null

The id of the conversational path used by the agent.

data.integrations

IntegrationToolsResponse · object[]

The list of integrations and their assigned tools for the agent

Mostrar atributos secundarios

data.integrations.integration_id

string<uuid>

required

The unique identifier for the integration

data.integrations.integration_name

string

required

The name of the integration

data.integrations.tool_ids

string<uuid>[]

required

The list of tool IDs assigned from this integration

data.call_tools

CallToolResponse · object[]

The list of call-tools (built-in tools) assigned to the agent

Mostrar atributos secundarios

data.call_tools.call_tool_id

string<uuid>

required

The unique identifier for the call-tool

data.call_tools.call_tool_name

string

required

The name of the call-tool

data.call_tools.settings

Settings · object

Configuration settings for this call-tool

has_more

boolean

required

first_id

string<uuid> | null

last_id

string<uuid> | null

List Knowledge Tags

Create Agent

⌘I

Call

Transcription

Recordings

Knowledge Base

Knowledge Item

Knowledge Tag

Agent

Voice

Call Tool

Phone

Integration

Webhook

Invitation

Path

API Key

Billing Customer

Billing Payment Method

Usage Alert

List Agents

Authorizations

Query Parameters

Response