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

success
created
accepted
no_content
redirect
not_modified
bad_request
unauthorized
forbidden
not_found
method_not_allowed
conflict
precondition_failed
too_many_requests
internal_server_error
unavailable

Error Response

Field	Description
Message string	An error message detailing why the request was unsuccessful.
Status integer	HTTP status code

EXAMPLE ERROR

{
    "message": "The server could not verify that you are authorized to access the URL requested.  You either supplied the wrong credentials...",
    "status": 401
}

API Basics

Samples

Projects

Metadata & Tags

Analyses

Jobs

Documents

Webhooks & Events

Users & Account

Sequencing

HTTP Status Codes

Error Response

​HTTP Status Codes

​Error Response

HTTP Status Codes

Error Response