API Basics
Errors
The One Codex API communicates errors with standard HTTP status codes with details supplied in JSON objects. The following general pattern applies:
2XX: We received, processed, and accepted a request.
3XX: More action is required in order to complete the request. We use redirects sparingly.
4XX: Client error. Common errors relate to invalid parameters or our inability to find and serve the requested resource.
5XX: Server error. An error occurred on our system(s) while handling the request.
HTTP Status Codes
Error Response
Field | Description |
---|---|
Message string | An error message detailing why the request was unsuccessful. |
Status integer | HTTP status code |
EXAMPLE ERROR