Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.docpipe.ai/llms.txt

Use this file to discover all available pages before exploring further.

The DocPipe API lets you submit documents for processing programmatically using API keys.

​
Base URL

​
Authentication

All API requests require authentication using an API key passed in the X-Api-Key header. 
X-Api-Key: dp_your_api_key_here
See authentication for details on creating and managing API keys.

​
Workspace scoping

To scope an API request to a specific workspace, include the X-Workspace-Id header: 
X-Workspace-Id: your-workspace-id
If omitted, the request targets the default workspace. See workspaces for more on how workspaces organize your resources.

​
Available endpoints

The DocPipe API currently exposes one endpoint for external use:
MethodPathDescription
POST/pipes/{pipeId}/triggerSubmit a document to a pipe for processing
See the webhook trigger endpoint for the full specification.

​
Request format

The webhook trigger endpoint accepts multipart/form-data requests with the document file. 
curl -X POST "https://api.docpipe.ai/pipes/{pipeId}/trigger" \
  -H "X-Api-Key: dp_your_api_key_here" \
  -F "file=@document.pdf"

​
Response format

Successful responses return JSON. Error responses follow the RFC 7807 Problem Details format.

​
Success response

A successful trigger returns details about the created run.

​
Error response

​
Rate limits

API requests are subject to rate limits based on your subscription plan. See rate limits for details.

​
SDKs and libraries

DocPipe does not currently provide official SDK libraries. Use the HTTP API directly with your preferred HTTP client. See the webhook trigger guide for code examples in cURL, JavaScript, Python, and C#.