VocalDocscontracts 1.65.0

Read what an Agent version's activation would meet at the publish gate

GET /v1/agents/{agent_id}/versions/{version}/evaluation-gate

PropertyValue
Operationget_agent_version_gate
GroupAgent versions
Scopeagents:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: A metadata read; a gate outcome holds ids, codes and counts only.
Released in1.64.0
Phase 0 hostServed (the hosted api pins 1.65.0)

Answers what the publish gate would decide for an activation of the version now (1.64.0): the Agent's gating suite, the latest completed run of that suite on the version and its gate outcome, whether activate_agent_version would pass the gate, and the EvaluationGateReason of each detail it would be refused with, in order (run_required, run_stale, a failed check). An Agent whose owner has not turned the gate on answers passes: true with no suite. It writes nothing and reads no Call content, so it is not audited. Whether the version is retired is the activation's own check. A version of another Organization's Agent answers not_found.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the agents:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/agents/agt_.../versions/1/evaluation-gate" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Parameters

NameInTypeRequiredDescription
agent_idpathAgentIdyesThe id of an Agent: agt_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
versionpathintegeryesA version number, from 1.

Responses

StatusContent typeShapeError codes
200application/jsonAgentVersionGate
400application/jsonErrorEnvelopeinvalid_request
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
404application/jsonErrorEnvelopenot_found
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is AgentVersionGate.

FieldTypeRequiredDescription
agent_idAgentIdyes
checked_atTimestampyes
object"agent_version_gate"yes
outcomePromptEvalGateOutcome or nullyesThat run's gate outcome, whose suite_revision tells whether it is current; null with no run.
passesbooleanyesWhether an activation of the version now would pass the gate; true with no gate.
reasonsarray of EvaluationGateReasonyesThe reason of each detail an activation would be refused with, in order; empty when it passes.
run_idPromptEvalRunId or nullyesThe latest completed run of the gating suite on the version, at any revision; null when there is none or no gate.
suite_idPromptEvalSuiteId or nullyesThe Agent's gating suite; null when the owner has not turned the gate on.
versionintegeryes