POST
/
pipelines
/
run
/
$
{pipelineId}
curl --request POST \
  --url 'https://api.getomni.ai/pipelines/run/${pipelineId}' \
  --header 'x-api-key: <api-key>'
{
  "jobId": "093ae7d8-1668-4c76-9f31-772c50bcb172",
  "result": "https://api.getomni.ai/pipelines/run/46e92af4-3174-47af-998a-cd694fc850ce?jobId=093ae7d8-1668-4c76-9f31-772c50bcb172",
  "status": "PENDING"
}

​
Path Parameters

​
pipelineId
string
required

The ID of the pipeline to run

​
Body Parameters

The body should exactly match what you defined in the app. The parameter can be passed in either as text or file, depending on how it was defined.

Example:

{
  "file": "https://omni-demo-data.s3.us-east-1.amazonaws.com/templates/bank-account-statement.png"
}

​
Response

​
id
string

The ID of the pipeline run

​
result
string

URL for polling the pipeline result

​
status
string

The status of the pipeline run.

{
  "jobId": "093ae7d8-1668-4c76-9f31-772c50bcb172",
  "result": "https://api.getomni.ai/pipelines/run/46e92af4-3174-47af-998a-cd694fc850ce?jobId=093ae7d8-1668-4c76-9f31-772c50bcb172",
  "status": "PENDING"
}