Skip to main content
POST
/
pipes
/
{pipeId}
/
http-trigger
Trigger pipe via HTTP
curl --request POST \
  --url https://api.docpipe.ai/pipes/{pipeId}/http-trigger \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-Api-Key: <api-key>' \
  --form file='@example-file'
{
  "runId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pipeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "Queued"
}

Authorizations

​
X-Api-Key
string
header
required

API key for authentication. Keys use the dp_ prefix and are created in the DocPipe dashboard under Settings → API Keys.

Path Parameters

​
pipeId
string<uuid>
required

The unique identifier of the pipe to trigger.

Body

multipart/form-data
​
file
file
required

The document file to process. Supported formats: PDF, JPEG, PNG, TIFF, HEIC.

Response

Document accepted for processing.

​
runId
string<uuid>
required

The unique identifier of the created pipeline run.

​
fileId
string<uuid>
required

The unique identifier of the uploaded file.

​
pipeId
string<uuid>
required

The unique identifier of the pipe.

​
status
enum<string>
required

The initial status of the run.

Available options:
Queued