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

Invoke Skill Workstream Advance

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

Advance a paused or awaiting-approval workstream run β€” approve a task, skip a step, pause, or resume. This is the supervisory surface; for starting a new run use workstream_run, for cancelling use workstream_cancel.

Request bodyapplication/json

FieldTypeDescription
cycle_idrequiredstring (uuid)The cycle to advance.
actionrequired"approve_task" | "skip_step" | "pause" | "resume"What to do: - `approve_task`: mark the task in `task_id` approved; the run moves on. - `skip_step`: skip the current step. - `pause`: halt the run in-place. - `resume`: continue a previously paused run.
approve_taskskip_steppauseresume
task_idstring (uuid) | nullRequired for `approve_task`. The task being approved.
reasonstring | nullAudit trail. Recommended for skip_step.
idempotency_keystring | nullCaller-supplied stable token. Replaying within 24h returns the same outcome rather than re-applying the action.

Responses

200Skill executed successfully
FieldTypeDescription
skillrequiredstringβ€”
outputrequiredobjectCycle state after the action lands.
show nested
FieldTypeDescription
stub_fieldsstring[]β€”
warningsstring[]β€”
cycle_idstring (uuid) | nullThe cycle the action was applied to.
run_idstring (uuid) | nullβ€”
status"running" | "paused" | "awaiting_approval" | "completed" | "cancelled" | "failed"Lifecycle state after the action.
runningpausedawaiting_approvalcompletedcancelledfailed
current_stepstringSlug of the currently-executing step.
next_stepstring | nullSlug of the next step (None on terminal states).
errorstring | nullβ€”
error_envelopeany | nullCanonical structured error. Populated when the action could not be applied.
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.advance/invoke \
  -X POST \
  -H "Authorization: Bearer sk_..." \
  -H "Content-Type: application/json" \
  -d '{
       "cycle_id": "00000000-0000-0000-0000-000000000000",
       "action": "approve_task",
       "task_id": null,
       "reason": null,
       "idempotency_key": null
     }'