Skip to main content
Workflows

Request cancellation of the client's own non-terminal workflow invocation

POST /agent-execution/workflows/runs/{uid}/cancel

Contract

Cancellation is available only when the original workflow-specific grant permits it and does not reverse external side effects already governed by their systems of record.

Authentication
Bearer credential required
Required scope
agent:execution:invoke
Status
Published

Parameters

Name Location Type Required Description
uid path string Yes

Code examples

These examples compose a request only. Public reference pages never transmit your credential or execute the operation.

curl

curl -X POST \
  -H "Authorization: Bearer $FINANCEGPT_API_KEY" \
  -H "Accept: application/json"
  "https://financegpt.dev/api/v2/agent-execution/workflows/runs/{uid}/cancel"

javascript

const response = await fetch("https:\/\/financegpt.dev\/api\/v2\/agent-execution\/workflows\/runs\/{uid}\/cancel", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${FINANCEGPT_API_KEY}`,
    Accept: 'application/json',
  },
});
const data = await response.json();

python

import json
import os
import requests

response = requests.request(
    'POST',
    'https://financegpt.dev/api/v2/agent-execution/workflows/runs/{uid}/cancel',
    headers={
        'Authorization': 'Bearer ' + os.environ['FINANCEGPT_API_KEY'],
        'Accept': 'application/json',
    },
)
response.raise_for_status()
print(response.json())

php

<?php
$ch = curl_init('https://financegpt.dev/api/v2/agent-execution/workflows/runs/{uid}/cancel');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer '.getenv('FINANCEGPT_API_KEY'),
        'Accept: application/json',
    ],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Responses

Status Description
202 Cancellation requested
422 Cancellation outside grant or run state

Authority boundary

A developer credential proves application identity and permits only its scopes. It does not grant model promotion, policy override, QLM rebinding, or Financial Actions execution authority unless those separate controls are satisfied.

agent:execution:invoke

Machine-readable sources