Read the conversation's goal

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}/goal
Path parameters
sessionIdstringrequired

Request

curl
curl -X GET https://trickest.io/api/agent/sessions/{sessionId}/goal \
  -H "Authorization: Token $TRICKEST_TOKEN"

Responses

200The goal or null
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
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.