Complete reference for all Pulse API endpoints
/extract
Synchronously extract content from documents. Best for files under 50 pages./extract_async
Asynchronously process large documents. Returns job ID for polling./convert
Upload files to S3 and get a URL for processing./job/{job_id}
Check status and retrieve results of async jobs./cancel/{job_id}
Cancel a pending or processing async job./webhook
Get portal link to configure webhook endpoints./extract
and /extract_async
endpoints accept application/json
content type:
multipart/form-data
:
/convert
endpoint accepts files via multipart/form-data
:
string
- Text valuesinteger
- Whole numbersfloat
- Decimal numbersdate
- Date valuesboolean
- True/falsearray
- Listsobject
- Nested structures"5"
"1-10"
"1,3,5-7,10"
return_html
: Return HTML instead of markdown (default: false)extract_figure
: Extract images and figures (default: false)figure_description
: Generate AI descriptions for figureschunk_size
: Custom chunk size in charactersCode | Description |
---|---|
200 | Success |
400 | Bad Request - Invalid parameters |
401 | Unauthorized - Invalid API key |
403 | Forbidden - Access denied |
404 | Not Found - Resource doesn’t exist |
413 | Payload Too Large - File exceeds limit |
429 | Too Many Requests - Rate limited |
500 | Internal Server Error |
503 | Service Unavailable |
Use Appropriate Endpoints
/extract
for documents under 50 pages/extract_async
for large documents/convert
when you need to reuse file URLsHandle Errors Gracefully
Optimize Performance
Security