Platform API

Error Codes

HTTP Status Codes

When you call the Platform API, it responds with standard HTTP status codes. They are categorized as follows:

HTTP Status Code Description
2xx Successful responses
4xx Client errors
5xx Server errors

Error Codes

When an API request results in an error, a standardized response format is provided, structured as below:

  "code": error_code,
  "message": "error_message",
  "details": [
      "@type": "string",

The properties in the response are described as follows:

Property Type Description
code integer This is a standardized error code, which software can use to determine how to handle the error.
message string This human-readable explanation of the error provides context on what went wrong.
details array[object] This is an array of additional information objects, which provides more context about the error.

details object

Property Type Description
@type string Identifies the type of the serialized protocol buffer message.
reason string Gives the error reason.
domain string Denotes the API domain where the error occurred
metadata string Contains additional details about the error, such as a more comprehensive error message.