# Pulse API

## Docs

- [Error Handling](https://docs.runpulse.com/advanced/error-handling.md): Handle API errors gracefully and build resilient applications
- [Async Processing](https://docs.runpulse.com/api-reference/async-processing.md): Process documents asynchronously with polling
- [Bounding Boxes](https://docs.runpulse.com/api-reference/bounding-boxes.md): Understanding layout information from document extraction
- [Batch Processing](https://docs.runpulse.com/api-reference/endpoint/batch-overview.md): Process multiple documents through the Pulse pipeline in parallel
- [Cancel Job (Deprecated)](https://docs.runpulse.com/api-reference/endpoint/cancel.md)
- [Retrieve URL (Deprecated)](https://docs.runpulse.com/api-reference/endpoint/convert.md)
- [Cancel Job](https://docs.runpulse.com/api-reference/endpoint/delete-job.md): Attempts to cancel an asynchronous job that is currently pending or processing. Jobs that have already completed will remain unchanged.
- [Extract File](https://docs.runpulse.com/api-reference/endpoint/extract.md): The primary endpoint for the Pulse API. Parses uploaded documents or remote file URLs and returns rich markdown content with optional structured data extraction based on user-provided schemas and extraction options.
- [Extract File Async (Deprecated)](https://docs.runpulse.com/api-reference/endpoint/extract_async.md): **Deprecated**: Use `/extract` with `async: true` instead.
- [Clear Form](https://docs.runpulse.com/api-reference/endpoint/form-clear.md): Remove user-entered data from a PDF form, leaving the blank form template intact. Erases handwritten entries, typed values, and unchecks selected checkboxes — printed labels, field titles, section headers, and other static template content are preserved.
- [Detect Form Fields](https://docs.runpulse.com/api-reference/endpoint/form-detect.md): Run cell detection on a PDF and return the detected `form_fields` along with a reusable `form_id`. No LLM matching, no fill, no clear — this is the OCR / layout step that `/form/fill` and `/form/clear` would otherwise run internally.
- [Fill Form](https://docs.runpulse.com/api-reference/endpoint/form-fill.md): Fill the fields of a PDF form with values inferred from a natural language `instructions` prompt. Works on both AcroForm PDFs (true form fields are written) and flat/scanned PDFs (values are rendered as an overlay using detected cells from OCR).
- [Download Large Result](https://docs.runpulse.com/api-reference/endpoint/large-results.md): Download the full result for an extraction when `/extract` or `GET /job/{jobId}` returns `is_url: true`. The URL is single-use for anonymous proxy access: after a successful download, subsequent anonymous requests return 410 Gone. Same-org authenticated callers may replay while the artifact is retai…
- [Pipeline Overview](https://docs.runpulse.com/api-reference/endpoint/pipeline-overview.md): Chain extract, schema, tables, and split steps into document processing pipelines.
- [Poll Job](https://docs.runpulse.com/api-reference/endpoint/poll.md): Check the status and retrieve results of an asynchronous job (submitted via any endpoint with `async: true`).
- [Get Result Image](https://docs.runpulse.com/api-reference/endpoint/results-image.md): Stream a PNG/JPEG visual image referenced by an extraction response under `bounding_boxes.Images[].image_url`.
- [Download Result PDF](https://docs.runpulse.com/api-reference/endpoint/results-pdf.md): Download the PDF binary produced by a `/form/detect`, `/form/fill`, or `/form/clear` job. The `pdf_url` field on a `FormResult` points at this endpoint — you can hand it directly to a browser, embed it in an `<iframe>`, or fetch the bytes from a backend.
- [Schema Extraction](https://docs.runpulse.com/api-reference/endpoint/schema.md): Apply schema extraction to a previously saved extraction. The mode is inferred from the input:
- [Split Document](https://docs.runpulse.com/api-reference/endpoint/split.md): Identify which pages of a document contain each topic/section. Takes an existing extraction and a list of topics, then uses AI to identify which PDF pages contain content related to each topic.
- [Split Schema (Deprecated)](https://docs.runpulse.com/api-reference/endpoint/split-schema.md): This endpoint has been merged into /schema
- [Tables](https://docs.runpulse.com/api-reference/endpoint/tables.md): Extract tables from a previously completed extraction. Processes the extraction's document content and returns structured table data.
- [Get Usage](https://docs.runpulse.com/api-reference/endpoint/usage.md): Programmatic counterpart to the platform usage dashboard. Returns the calling organization's current billing-period credit status plus document, page, and credit totals with a bucketed timeline over the requested window (default: the last 30 days; maximum window: 366 days).
- [Configure Webhooks](https://docs.runpulse.com/api-reference/endpoint/webhook.md): Generates a temporary link to the Svix webhook portal where users can manage their webhook endpoints and view message logs.
- [Overview](https://docs.runpulse.com/api-reference/introduction.md): Complete reference for all Pulse API endpoints
- [Working with Large Documents](https://docs.runpulse.com/api-reference/large-documents.md): Best practices for processing large documents efficiently
- [SDKs](https://docs.runpulse.com/api-reference/sdks.md): Install and use the official Pulse SDKs for Python and TypeScript.
- [Structured Output Guidelines](https://docs.runpulse.com/api-reference/structured-output-guidelines.md): Best practices for defining extraction schemas
- [Supported File Types](https://docs.runpulse.com/api-reference/supported-file-types.md): File formats supported by Pulse API for document extraction
- [Authentication](https://docs.runpulse.com/authentication.md): Learn how to authenticate with the Pulse API
- [Command reference](https://docs.runpulse.com/cli/commands.md): Every Pulse CLI command, flag, and workflow.
- [CLI](https://docs.runpulse.com/cli/overview.md): Extract, structure, split, and pull tables from documents without leaving your terminal.
- [Chaining Steps](https://docs.runpulse.com/concepts/chaining.md): Use extraction_id, split_id, schema_id, tables_id, and job_id to connect Pulse workflow steps.
- [Choose Your Workflow](https://docs.runpulse.com/concepts/choose-workflow.md): Pick the right Pulse workflow for your document and output.
- [Document Lifecycle](https://docs.runpulse.com/concepts/document-lifecycle.md): Understand how files, extractions, jobs, results, and saved configs fit together.
- [Processing Parameters](https://docs.runpulse.com/concepts/processing-parameters.md): Choose optional Extract settings for footnotes, spreadsheets, word-level boxes, and chunks across the Platform and API.
- [Chunking](https://docs.runpulse.com/concepts/processing-parameters-chunking.md): Prepare extracted content for RAG, search, agents, embeddings, and review queues.
- [Footnote References](https://docs.runpulse.com/concepts/processing-parameters-footnotes.md): Link footnote markers to the footnote text they qualify.
- [Spreadsheet Processing](https://docs.runpulse.com/concepts/processing-parameters-spreadsheets.md): Configure Extract for Excel workbooks, hidden content, raw values, and inflated used ranges.
- [Word-Level Bounding Boxes](https://docs.runpulse.com/concepts/processing-parameters-word-level-bounding-boxes.md): Return exact word coordinates for source-grounded review, QA, and overlays.
- [Schema, Tables, Or Split](https://docs.runpulse.com/concepts/schema-tables-split.md): Know when to use each downstream step after extraction.
- [Annual Report Split -> Schema](https://docs.runpulse.com/cookbooks/annual-report-split-schema.md): Split a long annual report into topics and apply different schemas per topic.
- [Batch Document Intake](https://docs.runpulse.com/cookbooks/batch-document-intake.md): Process many files through Extract, Schema, Tables, or Split with polling and retry-safe writes.
- [S3 Storage Pipeline](https://docs.runpulse.com/cookbooks/byos-s3-ingestion.md): Process documents from S3 and keep extraction artifacts in your storage boundary.
- [Chunking For RAG](https://docs.runpulse.com/cookbooks/chunking-strategy-rag.md): Choose semantic, header, page, and recursive chunks for retrieval workflows.
- [Financial Tables](https://docs.runpulse.com/cookbooks/financial-tables-excel.md): Extract table-first financial data for review and downstream workflows.
- [Footnote Citation Review](https://docs.runpulse.com/cookbooks/footnotes-citation-review.md): Link footnote markers to body references for research, legal, and financial review.
- [Bank Statement To JSON](https://docs.runpulse.com/cookbooks/invoice-to-json.md): Extract account metadata and transactions with Extract -> Schema.
- [Agent Diligence Review](https://docs.runpulse.com/cookbooks/mcp-agent-diligence.md): Give an AI agent Pulse MCP tools for document review, section routing, and evidence-backed answers.
- [Cookbooks](https://docs.runpulse.com/cookbooks/overview.md): End-to-end Pulse recipes for common document automation workflows.
- [LangChain RAG Ingestion](https://docs.runpulse.com/cookbooks/rag-langchain-vector-store.md): Extract, chunk, embed, and index a document for retrieval with LangChain.
- [Sample Documents](https://docs.runpulse.com/cookbooks/sample-documents.md): Hosted Pulse Platform examples with real documents, sample outputs, and the right pipeline steps.
- [Spreadsheet Financial Review](https://docs.runpulse.com/cookbooks/spreadsheet-financial-review.md): Extract Excel workbooks with hidden-content controls, raw values, and phantom-cell trimming.
- [Vector Metadata Contract](https://docs.runpulse.com/cookbooks/vector-metadata-contract.md): Design stable metadata for embeddings, chunks, citations, and retrieval audit trails.
- [Production Webhooks](https://docs.runpulse.com/cookbooks/webhooks-production.md): Use webhooks to receive async job notifications without tight polling loops.
- [Word-Level Review Overlays](https://docs.runpulse.com/cookbooks/word-bbox-review.md): Use word-level bounding boxes for source-grounded review, QA, and redaction previews.
- [Introduction](https://docs.runpulse.com/introduction.md): Pulse turns complex documents into reliable text, tables, structured JSON, citations, and reusable extraction artifacts.
- [Migrate from /extract_async to /extract](https://docs.runpulse.com/legacy/migrate-extract-async.md): How to switch from deprecated /extract_async calls to unified /extract calls with the async flag
- [Migrate from structured_output to /schema](https://docs.runpulse.com/legacy/migrate-structured-output.md): How to switch from passing structured_output on /extract to using the dedicated /schema endpoint for structured data extraction
- [Agent Quickstart](https://docs.runpulse.com/mcp/agent-quickstart.md): Connect an AI agent to Pulse and run a reliable document workflow with MCP tools.
- [Claude Connector](https://docs.runpulse.com/mcp/claude-connector.md): Add Pulse to Claude as a remote MCP connector with OAuth, no API key required.
- [Connecting a client](https://docs.runpulse.com/mcp/connecting.md): Set up the Pulse MCP server, hosted or local, in Codex, Claude Desktop, Claude Code, VS Code, or any MCP-compatible client.
- [MCP Server](https://docs.runpulse.com/mcp/overview.md): Connect AI agents to Pulse via the Model Context Protocol.
- [Tools & workflows](https://docs.runpulse.com/mcp/tools.md): The full Pulse MCP tool reference: parameters, return shapes, behaviors, and end-to-end agent examples.
- [Platform Quickstart](https://docs.runpulse.com/platform-quickstart.md): Build and run your first Pulse pipeline in the Playground.
- [Build Your First Pipeline](https://docs.runpulse.com/platform-reference/build-first-pipeline.md): Create, test, save, and export a complete Pulse pipeline from the Platform.
- [Extract](https://docs.runpulse.com/platform-reference/extract.md): Convert any supported document to markdown, tables, and figures — the foundation of every Pulse pipeline.
- [Extract → Schema](https://docs.runpulse.com/platform-reference/extract-schema.md): Extract a document and apply a JSON Schema to pull structured fields — perfect for invoices, forms, and single-structure documents.
- [Extract → Split → Schema](https://docs.runpulse.com/platform-reference/extract-split-schema.md): Extract a document, divide it into topic-based sections, and apply different schemas to each section independently.
- [Extraction Library](https://docs.runpulse.com/platform-reference/extraction-library.md): Browse, organize, and revisit all your saved extractions in a searchable, folder-based library.
- [Form Filler](https://docs.runpulse.com/platform-reference/form-filler.md): Fill and clear PDF forms visually in the Pulse Platform.
- [Platform Reference](https://docs.runpulse.com/platform-reference/introduction.md): Guides and reference documentation for the Pulse Platform.
- [Moving from Platform to Production](https://docs.runpulse.com/platform-reference/platform-to-production.md): Take the pipeline you built in the Playground and turn it into production code using Show Code, presets, and the Pulse SDKs.
- [Playground Walkthrough](https://docs.runpulse.com/platform-reference/playground-walkthrough.md): A guided tour of the Pulse Playground and the pipeline builder.
- [Reruns Post-Extraction](https://docs.runpulse.com/platform-reference/reruns.md): How to re-run extraction, schema, and split steps on already-processed documents without re-uploading.
- [Step Preset Library](https://docs.runpulse.com/platform-reference/step-preset-library.md): Save, reuse, and share pipeline configurations — on the platform and via the API using config IDs.
- [API Quickstart](https://docs.runpulse.com/quickstart.md): Parse your first document with the Pulse API and SDKs.
- [Security & Compliance](https://docs.runpulse.com/security/overview.md): How Pulse protects documents, credentials, storage, retention, and production workflows.
- [AWS S3 Setup](https://docs.runpulse.com/storage/aws-s3.md): Configure your own AWS S3 bucket for extraction storage
- [Azure Blob Setup](https://docs.runpulse.com/storage/azure-blob.md): Configure your own Azure Blob Storage for extraction storage
- [Google Cloud Storage Setup](https://docs.runpulse.com/storage/gcp-cloud-storage.md): Configure your own GCP Cloud Storage bucket for extraction storage
- [Custom Storage Overview](https://docs.runpulse.com/storage/overview.md): Store extraction artifacts in your own cloud storage
- [Support](https://docs.runpulse.com/support.md): Get help with Pulse API
- [Webhooks](https://docs.runpulse.com/svix-webhooks.md): Real-time notifications for asynchronous job processing

## OpenAPI Specs

- [openapi](https://docs.runpulse.com/api-reference/openapi.yml)

## Optional

- [Status](https://status.runpulse.com)
- [Blog](https://runpulse.com/blog)
- [Support](mailto:support@trypulse.ai)
- [Platform](https://platform.runpulse.com)