Skip to main content
PATCH
/
v1
/
agents
/
{agentId}
Actualizar atributos configurables del agente
curl --request PATCH \
  --url https://api-prod.studio.getsupervisor.ai/v1/agents/{agentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "name": "Soporte Voz Latam",
  "status": "active",
  "metadata": {
    "statusReason": "SLA firmado"
  }
}
'
{
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "agentType": "chat",
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "inactive",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "totalCalls": 1,
  "totalOperationalDays": 1,
  "goalAchievedPercentage": 50,
  "versionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "avatarUrl": "<string>",
  "debounceDelayMs": 1,
  "toneId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "messageStyleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ownerUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "knowledgeBaseIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "tags": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "tools": [
    {
      "identifier": "<string>",
      "displayName": "<string>",
      "enabled": true
    }
  ],
  "voiceConfig": {
    "voiceId": "<string>",
    "webhookUrl": "<string>",
    "llmId": "<string>"
  },
  "metadata": {}
}

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.

Path Parameters

​
agentId
string<uuid>
required

Identificador del agente

Body

application/json
​
name
string
​
status
enum<string>
Available options:
inactive,
training,
active,
archived
​
description
string | null
​
toneId
string<uuid> | null
​
messageStyleId
string<uuid> | null
​
tags
string<uuid>[]
​
debounceDelayMs
integer | null
Required range: x >= 0
​
ownerUserId
string<uuid> | null
​
metadata
object

Response

Agente actualizado

​
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