Saltar al contenido principal
GET
/
v1
/
agent
/
{agent_id}
Get agent by ID
import requests

url = "https://api.diga.io/v1/agent/{agent_id}"

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

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

print(response.text)
{
  "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>",
    "preview_url": "<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,
  "voice_speed": 1,
  "boosted_keywords": [
    "<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": [],
  "dynamic_variables": {},
  "background_audio": "call_center",
  "pronunciation_dict": {}
}

Autorizaciones

​
Authorization
string
header
requerido

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

Parámetros de ruta

​
agent_id
string<uuid>
requerido

Parámetros de consulta

​
version_id
string<uuid> | null

Optional version ID to retrieve a specific version of the agent.

​
is_published
boolean
predeterminado:false

If true, retrieves the published version of the agent.

Respuesta

Successful Response

​
agent_id
string<uuid>
requerido

The unique identifier for the agent

​
modified_at
string<date-time>
requerido

The date and time when the agent was last updated

​
created_at
string<date-time>
requerido

The date and time when the agent was created

​
version_id
string<uuid>
requerido

The version id of the agent

​
version_number
integer
requerido

The version number of the agent

​
version_created_at
string<date-time>
requerido

The date and time when the version was created

​
voice
Voice · object
requerido

The voice object used by the agent

​
language
enum<string>
requerido

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
​
mode
enum<string>
requerido

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

Opciones disponibles:
free,
path
​
version_name
string | null

The version name of the agent

​
is_draft
boolean
predeterminado:false

Indicates if the agent is a draft version

​
is_published
boolean
predeterminado:false

Indicates if the agent is published

​
name
string | null

The name of the agent

​
description
string | null

The description given to the agent

​
prompt
string | null

The prompt given to the agent

​
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

​
time_before_start
number | null

The time in seconds before the agent starts to speak

​
voice_speed
number
predeterminado:1

The speed of the voice used by the agent, beeing 1.0 the normal speed. Values lower than 1.0 will make the voice slower, while values higher than 1.0 will make the voice faster

Rango requerido: 0.8 <= x <= 1.2
​
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']

​
max_reminder_count
integer
predeterminado: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
​
reminder_frequency_ms
integer
predeterminado:7500

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

​
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

​
knowledge_base_ids
string<uuid>[] | null

The list of knowledge bases available for the agent to use

​
conversational_path_id
string<uuid> | null

The id of the conversational path used by the agent.

​
integrations
IntegrationToolsResponse · object[]

The list of integrations and their assigned tools for the agent

​
call_tools
(TransferCallToolSchema · object | HangUpToolSchema · object | DetectAnsweringMachineToolSchema · object)[]

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

Settings schema for the transfer call-tool.

​
dynamic_variables
Dynamic Variables · object

Agent-level dynamic variables for template interpolation. Overridden by call-level variables.

​
background_audio
enum<string> | null

The background audio to be used in the calls that this agent handles

Opciones disponibles:
call_center,
cafe,
road_traffic,
park,
office,
car_garage
​
pronunciation_dict
Pronunciation Dictionary · object

Custom pronunciation mappings using phonetic text substitution