Error Reference

The API uses standard HTTP status codes and returns structured error responses to help you diagnose issues.

Error Response Format

All error responses follow this structure:

code — Machine-readable error code. Use this for programmatic error handling.

message — Human-readable description. Safe to display to end users.

request_id — Unique request identifier. Include this when contacting support.

Error Codes

StatusCodeMeaning
200Success
401AUTHENTICATION_REQUIREDInvalid or missing API key
403INSUFFICIENT_PERMISSIONSNo access to requested collection
404NOT_FOUNDCollection not found
422VALIDATION_ERRORInvalid request body
429RATE_LIMITEDRate limit exceeded
500INTERNAL_ERRORInternal server error

Troubleshooting

401AUTHENTICATION_REQUIRED

Check that the Authorization header is present and the key is valid. Keys start with sk_live_.

403INSUFFICIENT_PERMISSIONS

The API key doesn't have access to this collection. Use an org-wide key or add the collection to the key's scope.

404NOT_FOUND

Verify the collection name exists. Names are case-sensitive.

422VALIDATION_ERROR

Check required fields (collection, query). Ensure query is under 1000 characters and limit is between 1-30.

429RATE_LIMITED

Wait for the Retry-After period and implement exponential backoff. See Rate Limits for details.

500INTERNAL_ERROR

An unexpected error occurred. Retry the request. If it persists, contact support with the request_id.

Usage is tracked per API key. View statistics on your Usage page in the dashboard.