Cancel a run

curl --request POST \
  --url https://api.example.com/v1/runs/{run_id}/cancel

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/runs/{run_id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/runs/{run_id}/cancel"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/runs/{run_id}/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

{
  "run_id": "<string>",
  "namespace": "<string>",
  "app_name": "<string>",
  "app_version": "<string>",
  "build_id": "<string>",
  "run_kind": "<string>",
  "state": {},
  "input": {},
  "progress": {
    "done": 123,
    "total": 123,
    "status_text": "<string>"
  },
  "dataset_id": "<string>",
  "partial": true,
  "cancel_requested": true,
  "triggered_by": "<string>",
  "upstream_ref": "<string>",
  "created_at": "<string>",
  "started_at": "<string>",
  "first_started_at": "<string>",
  "finished_at": "<string>",
  "usage": {
    "metrics": {},
    "duration_ms": 123
  },
  "billing": {
    "events": [
      {
        "event": "<string>",
        "label": "<string>",
        "qty": 123,
        "unit_price": 123,
        "amount": 123,
        "unit_size": 123,
        "raw_qty": 123
      }
    ],
    "total": 123,
    "currency": "<string>",
    "charged": true
  },
  "error": {
    "code": "<string>",
    "category": "<string>",
    "message": "<string>",
    "retryable": true,
    "retry_after": 123,
    "item_index": 123,
    "details": [
      {}
    ]
  },
  "sample_records": [
    {}
  ],
  "warnings": [
    {
      "code": "<string>",
      "event": "<string>",
      "detail": {},
      "count": 123,
      "updated_at": "<string>"
    }
  ]
}

POST

runs

{run_id}

cancel

Cancel a run

curl --request POST \
  --url https://api.example.com/v1/runs/{run_id}/cancel

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/runs/{run_id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/runs/{run_id}/cancel"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/runs/{run_id}/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

{
  "run_id": "<string>",
  "namespace": "<string>",
  "app_name": "<string>",
  "app_version": "<string>",
  "build_id": "<string>",
  "run_kind": "<string>",
  "state": {},
  "input": {},
  "progress": {
    "done": 123,
    "total": 123,
    "status_text": "<string>"
  },
  "dataset_id": "<string>",
  "partial": true,
  "cancel_requested": true,
  "triggered_by": "<string>",
  "upstream_ref": "<string>",
  "created_at": "<string>",
  "started_at": "<string>",
  "first_started_at": "<string>",
  "finished_at": "<string>",
  "usage": {
    "metrics": {},
    "duration_ms": 123
  },
  "billing": {
    "events": [
      {
        "event": "<string>",
        "label": "<string>",
        "qty": 123,
        "unit_price": 123,
        "amount": 123,
        "unit_size": 123,
        "raw_qty": 123
      }
    ],
    "total": 123,
    "currency": "<string>",
    "charged": true
  },
  "error": {
    "code": "<string>",
    "category": "<string>",
    "message": "<string>",
    "retryable": true,
    "retry_after": 123,
    "item_index": 123,
    "details": [
      {}
    ]
  },
  "sample_records": [
    {}
  ],
  "warnings": [
    {
      "code": "<string>",
      "event": "<string>",
      "detail": {},
      "count": 123,
      "updated_at": "<string>"
    }
  ]
}

POST https://api-datahub.octoparse.com/v1/runs/{run_id}/cancel Authentication: API key required (Authorization: Bearer <API Key>). Sends a cancel signal and briefly waits (up to 5 seconds) for the executor to respond, then returns the current run object. Queued runs stop immediately; running ones usually stop cooperatively within a few seconds. Records already written are kept (partial is true), remain readable, and are billed only for what was produced. Ownership matches run detail: you can only cancel runs you started. After cancel, confirm the terminal state with Get a run.

Request

Path parameters

string

required

Run id.

Example request

curl -X POST \
  -H "Authorization: Bearer $OCTOPARSE_API_KEY" \
  "https://api-datahub.octoparse.com/v1/runs/run_c62bc0fb8df2/cancel"

Response

200 success

{
  "data": {
    "run_id": "run_c62bc0fb8df2",
    "namespace": "carol",
    "app_name": "probe-b",
    "app_version": "0.1.0",
    "build_id": null,
    "run_kind": "production",
    "state": "SUCCEEDED",
    "input": {
      "product": "p-now"
    },
    "progress": {
      "done": 20,
      "total": null,
      "status_text": null
    },
    "dataset_id": "ds_0bd5345d13d0",
    "partial": false,
    "cancel_requested": false,
    "triggered_by": "api",
    "upstream_ref": null,
    "created_at": "2026-09-15T07:45:40.411993+00:00",
    "started_at": "2026-09-15T07:45:40.419610+00:00",
    "first_started_at": "2026-09-15T07:45:40.419610+00:00",
    "finished_at": "2026-09-15T07:45:40.822250+00:00",
    "usage": {
      "metrics": {
        "records_collected": 20
      },
      "duration_ms": 402
    },
    "billing": {
      "events": [
        {
          "event": "record",
          "label": "One record",
          "qty": 20.0,
          "unit_price": 0.001,
          "amount": 0.02,
          "unit_size": null,
          "raw_qty": null
        }
      ],
      "total": 0.02,
      "currency": "USD",
      "charged": true
    },
    "error": null,
    "sample_records": null,
    "warnings": []
  }
}

Returns a run object. Fields match Start a run. The payload is wrapped in data. Fields:

string

required

—

string

—

string

—

string

—

string

—

string

—

enum

required

Values: PENDING / QUEUED / RUNNING / SUCCEEDED / PARTIALLY_SUCCEEDED / FAILED / CANCELLED / EXPIRED.

object

—

object

—

Show fields

integer

—

integer

—

string

—

string

—

boolean

—

boolean

true while cancellation has been requested and the run is still winding down (cooperative stop / partial-result recovery). Always false in terminal states (normalized server-side), so clients need not derive it from state.

string

—

string

—

string

—

string

—

string

When a worker first claimed the run. Unlike started_at, this is never rewritten on retry, so it is the anchor for queue time: queued = first_started_at - created_at, and total wall time = finished_at - first_started_at. Deriving queue time from started_at counts earlier attempts as queueing. null only for runs never claimed.

string

—

object

Objective usage metering: how much the run did. Kept separate from billing; this is what evaluations compare against.

Show fields

object

—

integer

—

object

Billing ledger = usage × pricing × billing rules: how much is charged.

Show fields

object[]

—

Show fields

string

required

—

string

—

number

required

—

number

required

—

number

required

—

integer

—

number

—

number

—

string

—

boolean

—

object

—

Show fields

string

required

—

string

—

string

required

—

boolean

—

number

—

integer

—

object[]

—

object[]

—

object[]

—

Show fields

string

required

—

string

—

object

—

integer

—

string

—

Errors

HTTP	`code`	`category`	Description
401	`unauthorized`	`forbidden`	Missing or invalid API key.
404	`run-not-found`	`not_found`	Run does not exist, or was not started by the current account.
409	`run-terminal`	`invalid_input`	Run already finished and cannot be cancelled.

Error responses use {"error": {code, category, message, retryable}}. See Errors.

Client libraries

run = client.cancel("run_c62bc0fb8df2")
print(run["state"], run["partial"])

const run = await client.cancel("run_c62bc0fb8df2");
console.log(run.state, run.partial);

GET STARTED

QUICK START

REFERENCE

DATA HUB API

Cancel a run

Request

Path parameters

Example request

Response

200 success

Errors

Client libraries

​Request

​Path parameters

​Example request

​Response

​200 success

​Errors

​Client libraries

Request

Path parameters

Example request

Response

200 success

Errors

Client libraries