Agents
Set a chat API's Decision gate
Admits a turn over protocol only when the Decision chain matches; a negative answer refuses it with 422 declined, and a turn whose evaluation is unavailable is admitted. gate: null admits every turn. Refusals carry code DECISION_NOT_FOUND (404) or, when a connected daemon serving the agent cannot run the gate, DECISION_UNSUPPORTED_CONSUMER (409).
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
orgId*string
agentId*string
Match
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidprotocol*string
Value in
- "ai-sdk-ui"
- "ag-ui"
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/v1/orgs/string/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/api/ai-sdk-ui/gate" \ -H "Content-Type: application/json" \ -d '{ "gate": { "decisionId": "string", "when": { "type": "choice", "thresholds": { "property1": 0, "property2": 0 } }, "type": "gate" } }'{ "protocol": "ai-sdk-ui", "createdBy": "string", "createdAt": "2019-08-24T14:15:22Z", "gate": { "decisionId": "string", "when": { "type": "choice", "thresholds": { "property1": 0, "property2": 0 } }, "nextStepId": "string", "elseStepId": "string", "type": "gate", "steps": [ { "decisionId": "string", "when": { "type": "choice", "thresholds": { "property1": 0, "property2": 0 } }, "nextStepId": "string", "elseStepId": "string", "id": "string" } ] }}