FAfax
Fax AI

Get fax AI settings

Get fax AI auto-trigger settings for the organization. (Permitted scopes: fax:all:read, fax:ai_settings:read)

get/accounts/self/ai/settings

Request

  • Base URL
    https://restapi.fax.plus/v3
  • URL
    https://restapi.fax.plus/v3/accounts/self/ai/settings
  • 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

Response

Fax AI settings

enabledboolean

Whether fax AI features are enabled for this organization

auto_trigger_ocr'manual' | 'received' | 'sent' | 'all'

Auto-trigger mode for OCR processing

auto_trigger_field_extraction'manual' | 'received' | 'sent' | 'all'

Auto-trigger mode for field extraction processing

Changes

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