Catalog
Product and service catalog
GET/api/ai-agents/{id}/catalog-items
List the agent's catalog items
Required scope: catalog.read
| Parameter | In | Required |
|---|---|---|
id | path | yes |
bash
curl "https://api.zapyflow.com.br/api/ai-agents/{id}/catalog-items" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Responses
200— OK404— Not found — also returned when the resource belongs to another workspace
POST/api/ai-agents/{id}/catalog-items
Create a catalog item
Required scope: catalog.write
| Parameter | In | Required |
|---|---|---|
id | path | yes |
Request body
| Field | Type | Required | Constraints |
|---|---|---|---|
name | string | yes | min 1, max 150 |
description | string | no | max 1000 |
price | number | yes | ≥ 0 |
imageUrl | object | string | null | no | — |
category | object | string | null | no | — |
active | boolean | no | — |
order | integer | no | — |
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 '{ ... }'Responses
201— Created404— Not found — also returned when the resource belongs to another workspace
PATCH/api/ai-agents/{id}/catalog-items/{itemId}
Edit a catalog item
Required scope: catalog.write
| Parameter | In | Required |
|---|---|---|
id | path | yes |
itemId | path | yes |
Request body
| Field | Type | Required | Constraints |
|---|---|---|---|
name | string | no | min 1, max 150 |
description | string | no | max 1000 |
price | number | no | ≥ 0 |
imageUrl | object | string | null | no | — |
category | object | string | null | no | — |
active | boolean | no | — |
order | integer | no | — |
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 '{ ... }'Responses
200— OK404— Not found — also returned when the resource belongs to another workspace
DELETE/api/ai-agents/{id}/catalog-items/{itemId}
Remove a catalog item without touching the provider's external resource
Required scope: catalog.write
| Parameter | In | Required |
|---|---|---|
id | path | yes |
itemId | path | yes |
bash
curl -X DELETE "https://api.zapyflow.com.br/api/ai-agents/{id}/catalog-items/{itemId}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Responses
204— CatalogItem removido com sucesso404— Not found — also returned when the resource belongs to another workspace