Skip to main content
POST
/
v1
/
chat
/
{session_id}
/
approve
Approve or deny AI-proposed document changes one-by-one or in batch (HITL workflow).
curl --request POST \
  --url https://api.example.com/v1/chat/{session_id}/approve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "job_id": "<string>",
  "approved": true,
  "change_id": "<string>",
  "feedback": "<string>",
  "changes": [
    {}
  ]
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
authorization
string | null

Path Parameters

​
session_id
string
required

Body

application/json

Approve or deny proposed AI document changes.

​
job_id
string
required

Job ID that is awaiting approval.

​
approved
boolean
required

Whether to approve (true) or deny (false) the change.

​
change_id
string | null

Specific change to approve/deny (for individual decisions). Get change IDs from the job's pending_changes.

​
feedback
string | null

Optional feedback explaining why a change was denied. Helps the AI adjust future suggestions.

​
changes
Changes · object[] | null

Batch decisions: array of {change_id, approved, feedback} objects. Use for 'Accept All' or 'Deny All'.

Response

Successful Response