Skip to main content
POST
Crear ítem de catálogo

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>

Identificador del workspace multi-tenant. Obligatorio al autenticar con Authorization: Bearer, donde su ausencia devuelve 400 Workspace context is required. Con x-api-key es opcional: la llave ya identifica a su workspace y lo que mandes aquí se ignora.

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,
webhook_event
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>
required if scope = workspace

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
Pattern: ^[a-z0-9]+(?:[-_][a-z0-9]+)*$
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,
webhook_event
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

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

workspaceId
string<uuid> | null

Workspace propietario cuando scope es workspace.