View, control, or release a goal desktop

View, control, or release a goal desktop

Owner-only short-lived native capability. Taking control requires a paused goal and every computer drained. Release keeps the goal paused. No action resumes execution.

POST/api/agent/sessions/{sessionId}/goal/desktop
Path parameters
sessionIdstringrequired
Body

Request

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

Responses

200Goal and ephemeral desktop lease
goalobjectrequired

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
viewerobjectrequired

urlstringrequired
expiresAtintegerrequired
controlbooleanrequired
receiptobject

idstringrequired
revisionintegerrequired
400Bad Request – validation error or malformed input
codestringrequired
messagestringrequired
detailsobject

Field-level detail when the error is a validation failure.

401Unauthorized – missing or expired token
codestringrequired
messagestringrequired
detailsobject

Field-level detail when the error is a validation failure.

403Forbidden – insufficient permissions
codestringrequired
messagestringrequired
detailsobject

Field-level detail when the error is a validation failure.

429Too Many Requests – rate limited
codestringrequired
messagestringrequired
detailsobject

Field-level detail when the error is a validation failure.

500Internal Server Error
codestringrequired
messagestringrequired
detailsobject

Field-level detail when the error is a validation failure.