Skip to main content
GET
/
v1
/
catalogs
/
items
/
{itemId}
Obtener detalle de un ítem de catálogo
curl --request GET \
  --url https://agents.studio.getsupervisor.ai/v1/catalogs/items/{itemId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-workspace-id: <x-workspace-id>'
{
  "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.

Path Parameters

​
itemId
string<uuid>
required

Identificador del ítem de catálogo

Query Parameters

​
fields
string

Lista separada por comas de campos a retornar (sparse fieldset).

Example:

"id,externalId,status"

​
include
string

Lista separada por comas de relaciones a cargar.

Example:

"messages,sender"

Response

Ítem de catálogo encontrado.

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.