Skip to main content
All API responses follow a consistent response structure and include a status code that indicates whether the request was successful or failed.

Response Structure

All API endpoints return responses in the following JSON format:

HTTP Status Codes

In this API, the HTTP status code is consistent with the code field in the response body. For example:
  • When a request succeeds, the server returns HTTP 200, and the response body contains "code": 200.
  • When a request fails, the server returns the corresponding HTTP status code, and the same value appears in the code field.
Example:
This means:
  • HTTP status code indicates the request result at the protocol level.
  • code field provides the same status information in the response body for easier client-side handling.
  • Clients can determine whether a request succeeded by checking either the HTTP status code or the code field.

Common Error Codes

Error Response Examples

Below are common error scenarios you may encounter, along with their response bodies: Invalid or missing API key:
Asset not found:
Insufficient account balance:
Unsupported file format:
Rate limit exceeded:
Internal server error:

Troubleshooting FAQ

Notes

  • The msg field provides a human-readable description of the request result.
  • The data field contains the response payload when the request succeeds.
  • When an error occurs, data will usually be null.
  • Clients should handle errors based on the returned status code.