Skip to main content
The Ingestly 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.
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:
If omitted, the request targets the default workspace. See workspaces for more on how workspaces organize your resources.

​
Available endpoints

The Ingestly API currently exposes one endpoint for external use: See the webhook trigger endpoint for the full specification.

​
Request format

The webhook trigger endpoint accepts multipart/form-data requests with the document file.
Pass an optional Idempotency-Key (a GUID) to make a retry safe, and read the X-Correlation-ID response header to trace a request. See the trigger endpoint for the full contract.

​
Response format

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

​
Success response

A successful trigger returns 202 Accepted with the created document’s id and status. The document is then processed asynchronously.

​
Error response

​
Rate limits

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

​
SDKs and libraries

Ingestly 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#.