Tasks

Request pause, resume, or stop for one task. Delivery is not execution acknowledgement.

patch/tasks/{taskId}/control

Request

  • Base URL: https://api.ziggsai.com
  • URL: https://api.ziggsai.com/tasks/{taskId}/control
  • Auth: HTTP bearer

Path parameters

taskIdstring required

Request body

action'pause' | 'resume' | 'stop' required
requestIdstring uuid required

Unique request id; reuse on retries.

previousRequestIdstring nullable required

Current control.requestId, or null on the first request. Prevents a stale request from overriding newer intent.

Response

OK

oktrue required
statusstring required
taskIdstring required
agreementIdstring
statestring
updatedAtstring date-time
resultRecordedboolean
terminalStatestring
effectsobject
acquiredboolean
processingboolean
lockReasonstring
planAcknowledgedboolean
patchedCountnumber
stepCountnumber
structureChangedboolean
waitingOnobject

Changes

No recorded changes to this operation across all 1 revision of this API.