FAfax
Fax AI

Trigger fax OCR

Trigger OCR processing for a fax. If OCR 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/ocr

Request

  • Base URL
    https://restapi.fax.plus/v3
  • URL
    https://restapi.fax.plus/v3/accounts/{user_id}/faxes/{fax_id}/ai/ocr
  • Auth
    • OAuth 2
      Authorization code: https://accounts.fax.plus/login?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=http://localhost&scope=all
      Token URL: https://accounts.fax.plus/token scopes: all
    • or HTTP bearer

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 OCR processing status and result

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

OCR processing status

datastring nullable

Extracted text content. Null when status is not finished

Example response

{
  "status": "finished",
  "data": "Dear John,\nPlease find attached the signed contract..."
}

Changes

No recorded changes to this operation across all 2 revisions of this API.