Jobs

Close a job execution

View as Markdown

Close a job execution as completed or failed.

Call this when an off-platform script finishes. Either status is final: re-sending the same status is a no-op, and changing it is rejected. Only executions opened by the start tool are accepted; the platform records every other execution’s status itself.

Requires an API key with the write scope.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

execution_idstringRequired

Request

This endpoint expects an object.
statusenumRequired

How the run ended. Either status is final: the execution cannot change status afterwards.

Response

OK
job_execution_idstringformat: "uuid"

Pass this as job_execution_id to the write and upload-file tools.

job_idstringformat: "uuid"
ID of the job the execution belongs to.
job_namestring
Name of the job the execution belongs to.
statusstring or null
The execution's current status.
started_atdatetime or null
When the execution started.
completed_atdatetime or null
When the execution ended, or null while it is still running.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error