FAfax
Fax AI

List AI custom field definitions

Get all custom field definitions for AI field extraction. (Permitted scopes: fax:all:read, fax:ai_settings:read)

get/accounts/self/ai/custom-fields

Request

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

Response containing a list of custom field definitions

Example response

{
  "records": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "Invoice Number",
      "instructions": "Extract the invoice or reference number from the document",
      "enabled": true
    }
  ]
}

Changes

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