Skip to main content
All API responses follow a consistent JSON structure.

Success Response

Response Fields

Data Object

Metadata Object

Binary Response

When using responseType: "file", the response is the raw file:
Response headers include:
  • Content-Type: image/png, image/jpeg, image/webp, or application/pdf
  • Content-Length: File size in bytes
  • X-Capture-UUID: Capture identifier

Error Response

See Error Handling for complete error codes.

HTTP Status Codes