v1

latestOpenAPI 3.0.12026-07-266184114.0 KB

Fax AI

Trigger fax field extraction

Trigger AI field extraction for a fax. Extracts structured data fields from the fax content. If extraction is already finished, returns the existing result. Consumes AI credits. (Permitted scopes: fax:all:edit, fax:ai:edit)

post/accounts/{user_id}/faxes/{fax_id}/ai/field-extraction

Path parameters

user_idstring required

User ID. Use 'self' for your own account, or provide a specific user ID for corporate member accounts.

fax_idstring required

The unique identifier of the fax

Response

Response containing field extraction status and result

status'not_requested' | 'pending' | 'finished' | 'failed' | 'content_filtering_policy' required

Field extraction processing status

dataobject nullable

Extracted fields as key-value pairs. Null when status is not finished

Example response

{
  "status": "finished",
  "data": {
    "sender_name": "John Doe",
    "sender_company": "Acme Corp",
    "date": "2026-01-15",
    "reference_number": "INV-2026-001"
  }
}