POST
/
v2
/
push

This endpoint triggers either a function or a model with a given set of inputs. The structure of the inputs should match the inputs types specified in the function or model definition.

​
Example

A function that takes in a sieve.File named video and a sieve.File named image would be triggered with the following request:

{
  "function": "sieve/sample_function",
  "inputs": {
    "video": {
      "url": "{SOME_VIDEO_URL}"
    },
    "image": {
      "url": "{SOME_IMAGE_URL}"
    }
  }
}

A function that takes in a string named prompt would be triggered with the following request:

{
  "function": "sieve/some_function",
  "inputs": {
    "prompt": "some string"
  }
}

​
Webhooks

Webhooks provide a way for notifications to be delivered to an external web server when various events related Sieve jobs occur.

The following is a full list of all webhook event types. Click the events to see the exact response payload.

EventDescription
job.startOccurs when a job starts.
job.completeOccurs when a job completes, errors, or is cancelled.
job.complete.no_outputOccurs when a job completes, errors, or is cancelled — excludes the output payload from the response.
job.new_outputOccurs when a job produces a new output.

See the webhooks guide for more information on webhook integration.

Authorizations

​
X-API-Key
string
headerrequired

The Sieve API key to authenticate with.

Body

application/json

Input schema for /v2/push.

​
inputs
required

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

​
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.

​
id
string | null

The ID of the function to be called.

​
webhooks
object[] | null

Webhooks — see more info here.

​
env
object | null

Environment variables for the given job.

Response

200 - application/json

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.

Was this page helpful?

IntroductionGet Job