> This page is for Paperwork API, version v2.
> For other versions, use one of these documentation indexes:
> - v1 (default): https://docs.cloudraker.com/paperwork/v1/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.cloudraker.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.cloudraker.com/_mcp/server.

# Cancel a run

POST https://your-org.cloudraker.run/v2/machines/runs/{id}/cancel

Cancels a run and its job. Only the credential that started the run can cancel it. A cancel runs no compensation: the log lists the writes that are done. Needs the scope `machines`.

Reference: https://docs.cloudraker.com/paperwork/v2/api/machines/cancel-run

## Authentication

- `Authorization` header (bearer token, required) — An API key (`crk_`), an exchanged token (`crt_`) or a JWT of a trusted issuer. The credential needs the scope of the capability. Read the description of each route.

## Request

### Path parameters

- `id` (string, required) — The run id. It is also the job id: `job_` and a ULID.

## Response

### 200

The cancelled job.

- `object` ("job", required)
- `id` (string, required) — `job_` and a ULID.
- `capability` (string, required) — The capability of the job.
- `status` (enum, required) — The status of the job.
  - Allowed values: `queued`, `running`, `needs_input`, `succeeded`, `failed`, `cancelled`, `expired`
- `deadline` ("asap", required) — Only `asap` at this time.
- `created_at` (datetime, required) — When the API accepted the job.
- `completed_at` (datetime, required, nullable) — When the job ended. Null while the job runs.
- `output` (any, required) — The output of a succeeded job, or null. The shape depends on the capability. The stored output is at most 1048576 bytes.
- `error` (JobError, required, nullable) — Why a job did not succeed.
- `usage` (Usage, required, nullable) — The metered use of a job.
- `run_id` (string, optional) — The Run run id. Agent jobs only.
- `required_action` (RequiredAction, optional, nullable) — Machine jobs only. What the job waits for while its status is `needs_input`, else null. The other jobs do not have this field.

## Errors

### 401 Unauthorized Error

An error. The `code` is one of: `missing_credential`, `invalid_api_key`, `invalid_token`.

- `code` (enum, required) — The error code.
  - Allowed values: `invalid_request`, `wait_out_of_range`, `deadline_not_supported`, `procedure_invalid`, `missing_credential`, `invalid_api_key`, `invalid_token`, `credits_exhausted`, `insufficient_scope`, `production_access_disabled`, `test_key_not_allowed`, `not_found`, `tenant_not_found`, `job_not_found`, `idempotency_key_reused`, `job_not_cancellable`, `version_conflict`, `not_waiting`, `rate_limit_exceeded`, `concurrency_limited`, `internal_error`, `capability_unavailable`
- `message` (string, required) — A text for the developer. Do not parse it.
- `retryable` (boolean, required) — True when the same request can succeed later.
- `requestId` (string, required) — The value of the `x-request-id` answer header.
- `docUrl` (string, optional) — The docs page of this code.
- `details` (any, optional) — The validation issues of `invalid_request`.

### 403 Forbidden Error

An error. The `code` is one of: `insufficient_scope`, `production_access_disabled`, `test_key_not_allowed`.

- `code` (enum, required) — The error code.
  - Allowed values: `invalid_request`, `wait_out_of_range`, `deadline_not_supported`, `procedure_invalid`, `missing_credential`, `invalid_api_key`, `invalid_token`, `credits_exhausted`, `insufficient_scope`, `production_access_disabled`, `test_key_not_allowed`, `not_found`, `tenant_not_found`, `job_not_found`, `idempotency_key_reused`, `job_not_cancellable`, `version_conflict`, `not_waiting`, `rate_limit_exceeded`, `concurrency_limited`, `internal_error`, `capability_unavailable`
- `message` (string, required) — A text for the developer. Do not parse it.
- `retryable` (boolean, required) — True when the same request can succeed later.
- `requestId` (string, required) — The value of the `x-request-id` answer header.
- `docUrl` (string, optional) — The docs page of this code.
- `details` (any, optional) — The validation issues of `invalid_request`.

### 404 Not Found Error

An error. The `code` is one of: `not_found`, `tenant_not_found`, `job_not_found`.

