Pause, resume or cancel the conversation's goal

Pause and cancel stop the current round at its next safe point. Resume requires current Enterprise access and refreshes the execution credential. With extend, it raises reached limits up to the maximum. revision must match the goal the user saw.

POST/api/agent/sessions/{sessionId}/goal

Path parameters

sessionIdstringrequired

Body

actionenumrequired

One of: pause, resume, cancel

goalIdstring

revisionintegerrequired

Request

curl

curl -X POST https://trickest.io/api/agent/sessions/{sessionId}/goal \
  -H "Authorization: Token $TRICKEST_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ }'

Responses

200The updated goal

idstringrequired

sessionIdstringrequired

computerIdstringrequired

objectivestringrequired

acceptancestring[]required

statusenumrequired

One of: active, paused, blocked, completed, cancelled

revisionintegerrequired

roundsintegerrequired

usedTokensintegerrequired

checkpointstringrequired

evidenceobject[]required

criterionintegerrequired

evidencestringrequired

reasonstringrequired

pendingControlenum

One of: pause, cancel

createdAtstringrequired

updatedAtstringrequired

400Bad Request – validation error or malformed input

codestringrequired

messagestringrequired

detailsobject