Skip to main content
POST
/
extract
Extract Document
curl --request POST \
  --url https://dev.api.runpulse.com/extract \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "file-url": "<string>",
  "schema": {
    "invoice_number": "string",
    "total": "float"
  },
  "pages": "1-10",
  "chunk_size": 5000,
  "extract_figure": false,
  "figure_description": false,
  "return_html": false,
  "schema_prompt": "<string>"
}
'
{
  "content": "<string>",
  "metadata": {
    "page_count": 123,
    "processing_time": 123,
    "source_file": "<string>"
  },
  "schema_data": {}
}
Large Document Processing: For documents over 50 pages, we strongly recommend using the /extract_async endpoint instead. The async endpoint prevents timeout issues and provides better handling of extensive processing tasks.

​
Large Document Response Structure

For documents exceeding 70 pages, the API returns a URL structure instead of the direct response: 
{
  "is_url": true,
  "url": "https://pulse-studio-api.s3.region.amazonaws.com/results/...",
  "plan-info": {
    "pages_used": 0,
    "tier": "foundation"
  }
}

​
Key Points:

  • Documents over 70 pages return a URL containing the complete response
  • URLs automatically expire after 24 hours
  • No changes required to your API request structure
  • For documents under 70 pages, the API continues to return results directly

​
Implementation Tips:

  1. Check if response contains "is_url": true
  2. If true, fetch the complete document data from the provided URL
  3. Store URLs securely as they contain your processed results

Authorizations

​
x-api-key
string
header
required

API key for authentication

Body

application/json
​
file-url
string<uri>
required

URL of the file to process

​
schema
object

JSON schema for structured data extraction

Example:
{
  "invoice_number": "string",
  "total": "float"
}
​
pages
string

Page range to process (e.g., "1-5", "1,3,5")

Example:

"1-10"

​
chunk_size
integer

Custom chunk size in characters

Example:

5000

​
extract_figure
boolean
default:false

Extract figures and images

​
figure_description
boolean
default:false

Generate AI descriptions for figures

​
return_html
boolean
default:false

Return HTML instead of markdown

​
schema_prompt
string

Custom prompt for schema extraction

Response

Successful extraction

​
content
string

Extracted content in markdown or HTML format

​
metadata
object
​
schema_data
object

Extracted structured data if schema was provided