Standard Format
Every successful response (HTTP status2xx) uses this structure:
Response Fields
Common Response Types
Screenshot Response
The
image field is present only when base64 is true in the request.Markdown Response
JSON Extraction Response
Handling Responses
Basic Response Handling
TypeScript Types
Response Metadata
Most endpoints include metadata with additional information about the operation:- url: The source URL that was processed
- timestamp: When the operation was completed
- format/type: The type of content or format used
- size/wordCount: Size metrics for the content
File Storage
Screenshot and PDF endpoints may include file storage information:- permanentUrl: Permanent URL for accessing the file
- fileId: Unique identifier for file management
Files are automatically stored in R2 cloud storage when available and can be accessed via the
permanentUrl or
managed through the Files API.