HITL Approval Gate

POST/v1/agents/reviews/{reviewId}/submit

Base URL *

Your instance endpoint, shown on the instance page in the dashboard. Each instance has its own host; there is no shared API host.

Authorization (Bearer token)

reviewId (path) *

Request Body (JSON)

Parameters

Name	In	Type	Required	Description
`reviewId`	path	`string`	Yes

Request Body

Property	Type	Required	Description
`tenantId`	`string`	No
`action`	`"APPROVAL_ACTION_UNSPECIFIED" \| "APPROVAL_ACTION_APPROVE" \| "APPROVAL_ACTION_DENY"`	No	ApprovalAction is the action to take on a review.
`decisions`	`object[]`	No
`reason`	`string`	No
`resolvedBy`	`string`	No

Responses

200 Submit a review decision for a pending approval

Property	Type	Description
`accepted`	`boolean`
`message`	`string`
`review`	`object`	ApprovalReview represents a HITL approval review for tool calls. V1 is single-instance; multi-instance via Redis pub/sub is v2.

default An unexpected error response.

Property	Type	Description
`code`	`integer`
`message`	`string`
`details`	`object[]`

Request

curl -X POST "http://localhost:8089/v1/agents/reviews/{reviewId}/submit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tenantId":"string","action":"APPROVAL_ACTION_UNSPECIFIED","decisions":[{"toolCallId":"string","action":"APPROVAL_ACTION_UNSPECIFIED","reason":"string"}],"reason":"string","resolvedBy":"string"}'

const response = await fetch("http://localhost:8089/v1/agents/reviews/{reviewId}/submit", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "tenantId": "string",
  "action": "APPROVAL_ACTION_UNSPECIFIED",
  "decisions": [
    {
      "toolCallId": "string",
      "action": "APPROVAL_ACTION_UNSPECIFIED",
      "reason": "string"
    }
  ],
  "reason": "string",
  "resolvedBy": "string"
}),
});
const data = await response.json();

import requests

response = requests.post(
    "http://localhost:8089/v1/agents/reviews/{reviewId}/submit",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
  "tenantId": "string",
  "action": "APPROVAL_ACTION_UNSPECIFIED",
  "decisions": [
    {
      "toolCallId": "string",
      "action": "APPROVAL_ACTION_UNSPECIFIED",
      "reason": "string"
    }
  ],
  "reason": "string",
  "resolvedBy": "string"
},
)
data = response.json()

Response

{
  "accepted": true,
  "message": "string",
  "review": {
    "id": "string",
    "sessionId": "string",
    "tenantId": "string",
    "agentId": "string",
    "turnNumber": 0,
    "iteration": 0,
    "status": "APPROVAL_REVIEW_STATUS_UNSPECIFIED",
    "toolCalls": [
      {
        "toolCallId": "string",
        "toolName": "string",
        "toolArgs": "string"
      }
    ],
    "decisions": [
      {
        "toolCallId": "string",
        "action": "APPROVAL_ACTION_UNSPECIFIED",
        "reason": "string"
      }
    ],
    "defaultAction": "string",
    "requestedAt": "2024-01-01T00:00:00Z",
    "expiresAt": "2024-01-01T00:00:00Z",
    "resolvedAt": "2024-01-01T00:00:00Z",
    "resolvedBy": "string",
    "resolutionReason": "string"
  }
}

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}