Jobs
Endpoints for retrieving and managing specific jobs
Retrieve the results of a specific job
Task API
Gets the results of a specific job, identified by the organization ID, topic, task, and job ID. The job's status is returned in the response, along with either the results or an error object, depending on the status of the job. If the job is ongoing, the response includes links to the job's cancellation endpoint and detailed status endpoint.
Parameters
Returns
200
The response for a completed job, which includes the job's status and may also contain either results or an error object, depending on the status of the job.
Endpoint
Request
curl -X GET 'https://{service_host}/compute/orgs/{org_id}/{topic}/{task}/{job_id}' \
-H 'Authorization: Bearer <ACCESS_TOKEN>'
Response
No response body.
Cancel a specific job
Task API
Cancels a specific job, identified by the organization ID, topic, task, and job ID. The job's status is updated to 'canceling' and the job is stopped.
Parameters
Returns
204
204 response
Endpoint
Request
curl -X DELETE 'https://{service_host}/compute/orgs/{org_id}/{topic}/{task}/{job_id}' \
-H 'Authorization: Bearer <ACCESS_TOKEN>'
Response
No response body.
Retrieve the status of a specific job
Task API
Gets the status of a specific job, identified by the organization ID, topic, task, and job ID. The job's status is returned in the response, along with a progress indicator, a message, and an error object, if applicable. If the job is ongoing, the response includes links to the job's cancellation endpoint.
Parameters
Returns
200
200 response
Endpoint
Request
curl -X GET 'https://{service_host}/compute/orgs/{org_id}/{topic}/{task}/{job_id}/status' \
-H 'Authorization: Bearer <ACCESS_TOKEN>'
Response
No response body.
