Cancel Twin

Stop a queued or processing twin. It is canceling until the build has actually stopped (seconds), then canceled, and twin.canceled is sent. The stages it finished stay cached for a later resume.

POST /v1/twins/{twin_id}/cancel

Cancel Twin

cURL

curl --request POST \
  --url https://api.kiteml.com/v1/twins/{twin_id}/cancel \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "status": "queued",
  "progress": 0.5,
  "source": {
    "repo_id": "<string>",
    "type": "huggingface"
  },
  "object": "twin",
  "stage": "<string>",
  "status_message": "<string>",
  "eta_seconds": 123,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resumable": true,
    "stage": "<string>"
  },
  "camera": {
    "scene": "<string>",
    "wrist": "<string>",
    "available": [
      "<string>"
    ]
  },
  "config": {},
  "stages": [
    {
      "stage": "<string>",
      "ok": true,
      "attempts": 123,
      "seconds": 123,
      "measurement": "<string>"
    }
  ],
  "download": {
    "url": "<string>",
    "requires_auth": true,
    "filename": "<string>",
    "bytes": 123,
    "sha256": "<string>",
    "scene": "<string>",
    "expires_at": "<string>"
  },
  "webhook_metadata": {},
  "created_at": "<string>"
}

Authorizations

Authorization · string · header · required

A Kite API key (kite_...), from Platform API → Keys in the dashboard.

Headers

Kite-Version · enum<string> · default: 2026-09-27

The dated contract your code was written against. Without it you get 2026-09-27; every response says which version served it.

Available options: 2026-09-27

Path Parameters

twin_id · string · required

Response

200

application/json

Successful Response

One digital twin.

id · string · required

twin_ + a time-ordered ULID

status · enum<string> · required

Available options: queued, processing, canceling, succeeded, failed, canceled

progress · number · required

Required range: 0 <= x <= 1

source · TwinSource · object · required

Where the episode comes from. The same shape as an augmentation's source.

Show child attributes

object · enum<string> · default: twin

Available options: twin

Allowed value: "twin"

stage · string | null

The stage running now

status_message · string | null

eta_seconds · integer | null

While queued or processing: time left, from the stages' typical durations

error · TwinError · object | null

Show child attributes

camera · TwinCamera · object | null

What the dataset check resolved

Show child attributes

config · Config · object

The build options given at create

stages · TwinStage · object[]

Every finished stage, in order

Show child attributes

download · TwinDownload · object | null

Once succeeded: the whole scene as one .tar.gz. Its file list is GET /v1/twins/{id}/files

Show child attributes

webhook_metadata · Webhook Metadata · object | null

created_at · string | null