Skip to content

Trigger an out-of-schedule job.

Method

PUT https://papi.afi.ai/api/v1/tenants/{tenant_id}/jobs/{job_id}/trigger

Description

Triggers an out-of-schedule job execution, spawns a task, and returns its ID.

Path params
tenant_id string required

Tenant ID that owns the job.

job_id string required

ID of the job to trigger.

curl -X PUT \
    -H 'Authorization: {api-key}' \
    https://papi.afi.ai/api/v1/tenants/{tenant_id}/jobs/{job_id}/trigger

Successful response (200) schema
object

TriggerJobResult contains the result of triggering a job.

task_id string

ID of the task spawned by the job. Use it to monitor the task status.

Response example
{
  "task_id": "string"
}