Skip to main content

​
Base URL

All API requests should be made to: 
https://api.runpulse.com

​
Authentication

All endpoints require authentication via API key in the request header: 
x-api-key: YOUR_API_KEY
Get your API key from the Pulse Console.

​
Available Endpoints

​
Core Endpoints

Extract

POST /extractThe primary endpoint. Synchronously extract content from documents.

Extract Async

POST /extract_asyncAsynchronously process documents. Returns job ID for polling.

Poll Job

GET /job/{jobId}Check status and retrieve results of async jobs.

Cancel Job

DELETE /job/{jobId}Cancel a pending or processing async job.

Webhooks

POST /webhookGet portal link to configure webhook endpoints.

​
Deprecated Endpoints

The following endpoints are deprecated and will be removed in a future version.
EndpointStatusReplacement
POST /convertDeprecatedUse file_url parameter in /extract instead
POST /cancel/{job_id}DeprecatedUse DELETE /job/{jobId} instead

​
Status Codes

CodeDescription
200Success
400Bad Request - Invalid parameters
401Unauthorized - Invalid API key
403Forbidden - Access denied
404Not Found - Resource doesn’t exist
413Payload Too Large - File exceeds limit
429Too Many Requests - Rate limited
500Internal Server Error
503Service Unavailable

​
Best Practices

  • Use /extract for most documents - it’s the primary endpoint
  • Use /extract_async for large documents or batch processing
  • Use file_url parameter when you have documents hosted online
  • Implement retry logic with exponential backoff
  • Check error codes and handle specifically
  • Log errors for debugging
  • Process only necessary pages
  • Use schemas for structured extraction
  • Cache results when possible
  • Never expose API keys in client code
  • Use environment variables
  • Rotate keys regularly
  • Validate file types before upload

​
Next Steps

Explore specific endpoints:

Extract Endpoint

Main extraction endpoint

Quickstart Guide

Get started quickly