Tasks

Cancel a running task

Marks a queued or running task as canceled. Note: synchronous tasks (everything except video) typically complete in seconds, so the cancel window is narrow. For async provider tasks (video) the cancel propagates to our records but does not abort the external provider's job — you may still be billed by them.

post/v1/tasks/{id}/cancel

Request

  • Base URL: https://nanostudiopro.com/api
  • URL: https://nanostudiopro.com/api/v1/tasks/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idstring required

Response

Task canceled.

idstring
action'upload' | 'scan' | 'export' | 'generate'

High-level grouping of the operation.

kindstring

Specific operation — e.g. generate.quick, generate.restyle, generate.video, generate.angles, upload, scan, export.

status'queued' | 'running' | 'complete' | 'failed' | 'canceled'
progressinteger

Best-effort 0-100; many endpoints leave it at 0.

errorstring nullable

User-facing error message if status=failed.

labelstring nullable
originstring nullable

Where the task was triggered from. API for external callers, plus values like Prompter, Card menu, Pose editor.

display_metaobject nullable

Free-form metadata (aspect ratio, project id, thumbnail path) used by the UI placeholder. Safe for external clients to display verbatim.

intentobject nullable

Endpoint + body the task originated from. Used internally for retries.

retriesinteger

How many retry attempts have been made.

max_retriesinteger
generation_idstring nullable

FK to the resulting Generation, if applicable.

asset_idstring nullable

FK to the resulting Asset, if applicable.

scan_result_idstring nullable
parent_task_idstring nullable

For batched operations — points to the parent Task.

started_atstring date-time
completed_atstring date-time nullable
created_atstring date-time

Example response

{
  "label": "Generate · gold transformation",
  "provider": {
    "key": "kling"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.