v1
mcp
approval

Approve or deny AI-proposed document changes one-by-one or in batch (HITL workflow).

Used with chat_async when approval_mode='ask_every_time'. For each proposed change (with chunk_id and HTML diff), respond approved=true|false plus optional feedback for the AI to revise on. Approved changes apply atomically; denied changes are discarded; the AI may revise based on feedback in the next turn. Required for regulated workflows (legal, medical, compliance) where every AI edit must be reviewed before it touches the document. For single changes: set approved=true/false and optionally provide feedback. For batch decisions: provide a 'changes' array with per-change decisions. After approval, the job resumes processing and eventually reaches status=completed.

post/v1/chat/{session_id}/approve

Request

  • Base URL: https://api.superdocs.app
  • URL: https://api.superdocs.app/v1/chat/{session_id}/approve
  • Auth: HTTP bearer

Path parameters

session_idstring required

Headers

authorizationstring nullable

Request body

job_idstring required

Job ID that is awaiting approval.

change_idstring nullable

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

approvedboolean required

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

feedbackstring nullable

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

changesobject[] nullable

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

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.