Overview
Add Pulse to any ModuleX agent or workflow. Extract text and structured content from PDFs, images, and Office files using Pulse OCR, against the Pulse REST API (api.runpulse.com).
Categories: AI & Machine Learning · Document Processing · Ocr · Auth: API Key · Actions: 1
Authentication
API Key Authentication
Authenticate using your Pulse API key1
Step 1
Go to https://www.runpulse.com and sign up or log in
2
Step 2
Open your dashboard and navigate to the API keys section
3
Step 3
Create a new API key or copy your existing one
4
Step 4
Paste the API key below
Required Credentials
Available Actions
parser — Parse a document (PDF, image, or Office file) from a public URL using Pulse OCR and return clean markdown, page count, layout bounding boxes, optional HTML, chunks, and figures.
parser — Parse a document (PDF, image, or Office file) from a public URL using Pulse OCR and return clean markdown, page count, layout bounding boxes, optional HTML, chunks, and figures.
Parameters
string
required
Public HTTP(S) URL to a document to process (PDF, image, or Office file)
string
Page range to process, 1-indexed (e.g. “1-2,5”). Omit for all pages.
string
Chunking strategies (comma-separated: semantic, header, page, recursive)
integer
Maximum characters per chunk when chunking is enabled
boolean
Whether to include HTML in the response
boolean
Whether to extract figures from the document
boolean
Whether to generate descriptions/captions for extracted figures
Response
Limits & Quotas
- Billing: Pulse bills in credits; each extraction is billed by the number of pages (or tables) processed. API keys can carry per-key credit caps.
- Large documents: documents above ~70 pages return an
extraction_urlpointing at the full results instead of inlining the markdown. - Error model: non-2xx responses and timeouts are caught and
returned as
success=False+errorrather than raising. Plan for retries on the agent side based on the error string.