Start Job
POST/api/v2/workspaces/:workspace_id/jobs/:job_id/start
Enqueue the job for execution.
To be notified when the job finishes, pass one or more callbacks. deepset sends a POST request to each callback URL with the JSON body {"job_id": "<job_id>", "status": "<status>"}. status is ENDED if the job completed and FAILED if it did not, so you receive exactly one of the two. Any headers you supply are sent with the request.
Each callback is sent once, with a 10-second timeout and no retries, and the response code is not checked. Treat the callback as a notification and call GET /workspaces/{workspace_id}/jobs/{job_id} when you need the authoritative job status.
Returns 409 if the job is already STARTED; pass '?force=true' to re-enqueue a stuck job without losing progress already made.
Request
Responses
- 200
- 422
Successful Response
Validation Error
Was this page helpful?