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/desktopPath parameters
sessionIdstringrequiredBody
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
goalobjectrequiredidstringrequiredsessionIdstringrequiredcomputerIdstringrequiredobjectivestringrequiredacceptancestring[]requiredstatusenumrequiredOne of: active, paused, blocked, completed, cancelled
revisionintegerrequiredroundsintegerrequiredusedTokensintegerrequiredcheckpointstringrequiredevidenceobject[]requiredcriterionintegerrequiredevidencestringrequiredreasonstringrequiredpendingControlenumOne of: pause, cancel
createdAtstringrequiredupdatedAtstringrequiredviewerobjectrequiredurlstringrequiredexpiresAtintegerrequiredcontrolbooleanrequiredreceiptobjectidstringrequiredrevisionintegerrequired400Bad Request – validation error or malformed input
codestringrequiredmessagestringrequireddetailsobjectField-level detail when the error is a validation failure.
401Unauthorized – missing or expired token
codestringrequiredmessagestringrequireddetailsobjectField-level detail when the error is a validation failure.
403Forbidden – insufficient permissions
codestringrequiredmessagestringrequireddetailsobjectField-level detail when the error is a validation failure.
429Too Many Requests – rate limited
codestringrequiredmessagestringrequireddetailsobjectField-level detail when the error is a validation failure.
500Internal Server Error
codestringrequiredmessagestringrequireddetailsobjectField-level detail when the error is a validation failure.