Base URL
Authentication
All API requests require authentication using an API key passed in theX-Api-Key header.
Available endpoints
The DocPipe API currently exposes one endpoint for external use:| Method | Path | Description |
|---|---|---|
POST | /pipes/{pipeId}/http-trigger | Submit a document to a pipe for processing |
Request format
The HTTP trigger endpoint acceptsmultipart/form-data requests with the document file.
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. If you exceed the limit, you receive a429 Too Many Requests response. Wait and retry after the period indicated in the response headers.