Operations

Public catalog of every operation (no API key)

get/v1/public/operations/catalog

Every operation an API key can reach, with its JSON Schema input, the scope it needs, whether it reads or writes and whether it waits for approval. Not filtered by key scopes or organization modules; use GET /v1/public/operations for what a given key can run.

curl -X GET "https://api.cognizy.ai/api/v1/public/operations/catalog" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

List the operations this API key can run

get/v1/public/operations

Each operation comes with its JSON Schema input, whether it reads or writes, and the scope it needs. Only operations allowed by the key scopes and by the modules enabled in the organization are listed.

curl -X GET "https://api.cognizy.ai/api/v1/public/operations" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

Run an operation

post/v1/public/operations/{name}

Aceita Idempotency-Key

Body = the operation input (see its inputSchema). Invalid input answers 400 with errors per field; a missing scope answers 403. Writes accept an Idempotency-Key header. Writes that need approval (e.g. booking) answer 202 with the pending action instead of running; poll GET /v1/public/pending-actions/:id.

curl -X POST "https://api.cognizy.ai/api/v1/public/operations/<name>" \
  -H "Authorization: Bearer $COGNIZY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"