Skip to main content
POST
/
v1
/
agents
Crear un agente y su versión inicial
curl --request POST \
  --url https://api-prod.studio.getsupervisor.ai/v1/agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "name": "Soporte Voz Latam",
  "agentType": "voice",
  "description": "Flujo automatizado para atención postventa",
  "debounceDelayMs": 1200,
  "metadata": {
    "projectCode": "CX-OPS-001"
  }
}
'
{
  "agentId": "5769e110-7267-4cf7-a3ca-2d06e8fffbb3",
  "workspaceId": "a44bb95e-9f01-4d19-8b62-1f6f2b8e8363",
  "name": "Soporte Voz Latam",
  "agentType": "voice",
  "status": "inactive",
  "versionId": "b8f60a6d-4c3a-4b9f-8cf3-56ad71d2f2bf",
  "knowledgeBaseIds": [],
  "tools": [],
  "createdAt": "2025-10-08T12:34:56.000Z",
  "updatedAt": "2025-10-08T12:34:56.000Z",
  "metadata": {
    "projectCode": "CX-OPS-001"
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-workspace-id
string<uuid>
required

Identificador del workspace multi-tenant.

Body

application/json

Campos necesarios para registrar un nuevo agente. El usuario propietario se resuelve automáticamente a partir del token Bearer activo.

​
name
string
required
Minimum string length: 1
​
agentType
enum<string>
required
Available options:
chat,
voice
​
description
string | null
​
status
enum<string> | null
Available options:
inactive,
training,
active
​
avatarUrl
string<uri> | null
​
debounceDelayMs
integer | null

Delay opcional antes de enviar respuestas (milisegundos).

Required range: x >= 0
​
metadata
object

Campo libre para adjuntar atributos operativos adicionales (p.ej. códigos de proyecto).

Response

Agente creado

​
agentId
string<uuid>
required
​
name
string
required
​
agentType
enum<string>
required
Available options:
chat,
voice
​
workspaceId
string<uuid>
required
​
status
enum<string>
required
Available options:
inactive,
training,
active,
archived
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
totalCalls
integer
required

Total de llamadas realizadas por el agente.

Required range: x >= 0
​
totalOperationalDays
integer
required

Total de días operativos desde la creación del agente.

Required range: x >= 0
​
goalAchievedPercentage
number
required

Porcentaje de llamadas donde el objetivo fue alcanzado.

Required range: 0 <= x <= 100
​
versionId
string<uuid>
​
description
string | null
​
avatarUrl
string<uri> | null

URL pública opcional utilizada para representar al agente.

​
debounceDelayMs
integer | null

Delay opcional antes de enviar respuestas (milisegundos).

Required range: x >= 0
​
toneId
string<uuid> | null
​
messageStyleId
string<uuid> | null
​
ownerUserId
string<uuid> | null
​
knowledgeBaseIds
string<uuid>[]

Identificadores de knowledge bases asociadas.

​
tags
string<uuid>[]

Tags de negocio asignados al agente. Se administran mediante /v1/agents/{agentId}/tags.

​
tools
object[]

Tools habilitadas para el agente.

​
voiceConfig
object

Configuración de voz activa cuando el agente es de tipo voice.

​
metadata
object