Invoke Skill Workstream Cancel
post
/api/v1/skills/workstream.cancel/invokeCancel a running workstream run. The run terminates; you'll need to start a fresh one if you want to retry. Reason is recorded to the audit trail and shown in Studio.
Request bodyapplication/json
| Field | Type | Description |
|---|---|---|
cycle_idrequired | string (uuid) | The cycle to cancel. Identified by `cycle_id` from `workstream_run`. |
reason | string | null | Audit trail. Strongly recommended. |
idempotency_key | string | null | Caller-supplied stable token. Replaying within 24h returns the same cancellation result rather than erroring on the already-cancelled cycle. |
Responses
200Skill executed successfully
| Field | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
skillrequired | string | — | ||||||||||||||||||||||||
outputrequired | object | Cycle state after cancellation.show nested
| ||||||||||||||||||||||||
correlation_idrequired | string | — |
401Authentication required
| Field | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorrequired | object | —show nested
|
403Insufficient permissions
| Field | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorrequired | object | —show nested
|
404Skill not found
| Field | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorrequired | object | —show nested
|
429Rate limit exceeded
| Field | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorrequired | object | —show nested
|
5XXInternal server error
| Field | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorrequired | object | —show nested
|
curl https://api.dev.arch.ie/api/v1/skills/workstream.cancel/invoke \
-X POST \
-H "Authorization: Bearer sk_..." \
-H "Content-Type: application/json" \
-d '{
"cycle_id": "00000000-0000-0000-0000-000000000000",
"reason": null,
"idempotency_key": null
}'