- `code` (enum, required) — The error code.
  - Allowed values: `invalid_request`, `wait_out_of_range`, `deadline_not_supported`, `procedure_invalid`, `missing_credential`, `invalid_api_key`, `invalid_token`, `credits_exhausted`, `insufficient_scope`, `production_access_disabled`, `test_key_not_allowed`, `not_found`, `tenant_not_found`, `job_not_found`, `idempotency_key_reused`, `job_not_cancellable`, `version_conflict`, `not_waiting`, `rate_limit_exceeded`, `concurrency_limited`, `internal_error`, `capability_unavailable`
- `message` (string, required) — A text for the developer. Do not parse it.
- `retryable` (boolean, required) — True when the same request can succeed later.
- `requestId` (string, required) — The value of the `x-request-id` answer header.
- `docUrl` (string, optional) — The docs page of this code.
- `details` (any, optional) — The validation issues of `invalid_request`.

### 409 Conflict Error

An error. The `code` is one of: `idempotency_key_reused`, `job_not_cancellable`, `version_conflict`, `not_waiting`.

- `code` (enum, required) — The error code.
  - Allowed values: `invalid_request`, `wait_out_of_range`, `deadline_not_supported`, `procedure_invalid`, `missing_credential`, `invalid_api_key`, `invalid_token`, `credits_exhausted`, `insufficient_scope`, `production_access_disabled`, `test_key_not_allowed`, `not_found`, `tenant_not_found`, `job_not_found`, `idempotency_key_reused`, `job_not_cancellable`, `version_conflict`, `not_waiting`, `rate_limit_exceeded`, `concurrency_limited`, `internal_error`, `capability_unavailable`
- `message` (string, required) — A text for the developer. Do not parse it.
- `retryable` (boolean, required) — True when the same request can succeed later.
- `requestId` (string, required) — The value of the `x-request-id` answer header.
- `docUrl` (string, optional) — The docs page of this code.
- `details` (any, optional) — The validation issues of `invalid_request`.

### 429 Too Many Requests Error

An error. The `code` is one of: `rate_limit_exceeded`, `concurrency_limited`.

- `code` (enum, required) — The error code.
  - Allowed values: `invalid_request`, `wait_out_of_range`, `deadline_not_supported`, `procedure_invalid`, `missing_credential`, `invalid_api_key`, `invalid_token`, `credits_exhausted`, `insufficient_scope`, `production_access_disabled`, `test_key_not_allowed`, `not_found`, `tenant_not_found`, `job_not_found`, `idempotency_key_reused`, `job_not_cancellable`, `version_conflict`, `not_waiting`, `rate_limit_exceeded`, `concurrency_limited`, `internal_error`, `capability_unavailable`
- `message` (string, required) — A text for the developer. Do not parse it.
- `retryable` (boolean, required) — True when the same request can succeed later.
- `requestId` (string, required) — The value of the `x-request-id` answer header.
- `docUrl` (string, optional) — The docs page of this code.
- `details` (any, optional) — The validation issues of `invalid_request`.

### 500 Internal Server Error

An error. The `code` is one of: `internal_error`.

- `code` (enum, required) — The error code.
  - Allowed values: `invalid_request`, `wait_out_of_range`, `deadline_not_supported`, `procedure_invalid`, `missing_credential`, `invalid_api_key`, `invalid_token`, `credits_exhausted`, `insufficient_scope`, `production_access_disabled`, `test_key_not_allowed`, `not_found`, `tenant_not_found`, `job_not_found`, `idempotency_key_reused`, `job_not_cancellable`, `version_conflict`, `not_waiting`, `rate_limit_exceeded`, `concurrency_limited`, `internal_error`, `capability_unavailable`
- `message` (string, required) — A text for the developer. Do not parse it.
- `retryable` (boolean, required) — True when the same request can succeed later.
- `requestId` (string, required) — The value of the `x-request-id` answer header.
- `docUrl` (string, optional) — The docs page of this code.
- `details` (any, optional) — The validation issues of `invalid_request`.

### 503 Service Unavailable Error

An error. The `code` is one of: `capability_unavailable`.

- `code` (enum, required) — The error code.
  - Allowed values: `invalid_request`, `wait_out_of_range`, `deadline_not_supported`, `procedure_invalid`, `missing_credential`, `invalid_api_key`, `invalid_token`, `credits_exhausted`, `insufficient_scope`, `production_access_disabled`, `test_key_not_allowed`, `not_found`, `tenant_not_found`, `job_not_found`, `idempotency_key_reused`, `job_not_cancellable`, `version_conflict`, `not_waiting`, `rate_limit_exceeded`, `concurrency_limited`, `internal_error`, `capability_unavailable`
