Read the conversation's goal
The latest goal in this conversation with its status, progress and budget; null when none was created.
GET
/api/agent/sessions/{sessionId}/goalPath parameters
sessionIdstringrequiredRequest
curl
curl -X GET https://trickest.io/api/agent/sessions/{sessionId}/goal \
-H "Authorization: Token $TRICKEST_TOKEN"Responses
200The goal or null
goalobjectrequiredidstringrequiredsessionIdstringrequiredcomputerIdstringrequiredobjectivestringrequiredacceptancestring[]requiredstatusenumrequiredOne of: active, paused, blocked, completed, cancelled
revisionintegerrequiredroundsintegerrequiredusedTokensintegerrequiredcheckpointstringrequiredevidenceobject[]requiredcriterionintegerrequiredevidencestringrequiredreasonstringrequiredpendingControlenumOne of: pause, cancel
createdAtstringrequiredupdatedAtstringrequired400Bad 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.