Skip to main content

Complete Agent Job

POST 

/api/automation/runner/jobs/:job/complete

Finish a claimed job successfully. The waiting run resumes with the result on the step's success output.

Authorization

Called by your own agent or script with the token SKU issued for this runner or callback, sent as Authorization: Bearer <token> — not with a Personal Access Token or a session.

Authenticate with the runner token as Authorization: Bearer <runner token> (not a Personal Access Token).

Body (all optional)

  • result (object) - the job's output; when the step defines a result schema (JSON Schema) it must match, otherwise 422 and the job stays open. The schema check reads the JSON exactly as sent: {} is an object and [] is an array, so an empty array does not satisfy {"type": "object"}.
  • summary (string, max 500) - shown as the run's outcome.
  • url (http/https link, max 2048) - a link to the produced artifact.

Returns 202 when accepted. 404 unknown job, 409 job already closed, 422 validation or result-schema mismatch (errors keyed by the result.<path> that failed).

Request​

Responses​

Accepted

Response Headers
    Content-Type