Success Response
Response Fields
| Field | Type | Description |
|---|---|---|
success | boolean | Whether the request succeeded |
error | object/null | Error details if failed |
data | object/null | Response data if successful |
Data Object
| Field | Type | Description |
|---|---|---|
uuid | string | Unique capture identifier |
fileUrl | string | CDN URL to the capture |
fromCache | boolean | Whether served from cache |
tokenCost | number | Credits consumed |
fileSizeBytes | number | File size in bytes |
processingTimeMs | number | Processing time in ms |
metadata | object | Capture metadata |
Metadata Object
| Field | Type | Description |
|---|---|---|
mimeType | string | File MIME type |
width | number | Image width in pixels |
height | number | Image height in pixels |
createdAt | number | Unix timestamp (seconds) |
Binary Response
When usingresponseType: "file", the response is the raw file:
Content-Type:image/png,image/jpeg,image/webp, orapplication/pdfContent-Length: File size in bytesX-Capture-UUID: Capture identifier
Error Response
See Error Handling for complete error codes.
HTTP Status Codes
| Status | Meaning |
|---|---|
| 200 | Success |
| 400 | Bad Request (validation error) |
| 401 | Unauthorized (invalid API key) |
| 402 | Payment Required (quota exceeded) |
| 429 | Too Many Requests (rate limited) |
| 500 | Internal Server Error |