Error Response Schema

Response body that will be sent by the API for failed requests

Example

{
  "code": 401,
  "type": "invalid_key",
  "description": "The provided API key is not valid. Generate a new one in the portal",
  "docs": "https://cirrosense.com/docs/api-key"
}

Attributes

• code

  integer

  Code representing the type of error

  Example:401

• type

  string

  Short descriptive error string

  Allowed values:

  • server_exception
  • invalid_key
  • invalid_params
  • location_not_found

  Example:invalid_key

• description

  string

  Human-readable description of the error with guidance

  Example:The provided API key is not valid. Generate a new one in the portal

• docs

  string

  URL to relevant documentation

  Example:https://cirrosense.com/docs/api-key