Push New Job
Creates a new job.
POST
/
v2
/
push
Authorizations
X-API-Key
string
headerrequiredThe Sieve API key to authenticate with.
Headers
x-forwarded-for
string | null
x-real-ip
string | null
Body
application/json
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.
inputs
required
The inputs to the job — read more about inputs here.
webhooks
object[] | null
Webhooks — see more info here.
env
object | null
Environment variables for the given job.
Response
200 - application/json
id
string
requiredThe ID of the job.
run_id
string
requiredInternal metadata.
stream_output
boolean
requiredWhether the output will be streamed.
status
string
requiredThe status of the job. Possible values: 'queued', 'processing', 'error', 'finished', 'cancelled'
organization_id
string
requiredThe ID of the organization.
model_id
string
requiredThe ID of the model.
workflow_id
string | null
requiredThe ID of the workflow.
Was this page helpful?