Skip to main content
Bota uses standard 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 Bota’s servers (these are rare).

Error Object

When an error occurs, Bota returns a JSON object with a consistent structure to help you debug.
{
  "error": {
    "code": "invalid_request",
    "message": "The request body is invalid",
    "details": {
      "field": "email",
      "reason": "Invalid email format"
    }
  }
}

Attributes

AttributeTypeDescription
codestringA machine-readable error code.
messagestringA human-readable message providing more details about the error.
detailsobject(Optional) Additional context or specific field errors.

HTTP Status Codes

CodeStatusDescription
200OKThe request was successful.
201CreatedThe resource was created successfully.
400Bad RequestThe request was unacceptable, often due to missing a required parameter.
401UnauthorizedNo valid API key provided.
403ForbiddenThe API key doesn’t have permissions to perform the request.
404Not FoundThe requested resource doesn’t exist.
409ConflictThe request conflicts with another (e.g., device already bound).
429Too Many RequestsToo many requests hit the API too quickly.
500Server ErrorSomething went wrong on Bota’s end.

Error Codes

CodeDescription
invalid_requestThe request body or parameters are invalid.
unauthorizedThe API key is missing or invalid.
not_foundThe resource (EndUser, Device, etc.) was not found.
resource_already_existsYou tried to create a resource that already exists.
rate_limit_exceededYou have reached your account’s rate limit.
device_already_boundThe device is already assigned to another user.
processing_errorAn error occurred during transcription or summarization.