POST
/
v2
/
push
Push New Job
curl --request POST \
  --url https://mango.sievedata.com/v2/push \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "function": "sieve/retalker",
  "id": "43d7add5-61cf-44ad-aac8-c5d14c642bb4",
  "inputs": {
    "input1": "a",
    "input2": "b"
  },
  "webhooks": [
    {
      "type": "job.start",
      "url": "<string>"
    }
  ],
  "env": {
    "OPENAI_API_KEY": "..."
  }
}'
{
  "id": "<string>",
  "run_id": "<string>",
  "stream_output": true,
  "status": "<string>",
  "organization_id": "<string>",
  "model_id": "<string>",
  "workflow_id": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

The Sieve API key to authenticate with.

Query Parameters

​
source
enum<string>
default:api
Available options:
api,
dashboard,
search

Body

application/json

Input schema for /v2/push.

​
inputs
required

The inputs to the job — read more about inputs here.

Examples:
{ "input1": "a", "input2": "b" }
​
function
string | null

The name of the function, in the format of author/name[:version]. Either function or id may be specified, but not both.

Examples:

"sieve/retalker"

​
id
string | null

The ID of the function to be called.

Examples:

"43d7add5-61cf-44ad-aac8-c5d14c642bb4"

​
webhooks
WebhookModel · object[] | null

Webhooks — see more info here.

​
env
object | null

Environment variables for the given job.

Examples:
{ "OPENAI_API_KEY": "..." }

Response

Successful Response

Output schema for /v2/push.

​
id
string
required

The ID of the job.

​
run_id
string
required

Internal metadata.

​
stream_output
boolean
required

Whether the output will be streamed.

​
status
string
required

The status of the job. Possible values: 'queued', 'processing', 'error', 'finished', 'cancelled', . Leave empty to get all statuses.

​
organization_id
string
required

The ID of the organization.

​
model_id
string
required

The ID of the model.

​
workflow_id
string | null
required

The ID of the workflow.