Cancel an active run

POST

api

runs

{runId}

cancel

Cancel an active run

curl --request POST \
  --url https://api.vyomflow.co.in/api/v1/runs/{runId}/cancel \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vyomflow.co.in/api/v1/runs/{runId}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vyomflow.co.in/api/v1/runs/{runId}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.vyomflow.co.in/api/v1/runs/{runId}/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(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.vyomflow.co.in/api/v1/runs/{runId}/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

{
  "id": "<string>",
  "chatId": "<string>",
  "status": "queued",
  "userMessageId": "<string>",
  "assistantMessageId": "<string>",
  "lastStreamIndex": 123,
  "cancelRequestedAt": "<string>",
  "requestedModel": "<string>",
  "resolvedModel": "<string>",
  "errorCode": "<string>",
  "errorMessage": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "startedAt": "<string>",
  "finishedAt": "<string>",
  "toolInvocations": [
    {
      "id": "<string>",
      "agentRunId": "<string>",
      "turnIndex": 1,
      "callIndex": 1,
      "toolCallId": "<string>",
      "name": "<string>",
      "nodeType": "<string>",
      "input": {},
      "status": "DISPATCHING",
      "creditEstimate": 1,
      "creditUsed": 1,
      "resultUrls": [
        "<string>"
      ],
      "errorCode": "<string>",
      "errorMessage": "<string>",
      "startedAt": "<string>",
      "finishedAt": "<string>",
      "durationMs": 1,
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "totalCreditsUsed": 1,
  "pendingWaitpoint": {
    "id": "<string>",
    "agentRunId": "<string>",
    "kind": "CREDIT_APPROVAL",
    "status": "PENDING",
    "requestPayload": {
      "toolName": "<string>",
      "estimatedCredits": 1,
      "threshold": 1
    },
    "resolvedPayload": {
      "approved": true,
      "respondedAt": "<string>"
    },
    "expiresAt": "<string>",
    "resolvedAt": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Authorizations

Authorization

string

header

required

Clerk session token, Authorization: Bearer <token> — the first-party browser app's own auth. Used only by this internal /api/v1/* surface, never by /api/public/v1/*.

Path Parameters

runId

string

required

Minimum string length: 1

Response

Run cancelled.

string

required

chatId

string

required

status

enum<string>

required

Available options:

queued,

running,

waiting,

completed,

failed,

cancelled

userMessageId

string

required

assistantMessageId

string | null

required

lastStreamIndex

integer

required

cancelRequestedAt

string | null

required

requestedModel

string

required

resolvedModel

string | null

required

errorCode

string | null

required

errorMessage

string | null

required

createdAt

string

required

updatedAt

string

required

startedAt

string | null

required

finishedAt

string | null

required

toolInvocations

object[]

required

Show child attributes

totalCreditsUsed

number

required

Required range: x >= 0

pendingWaitpoint

object

required

Option 1
Option 2

Show child attributes

⌘I

Cancel an active run

curl --request POST \
  --url https://api.vyomflow.co.in/api/v1/runs/{runId}/cancel \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vyomflow.co.in/api/v1/runs/{runId}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vyomflow.co.in/api/v1/runs/{runId}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.vyomflow.co.in/api/v1/runs/{runId}/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(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.vyomflow.co.in/api/v1/runs/{runId}/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

{
  "id": "<string>",
  "chatId": "<string>",
  "status": "queued",
  "userMessageId": "<string>",
  "assistantMessageId": "<string>",
  "lastStreamIndex": 123,
  "cancelRequestedAt": "<string>",
  "requestedModel": "<string>",
  "resolvedModel": "<string>",
  "errorCode": "<string>",
  "errorMessage": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "startedAt": "<string>",
  "finishedAt": "<string>",
  "toolInvocations": [
    {
      "id": "<string>",
      "agentRunId": "<string>",
      "turnIndex": 1,
      "callIndex": 1,
      "toolCallId": "<string>",
      "name": "<string>",
      "nodeType": "<string>",
      "input": {},
      "status": "DISPATCHING",
      "creditEstimate": 1,
      "creditUsed": 1,
      "resultUrls": [
        "<string>"
      ],
      "errorCode": "<string>",
      "errorMessage": "<string>",
      "startedAt": "<string>",
      "finishedAt": "<string>",
      "durationMs": 1,
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "totalCreditsUsed": 1,
  "pendingWaitpoint": {
    "id": "<string>",
    "agentRunId": "<string>",
    "kind": "CREDIT_APPROVAL",
    "status": "PENDING",
    "requestPayload": {
      "toolName": "<string>",
      "estimatedCredits": 1,
      "threshold": 1
    },
    "resolvedPayload": {
      "approved": true,
      "respondedAt": "<string>"
    },
    "expiresAt": "<string>",
    "resolvedAt": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Overview

Endpoints

Authorizations

Path Parameters

Response