Skip to main content
POST
/
v1
/
catalogs
/
items
Crear ítem de catálogo
curl --request POST \
  --url https://agents.studio.getsupervisor.ai/v1/catalogs/items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "type": "voice",
  "scope": "workspace",
  "workspaceId": "a44bb95e-9f01-4d19-8b62-1f6f2b8e8363",
  "name": "Valentina MX",
  "description": "Voz femenina cálida para campañas LATAM",
  "metadata": {
    "language": "es-MX",
    "gender": "female",
    "tone": "warm"
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "language",
  "systemIdentifier": "<string>",
  "scope": "global",
  "name": "<string>",
  "description": "<string>",
  "isActive": true,
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "links": {
    "self": "<string>",
    "catalog": "<string>"
  },
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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

Payload para registrar un nuevo ítem en el catálogo.

​
type
enum<string>
required
Available options:
language,
message_style,
tone_style,
tag,
voice
​
scope
enum<string>
required

Determina si el ítem es global o específico del workspace que realiza la llamada.

Available options:
global,
workspace
​
name
string
required
Required string length: 1 - 120
​
description
string
required
Required string length: 1 - 500
​
metadata
object
required

Metadata específica dependiente del tipo de catálogo.

​
workspaceId
string<uuid>

Workspace objetivo cuando scope es workspace. Se omite para ítems globales.

​
systemIdentifier
string

Identificador técnico único dentro del catálogo. Si se omite se genera desde el nombre.

Required string length: 1 - 120
​
isActive
boolean
default:true

Response

Ítem creado correctamente.

Representación de un ítem de catálogo disponible para los agentes.

​
id
string<uuid>
required
​
type
enum<string>
required

Tipo lógico de catálogo al que pertenece el ítem.

Available options:
language,
message_style,
tone_style,
tag,
voice
​
systemIdentifier
string
required

Identificador técnico único dentro del catálogo (snake-case o kebab-case).

​
scope
enum<string>
required

Determina si el ítem aplica globalmente o a un workspace específico.

Available options:
global,
workspace
​
name
string
required
​
description
string
required
​
isActive
boolean
required
​
metadata
object
required

Metadata específica dependiente del tipo de catálogo.

​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
links
object
required

Enlaces HATEOAS mínimos para la navegación entre catálogos.

​
workspaceId
string<uuid> | null

Workspace propietario cuando scope es workspace.