Request cancellation

Requests cancellation and returns the current job object — canceling (interruption takes effect at node/step boundaries) or already-terminal. Idempotent: canceling a finished job is a no-op returning the terminal state. On serverless, GPU seconds consumed before the interrupt takes effect are still billed.

POST /api/v2/jobs/{id}/cancel

Request cancellation

cURL

curl --request POST \
  --url http://127.0.0.1:8189/api/v2/jobs/{id}/cancel \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "7f3d2c1b-9a8e-4d6f-b012-3c4d5e6f7a8b",
  "status": "queued",
  "created_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "queue_position": 123,
  "progress": {
    "value": 0.42,
    "nodes_done": 11,
    "nodes_total": 31,
    "current_node": "12",
    "current_node_class": "KSampler",
    "step": 21,
    "steps": 50,
    "message": "KSampler 21/50"
  },
  "outputs": [
    {
      "node_id": "9",
      "name": "ComfyUI_00001_.png",
      "type": "image",
      "content_type": "image/png",
      "size_bytes": 1848320,
      "id": "9f8a1c0d-2b3e-4f56-...",
      "hash": "<string>",
      "url": "<string>",
      "url_expires_at": "2023-11-07T05:31:56Z",
      "job_id": "<string>"
    }
  ],
  "error": {
    "code": "node_execution_error",
    "message": "<string>",
    "node_id": "<string>",
    "class_type": "<string>",
    "traceback": "<string>"
  },
  "urls": {
    "self": "<string>",
    "events": "<string>",
    "cancel": "<string>"
  },
  "logs": {
    "text": "<string>",
    "truncated": true,
    "captured_at": "2023-11-07T05:31:56Z"
  },
  "metrics": {
    "queue_ms": 9000,
    "execution_ms": 42000
  }
}

承認

Authorization · string · header · 必須

Authorization: Bearer <api-key> — account-scoped API keys on Cloud and serverless. Self-hosted accepts unauthenticated requests by default and can be configured with a static bearer token.

パスパラメータ

id · string · 必須

レスポンス

200

application/json

Current job state.

One execution of a workflow. Durable from creation until expires_at; outputs populates incrementally during execution.

id · string · 必須

例:

"7f3d2c1b-9a8e-4d6f-b012-3c4d5e6f7a8b"

status · enum<string> · 必須

Lifecycle: queued → running → succeeded | failed | expired; a cancel request moves running → canceling → canceled. Terminal states: succeeded, canceled, failed, expired.

利用可能なオプション: queued, running, succeeded, canceling, canceled, failed, expired

created_at · string<date-time> · 必須

started_at · string<date-time> | null · 必須

completed_at · string<date-time> | null · 必須

expires_at · string<date-time> · 必須

Retention deadline — a platform property, not an API constant.

queue_position · integer | null · 必須

progress · object | null · 必須

The latest progress snapshot; same data the SSE stream pushes.

Show child attributes

outputs · object[] · 必須

Show child attributes

error · object | null · 必須

Execution failure detail, carried in job.error (not an HTTP error).

Show child attributes

urls · object · 必須

Embedded follow-up links — follow these, don't build URLs. A link is either an absolute URL or a host-relative reference (leading /) that already includes any prefix the serving surface is mounted under (e.g. a serverless gateway's /deployment/{deployment_id}/api/v2). Clients MUST resolve a host-relative link against the request origin (scheme + authority), never against a configured base URL — joining it to a base URL that carries the same mount prefix duplicates the prefix.

Show child attributes

logs · object

What the run printed. Only jobs run on the serverless platform (a {deployment}.run.comfy.app host) carry it. Comfy Cloud and self-hosted callers never receive it, so on those surfaces the field is always absent and a client should not wait for one. Where it is populated it is captured for every job, success and failure alike, since a job that succeeds while producing the wrong thing is exactly what a failure-only log cannot explain. It lives as long as the job it belongs to: nothing ages it out ahead of the job's own expires_at, so a job never outlives its log. Absent, not null, when there is none: the surface does not populate it at all, the job has not finished, the job predates log capture, or the job ran on the public demo deployment, which captures and stores the log like every other serverless deployment but withholds it on read, because that surface takes callers with no credential and a job id would otherwise be the only thing between one anonymous caller and another's run. Those cases are deliberately not distinguished, because a caller's next action is the same in all of them, which is to stop expecting a log. Returned by GET /api/v2/jobs/{id} only. It is deliberately absent from the job object on POST /api/v2/jobs, on POST /api/v2/jobs/{id}/cancel, and on the SSE status event: the last is pushed on every transition to every open stream, and a log on each frame would pay for the whole thing repeatedly to deliver it once. A client that streams to a terminal status and wants the log re-reads the job.

Show child attributes

metrics · object

Values are nullable (a metric not yet available — e.g. execution_ms before a job starts running — is null, not omitted); the example below is deliberately all-non-null purely to work around a Spectral/nimma lint-tooling crash on a literal null inside a schema example combined with additionalProperties.nullable: true — the schema itself is unchanged and still allows null values at runtime.

Show child attributes

例:

{ "queue_ms": 9000, "execution_ms": 42000 }