FAfax
Fax AI

Create AI custom field definition

Create a new custom field definition for AI field extraction. Admin-only. (Permitted scopes: fax:all:edit, fax:ai_settings:edit)

post/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

Request body

namestring required

Display name of the custom field

instructionsstring required

AI extraction instructions for this field

enabledboolean

Whether this custom field is active

Example request

{
  "name": "Invoice Number",
  "instructions": "Extract the invoice or reference number from the document"
}

Response

Response containing a single custom field definition

idstring required

Unique identifier for the custom field

namestring required

Display name of the custom field

instructionsstring required

AI extraction instructions for this field

enabledboolean required

Whether this custom field is active

Example response

{
  "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.