Skip to main content
POST
/
v1
/
workflows
/
{workflow_id}
/
experiments
/
{experiment_id}
/
cancel
from retab import Retab

client = Retab()

result = client.workflows.experiments.cancel(
    workflow_id="wf_abc123",
    experiment_id="exp_abc",
)
print(result["status"], result["run_id"])

{ "status": "cancelled", "run_id": "exprun_1" }

Documentation Index

Fetch the complete documentation index at: https://docs.retab.com/llms.txt

Use this file to discover all available pages before exploring further.

Cancel the latest pending or running experiment run. Returns 404 if no in-flight run exists. Useful before Delete Experiment, which fails with 409 while a run is in progress. 
from retab import Retab

client = Retab()

result = client.workflows.experiments.cancel(
    workflow_id="wf_abc123",
    experiment_id="exp_abc",
)
print(result["status"], result["run_id"])

{ "status": "cancelled", "run_id": "exprun_1" }

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
workflow_id
string
required
​
experiment_id
string
required

Query Parameters

​
access_token
string | null

Response

Successful Response

​
{key}
string