ZapyFlow/Documentación de la APIopenapi.json

Catalog

Catálogo de productos y servicios

GET/api/ai-agents/{id}/catalog-items

Lista los ítems de catálogo del agente

Ámbito requerido: catalog.read

ParámetroDóndeObligatorio
idpathsí
bash
curl "https://api.zapyflow.com.br/api/ai-agents/{id}/catalog-items" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK
  • 404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

POST/api/ai-agents/{id}/catalog-items

Crea un ítem de catálogo

Ámbito requerido: catalog.write

ParámetroDóndeObligatorio
idpathsí

Cuerpo de la petición

CampoTipoObligatorioRestricciones
namestringsímin 1, max 150
descriptionstringnomax 1000
pricenumbersí≥ 0
imageUrlobject | string | nullno—
categoryobject | string | nullno—
activebooleanno—
orderintegerno—
bash
curl -X POST "https://api.zapyflow.com.br/api/ai-agents/{id}/catalog-items" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'
Respuestas
  • 201 — Creado
  • 404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

PATCH/api/ai-agents/{id}/catalog-items/{itemId}

Edita un ítem de catálogo

Ámbito requerido: catalog.write

ParámetroDóndeObligatorio
idpathsí
itemIdpathsí

Cuerpo de la petición

CampoTipoObligatorioRestricciones
namestringnomin 1, max 150
descriptionstringnomax 1000
pricenumberno≥ 0
imageUrlobject | string | nullno—
categoryobject | string | nullno—
activebooleanno—
orderintegerno—
bash
curl -X PATCH "https://api.zapyflow.com.br/api/ai-agents/{id}/catalog-items/{itemId}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'
Respuestas
  • 200 — OK
  • 404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

DELETE/api/ai-agents/{id}/catalog-items/{itemId}

Elimina un ítem de catálogo sin tocar el recurso externo del proveedor

Ámbito requerido: catalog.write

ParámetroDóndeObligatorio
idpathsí
itemIdpathsí
bash
curl -X DELETE "https://api.zapyflow.com.br/api/ai-agents/{id}/catalog-items/{itemId}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 204 — CatalogItem removido com sucesso
  • 404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace