Operating system set to macOS
Documentation jurisdiction set to United States
Sign inConnect Claude

Invoke Skill Workstream Delete

post/api/v1/skills/workstream.delete/invoke

Delete a workstream β€” a guarded soft-delete (status='deleted'); it disappears from listings but the row is retained. REFUSES if the workstream has any non-terminal (running/paused/queued) cycle, and requires an explicit confirm=true. In-flight cycles are unaffected.

Request bodyapplication/json

FieldTypeDescription
workstream_idrequiredstringWorkstream UUID, slug, or 7-char permakey to delete
confirmbooleanExplicit confirmation. Must be true to proceed β€” a delete with confirm=false is refused (error='confirmation_required'), so an accidental call is a safe no-op.

Responses

200Skill executed successfully
FieldTypeDescription
skillrequiredstringβ€”
outputrequiredobjectβ€”
show nested
FieldTypeDescription
stub_fieldsstring[]β€”
warningsstring[]β€”
workstream_idstringThe deleted workstream's permakey (the public id).
deletedbooleanTrue when the workstream was soft-deleted.
statusstringThe workstream's status after the call (e.g. 'deleted').
errorstring | nullmissing_workspace | not_found | confirmation_required | has_active_cycles on failure, else null
correlation_idrequiredstringβ€”
401Authentication required
FieldTypeDescription
errorrequiredobjectβ€”
show nested
FieldTypeDescription
typerequiredstringβ€”
coderequiredstringβ€”
messagerequiredstringβ€”
paramstringβ€”
retry_after_secondsintegerβ€”
403Insufficient permissions
FieldTypeDescription
errorrequiredobjectβ€”
show nested
FieldTypeDescription
typerequiredstringβ€”
coderequiredstringβ€”
messagerequiredstringβ€”
paramstringβ€”
retry_after_secondsintegerβ€”
404Skill not found
FieldTypeDescription
errorrequiredobjectβ€”
show nested
FieldTypeDescription
typerequiredstringβ€”
coderequiredstringβ€”
messagerequiredstringβ€”
paramstringβ€”
retry_after_secondsintegerβ€”
429Rate limit exceeded
FieldTypeDescription
errorrequiredobjectβ€”
show nested
FieldTypeDescription
typerequiredstringβ€”
coderequiredstringβ€”
messagerequiredstringβ€”
paramstringβ€”
retry_after_secondsintegerβ€”
5XXInternal server error
FieldTypeDescription
errorrequiredobjectβ€”
show nested
FieldTypeDescription
typerequiredstringβ€”
coderequiredstringβ€”
messagerequiredstringβ€”
paramstringβ€”
retry_after_secondsintegerβ€”
curl https://api.dev.arch.ie/api/v1/skills/workstream.delete/invoke \
  -X POST \
  -H "Authorization: Bearer sk_..." \
  -H "Content-Type: application/json" \
  -d '{
       "workstream_id": "string",
       "confirm": false
     }'