Skip to main content
POST
/
batches
/
pipelines
/
run
/
$
{pipelineId}
Run Batch Pipeline
curl --request POST \
  --url 'https://api.getomni.ai/batches/pipelines/run/${pipelineId}' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "requests": [
    {}
  ]
}'
{
  "jobId": "123e4567-e89b-12d3-a456-426614174000",
  "result": "https://api.getomni.ai/batches/pipelines/poll/123e4567-e89b-12d3-a456-426614174000?jobId=123e4567-e89b-12d3-a456-426614174000",
  "status": "PENDING"
}

​
Path Parameters

​
pipelineId
string
required
The ID of the pipeline to run

​
Body Parameters

​
requests
array
required
The requests to run the pipeline on
Example: 
{
  "requests": [
    {
      "file": "file_1.pdf"
    },
    {
      "file": "file_2.pdf"
    }
  ]
}

​
Response

​
jobId
string
The job ID of the pipeline run
​
result
string
URL to poll for the results of the pipeline run
​
status
string
The status of the pipeline run
{
  "jobId": "123e4567-e89b-12d3-a456-426614174000",
  "result": "https://api.getomni.ai/batches/pipelines/poll/123e4567-e89b-12d3-a456-426614174000?jobId=123e4567-e89b-12d3-a456-426614174000",
  "status": "PENDING"
}
⌘I