Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Status codes and error response shape for Public API v1
| Status | Meaning | Typical cause |
|---|---|---|
200 | Success | Valid key and query |
400 | Invalid query parameters | Zod validation failed (limit, status, dates, …) |
401 | Unauthorized | Missing header, wrong format, invalid/expired key |
403 | Forbidden | API key is valid, but the organization’s current plan no longer allows Public API access |
429 | Too many requests | API key/org/IP rate limit exceeded |
500 | Internal server error | Unexpected server failure |
apiAccessEnabled on every request. Existing keys stop working if an organization downgrades below the Public API tier.
{
"error": "Unauthorized",
"message": "API key required in Authorization header"
}
code:
{
"error": "Forbidden",
"code": "API_ACCESS_DISABLED",
"message": "Public API access is not available on the current organization plan. Upgrade to Professional or contact Cicini support."
}
{
"error": "Invalid query parameters",
"details": [
{
"code": "too_big",
"maximum": 100,
"type": "number",
"path": ["limit"],
"message": "Number must be less than or equal to 100"
}
]
}
Retry-After and X-RateLimit-* headers:
{
"error": "Too Many Requests",
"code": "RATE_LIMITED",
"message": "Rate limit exceeded. Please try again later.",
"retryAfter": 42
}
publicErrorSchema (error, optional code, optional message, optional details).
| Situation | Action |
|---|---|
401 | Fix key configuration; do not retry blindly |
403 | Upgrade/restore the organization plan before retrying |
429 | Wait at least Retry-After seconds before retrying |
400 | Fix query params; do not retry the same payload |
500 | Retry with exponential backoff; log requestId if you have edge logs |
| Network errors | Retry with backoff; make sync jobs idempotent |
data array exists.