Sections

Response & error code

Absurdia uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Absurdia's servers.

Most errors will include an error code that briefly explain the error reported.

Successful response attributes

  • data

    object

    The response data will be nested JSON in that field.

Failed response attributes

  • error

    string

    A short human-understandable description of the error.

  • code

    string

    An error code that can be processed programmaticaly.

  • detail

    string A human-understandable explanation of what went wrong. Some endpoints might not provide a useful explanation yet.

HTTP STATUS CODES
200 - OK Everything worked as expected.
201 - Created Everything worked as expected and a new resource has been created.
400 - Bad Request The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized No valid API key provided.
403 - Forbidden The API key doesn't have permissions to perform the request or the signature is invalid.
404 - Not Found The requested resource doesn't exist.
409 - Conflict The request conflicts with another request (perhaps due to using the same idempotent key).
429 - Too Many Requests Too many requests hit the API too quickly (see also rate limits).
500, 502, 503, 504 - Server Errors Something went wrong on Absurdia's end.
SOME ERROR CODES
invalid_grant Invalid credentials or unauthorised.
signature_required No signature included in the request but one is expected.
invalid_signature The signature is invalid.
missing_field A required field is missing in the body.
invalid_request At least one field is invalid. For example, a string is too long.
system_error Something went wrong on Absurdia's end.