Cancel an execution

/v1/workflows/executions/{id}/cancel

Writes the SharedMemory cancel marker the engine and agent loops poll at their next turn/tool boundary, and stamps the row cancelled. Wrong owner → 404 (no existence leak); not running → 409. Since /v1/workflows/execute is synchronous, pass your own x-trace-id on the execute call and use it as {id} here.

Authorization: send Authorization: Bearer $PLUNGE_API_KEY; X-API-Key: <ozk_ key> is accepted as an alternative.

Authorizations

Authorizationstringheaderrequired

Bearer token: Authorization: Bearer ozk_…. ozk_ platform API key (Authorization: Bearer ozk_…)

Path parameters

idstringrequired

Response

Cancelled

application/json

successboolean

cancelledstring

The execution id

markersstring[]

Run ids the cancel marker was written under (row id + engine cln id)

Missing, invalid, expired or revoked ozk_ key.

Error code: unauthorizedfrom code

not_found — no such execution for this key

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

not_running — the execution already finished or was cancelled

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

Per-key rate limit reached; honour Retry-After.

Error code: rate_limitedfrom code

import os import requests response = requests.post( "https://api.plungeai.com/v1/workflows/executions/{id}/cancel", headers={"Authorization": f"Bearer {os.environ['PLUNGE_API_KEY']}"}, ) if not response.ok: raise SystemExit(f"{response.status_code} {response.headers.get('X-Error-Code')}") print(response.json())

const response = await fetch('https://api.plungeai.com/v1/workflows/executions/{id}/cancel', { method: 'POST', headers: { Authorization: `Bearer ${process.env.PLUNGE_API_KEY}`, }, }) if (!response.ok) throw new Error(`${response.status} ${response.headers.get('X-Error-Code')}`) console.log(await response.json())

import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; public class Main { public static void main(String[] args) throws Exception { HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.plungeai.com/v1/workflows/executions/{id}/cancel")) .header("Authorization", "Bearer " + System.getenv("PLUNGE_API_KEY")) .POST(HttpRequest.BodyPublishers.noBody()) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); if (response.statusCode() >= 400) { System.out.println(response.statusCode() + " " + response.headers().firstValue("X-Error-Code").orElse("")); return; } System.out.println(response.body()); } }

Cancel an execution

Authorizations

Path parameters

Response

Planned: TI-33

Planned: TI-34