# Request cancellation for a durable operation

POST https://api.bctrl.ai/v1/operations/{id}/cancel

Reference: https://platform.bctrl.ai/api/api-reference/operations/cancel

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: bctrl API
  version: 1.0.0
paths:
  /v1/operations/{id}/cancel:
    post:
      operationId: cancel
      summary: Request cancellation for a durable operation
      tags:
        - subpackage_operations
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: Use Bearer <api-key>.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/operations_cancel_Response_200'
servers:
  - url: https://api.bctrl.ai
  - url: http://localhost:8787
components:
  schemas:
    V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaError:
      type: object
      properties:
        code:
          type: string
        details:
          type: object
          additionalProperties:
            description: Any type
        message:
          type: string
      required:
        - message
      title: V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaError
    V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaProgress:
      type: object
      properties:
        currentCall:
          type: string
        lastEventType:
          type: string
        message:
          type: string
        step:
          type: integer
        totalSteps:
          type: integer
      title: V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaProgress
    V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultMode:
      type: string
      enum:
        - fail-fast
      title: V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultMode
    V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItemsOneOf0BindingType:
      type: string
      enum:
        - page
        - context
        - handle
        - subscription
      title: >-
        V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItemsOneOf0BindingType
    V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItemsOneOf0Binding:
      type: object
      properties:
        alias:
          type: string
        id:
          type: string
        type:
          $ref: >-
            #/components/schemas/V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItemsOneOf0BindingType
      required:
        - alias
        - id
        - type
      title: >-
        V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItemsOneOf0Binding
    V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItemsOneOf0Resolved:
      type: object
      properties:
        call:
          type: string
        contextId:
          type:
            - string
            - 'null'
        handleId:
          type:
            - string
            - 'null'
        method:
          type: string
        pageId:
          type:
            - string
            - 'null'
        ref:
          type:
            - string
            - 'null'
        sessionId:
          type: string
        target:
          type: string
      required:
        - call
        - contextId
        - handleId
        - method
        - pageId
        - ref
        - sessionId
        - target
      title: >-
        V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItemsOneOf0Resolved
    V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItems0:
      type: object
      properties:
        binding:
          $ref: >-
            #/components/schemas/V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItemsOneOf0Binding
        call:
          type: string
        index:
          type: integer
        ok:
          type: boolean
        resolved:
          $ref: >-
            #/components/schemas/V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItemsOneOf0Resolved
        result:
          description: Any type
      required:
        - call
        - index
        - ok
        - resolved
        - result
      title: >-
        V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItems0
    V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1ErrorCode:
      type: string
      enum:
        - UNKNOWN_CALL
        - UNKNOWN_REF
        - INVALID_ARGS
        - CAPABILITY_NOT_AVAILABLE
        - TIMEOUT
        - SESSION_NOT_FOUND
        - DRIVER_NOT_CONNECTED
        - SUBSCRIPTION_CURSOR_CONFLICT
        - SUBSCRIPTION_GONE
      title: >-
        V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1ErrorCode
    V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1ErrorDiagnosticCategory:
      type: string
      enum:
        - arg-shape
        - semantic
        - runtime
      title: >-
        V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1ErrorDiagnosticCategory
    V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1ErrorDiagnosticFixesItems:
      type: object
      properties:
        command:
          type: string
        example:
          type: string
        title:
          type: string
      required:
        - title
      title: >-
        V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1ErrorDiagnosticFixesItems
    V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1ErrorDiagnostic:
      type: object
      properties:
        call:
          type: string
        category:
          $ref: >-
            #/components/schemas/V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1ErrorDiagnosticCategory
        closest:
          type: array
          items:
            type: string
        code:
          type: string
        docsUrl:
          type: string
          format: uri
        driver:
          type: string
        expected:
          type: string
        fixes:
          type: array
          items:
            $ref: >-
              #/components/schemas/V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1ErrorDiagnosticFixesItems
        id:
          type: string
        received:
          type: string
      required:
        - id
      title: >-
        V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1ErrorDiagnostic
    V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1Error:
      type: object
      properties:
        code:
          $ref: >-
            #/components/schemas/V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1ErrorCode
        diagnostic:
          $ref: >-
            #/components/schemas/V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1ErrorDiagnostic
        hint:
          type: string
        message:
          type: string
      required:
        - code
        - message
      title: >-
        V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1Error
    V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItems1:
      type: object
      properties:
        call:
          type: string
        error:
          $ref: >-
            #/components/schemas/V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1Error
        index:
          type: integer
        ok:
          type: boolean
      required:
        - call
        - error
        - index
        - ok
      title: >-
        V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItems1
    V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItems:
      oneOf:
        - $ref: >-
            #/components/schemas/V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItems0
        - $ref: >-
            #/components/schemas/V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItems1
      title: >-
        V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItems
    V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResult:
      type: object
      properties:
        mode:
          $ref: >-
            #/components/schemas/V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultMode
        ok:
          type: boolean
        runtime:
          type: string
        steps:
          type: array
          items:
            $ref: >-
              #/components/schemas/V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResultStepsItems
      required:
        - mode
        - ok
        - runtime
        - steps
      title: V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResult
    V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaRuntimeKind:
      type: string
      enum:
        - browser
        - desktop
        - spreadsheet
      title: V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaRuntimeKind
    V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaStatus:
      type: string
      enum:
        - queued
        - dispatching
        - running
        - cancelling
        - succeeded
        - failed
        - cancelled
        - timed_out
      title: V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaStatus
    operations_cancel_Response_200:
      type: object
      properties:
        cancelRequestedAt:
          type:
            - string
            - 'null'
        createdAt:
          type: string
        currentCall:
          type:
            - string
            - 'null'
        error:
          oneOf:
            - $ref: >-
                #/components/schemas/V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaError
            - type: 'null'
        finishedAt:
          type:
            - string
            - 'null'
        id:
          type: string
          format: uuid
        lastHeartbeatAt:
          type:
            - string
            - 'null'
        progress:
          oneOf:
            - $ref: >-
                #/components/schemas/V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaProgress
            - type: 'null'
        result:
          oneOf:
            - $ref: >-
                #/components/schemas/V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaResult
            - type: 'null'
        runtime:
          type: string
        runtimeId:
          type: string
          format: uuid
        runtimeKind:
          $ref: >-
            #/components/schemas/V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaRuntimeKind
        startedAt:
          type:
            - string
            - 'null'
        status:
          $ref: >-
            #/components/schemas/V1OperationsIdCancelPostResponsesContentApplicationJsonSchemaStatus
        workspaceId:
          type: string
          format: uuid
      required:
        - createdAt
        - id
        - runtime
        - runtimeId
        - runtimeKind
        - status
        - workspaceId
      title: operations_cancel_Response_200
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Use Bearer <api-key>.

```

## SDK Code Examples

```python
import requests

url = "https://api.bctrl.ai/v1/operations/id/cancel"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.bctrl.ai/v1/operations/id/cancel';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bctrl.ai/v1/operations/id/cancel"

	payload := strings.NewReader("{}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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://api.bctrl.ai/v1/operations/id/cancel")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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://api.bctrl.ai/v1/operations/id/cancel")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.bctrl.ai/v1/operations/id/cancel', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.bctrl.ai/v1/operations/id/cancel");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.bctrl.ai/v1/operations/id/cancel")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```