Sieve home pagelogo
API Reference
Push Data
POST

/v1/push

X-API-Key*
curl --request POST \
  --url https://mango.sievedata.com/v1/push \
  --header 'X-API-Key: <x-api-key>' \
  --data '{
  "workflow_name": "<workflow_name>",
  "inputs": "<inputs>"
}'
workflow_namerequired
string

name of Sieve workflow

inputsrequired
dict

a dictionary representing the inputs to the workflow

This endpoint triggers a workflow with a given set of inputs. The structure of the inputs should match the inputs types specified in the workflow definition.

​
Example

A workflow that takes in a sieve.Video named video and a sieve.Image named image would be triggered with the following request:

{
  "workflow_name": "sample_workflow",
  "inputs": {
    "video": {
      "url": "{SOME_VIDEO_URL}"
    },
    "image": {
      "url": "{SOME_IMAGE_URL}"
    }
  }
}

A workflow that takes in a str named prompt would be triggered with the following request:

{
  "workflow_name": "sample_workflow",
  "inputs": {
    "prompt": "some string"
  }
}

{
  "id": "c49b2fa2-f236-43d8-b2f3-03eceff16d71",
  "description": "Pushed c49b2fa2-f236-43d8-b2f3-03eceff16d71 to queue"
}