1. Home
  2. Docs
  3. API
  4. Introduction
  5. Response Structure

Response Structure

Each request produces an HTTPS response in JSON representations with the standard headers, response content, and status code.
The server returns status code 200 OK for successful requests, otherwise it returns the following status codes:

  • 400 Bad Request: Invalid query parameters, including unrecognised parameters, missing parameters, invalid values or server-side error.
  • 403 Forbidden: Invalid authentication
  • 404 Not Found: The provided URL does not match an existing resource. For example, an HTTP Method for the resource is unavailable.

In the case of an error, in addition to the status code, the response includes an error object containing more details about the error. The JSON response schema is as follows:

agents: <status code>,
channelsBasic: <error message>