Run Batch Pipeline

POST /batches/pipelines/run/${pipelineId}

Run transforms based on the passed in request parameters

Request

Pipeline must be enabled to run.

Headers

An API Key is required to access this endpoint.

Name	Value
x-api-key	your_api_key

Body

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

Example

{
  "requests": [
    {
      "restaurant_id": "d9504261cc66", 
      "review": "This place was really good. Highly recommend it. We had the steak, chicken and prawns. All super good. You definitely come out full."
    },
    {
      "restaurant_id": "d9504261cc67", 
      "review": "The food was terrible and overpriced. Won’t be coming back."
    }
  ]
}

Response

The API returns the response in JSON format.

The request will return a 200 with a jobId and status. You can use this jobId to check the processing status and fetch results.

Example

200

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

400

{
  "error": "Invalid request"
}