v1

latestOpenAPI 3.0.12026-07-266184114.0 KB

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 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
}