Push New Job
Creates a new job.
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:
A function that takes in a string
named prompt
would be triggered with the following request:
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.
Event | Description |
---|---|
job.start | Occurs when a job starts. |
job.complete | Occurs when a job completes, errors, or is cancelled. |
job.complete.no_output | Occurs when a job completes, errors, or is cancelled — excludes the output payload from the response. |
job.new_output | Occurs when a job produces a new output. |
See the webhooks guide for more information on webhook integration.
Authorizations
The Sieve API key to authenticate with.
Body
Input schema for /v2/push.
The name of the function, in the format of author/name[:version]
. Either function
or id
may be specified, but not both.
The ID of the function to be called.
Environment variables for the given job.
Response
Output schema for /v2/push.
The ID of the job.
Internal metadata.
Whether the output will be streamed.
The status of the job. Possible values: 'queued', 'processing', 'error', 'finished', 'cancelled', . Leave empty to get all statuses.
The ID of the organization.
The ID of the model.
The ID of the workflow.
Was this page helpful?