VEverbiflow
growth-artifact-jobs

Cancel Tool Job

post/api/tool-jobs/{job_id}/cancel

Request

  • Base URL
    https://platform.verbiflow.com/api/bridge
  • URL
    https://platform.verbiflow.com/api/bridge/api/tool-jobs/{job_id}/cancel
  • Auth
    • HTTP bearer and API key in header x-flage-org-id
    • or HTTP bearer and API key in header x-flage-org-slug

Path parameters

job_idstring required

Request body

reasonstring nullable

Response

Successful Response

artifact_idstring nullable required

Immutable result artifact when it is readable.

error_messagestring nullable required

Terminal public failure detail, or null.

failedboolean required

True when the durable status is failed.

finishedboolean required

True after a durable terminal event exists.

job_idstring required

Durable job identity.

limitinteger required

Maximum preview rows requested.

offsetinteger required

Zero-based preview row offset.

phasestring required

Current producer-defined execution phase.

progress_currentinteger required

Durably completed work units.

progress_totalinteger required

Declared work units for this execution.

status'queued' | 'running' | 'blocked' | 'completed' | 'failed' required

Durable job lifecycle status.

tool_kindstring required

Server-owned worker kind that produced this job.

Changes

No recorded changes to this operation across all 1 revision of this API.