- `message` (string, required) — A text for the developer. Do not parse it.
- `retryable` (boolean, required) — True when the same request can succeed later.
- `requestId` (string, required) — The value of the `x-request-id` answer header.
- `docUrl` (string, optional) — The docs page of this code.
- `details` (any, optional) — The validation issues of `invalid_request`.

## Types

### JobError

Why a job did not succeed.

- `code` (enum, required) — The reason of the failure.
  - Allowed values: `invalid_request`, `output_too_large`, `rate_limited`, `credits_exhausted`, `capability_unavailable`, `capability_lost`, `agent_protection_unsupported`, `processing_failed`, `cancelled`, `expired`
- `message` (string, required) — A text for the developer.
- `retryable` (boolean, required) — True when the same request can succeed later.
- `details` (any, optional) — More data, for example `cause` with the original code.

### Usage

The metered use of a job.

- `units` (map from string to double, required) — The metered units of the job, by unit name.
- `credits` (double, required) — The credits that the job cost. An agent job can have a fraction.

### RequiredAction

What the run waits for: tool outputs, the answer of a person, or an input. Send it with the route of its type.

- RequiredAction0
- RequiredAction1
- RequiredAction2

### RequiredAction0

- `type` ("tool_calls", required)
- `tool_calls` (list of RequiredActionOneOf0ToolCallsItems, required)

### RequiredAction1

- `type` ("answer", required)
- `answer` (RequiredActionOneOf1Answer, required)

### RequiredAction2

- `type` ("inputs", required)
- `await_seq` (integer, required, nullable)
- `inputs` (list of RequiredActionOneOf2InputsItems, required)

### RequiredActionOneOf0ToolCallsItems

- `id` (string, required) — The tool call id.
- `name` (string, required)
- `idempotency_key` (string, required) — The same for each attempt of one step. Use the tool call id to run each attempt.
- `effect` (enum, required) — The effect of a step: `read`, `write` or `irreversible`.
  - Allowed values: `read`, `write`, `irreversible`
- `deadline_at` (datetime, required, nullable)
- `arguments` (map from string to any, optional)
- `arguments_truncated` (true, optional)

### RequiredActionOneOf1Answer

- `seq` (integer, required)
- `code` (string, required)
- `reason` (string, required)
- `question` (string, required, nullable)
- `schema` (map from string to any, required, nullable)
- `attachments` (list of any, optional)
- `attachments_truncated` (true, optional)

### RequiredActionOneOf2InputsItems

- `name` (string, required)
- `schema` (map from string to any, optional)
- `schema_truncated` (true, optional)

## Examples

**Response**

```json
{
  "object": "string",
  "id": "job_01JC9M0000000000000000AB",
  "capability": "parse",
  "status": "queued",
  "deadline": "string",
  "created_at": "2026-11-07T14:02:11Z",
  "completed_at": "2026-11-07T14:02:11Z",
  "output": null,
  "error": {
    "code": "invalid_request",
    "message": "string",
    "retryable": true,
    "details": null
  },
  "usage": {
    "units": {
      "page_parsed": 3
    },
    "credits": 6
  },
  "run_id": "string",
  "required_action": {
    "tool_calls": [
      {
        "arguments": {},
        "arguments_truncated": true,
        "deadline_at": "2026-11-07T14:02:11Z",
        "effect": "read",
        "id": "mc_01JC3..._17",
        "idempotency_key": "string",
        "name": "string"
      }
    ],
    "type": "string"
  }
}
```

**SDK Code**

```python
import requests

url = "https://your-org.cloudraker.run/v2/machines/runs/id/cancel"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://your-org.cloudraker.run/v2/machines/runs/id/cancel';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://your-org.cloudraker.run/v2/machines/runs/id/cancel"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://your-org.cloudraker.run/v2/machines/runs/id/cancel")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://your-org.cloudraker.run/v2/machines/runs/id/cancel")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-org.cloudraker.run/v2/machines/runs/id/cancel', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://your-org.cloudraker.run/v2/machines/runs/id/cancel");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://your-org.cloudraker.run/v2/machines/runs/id/cancel")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```