Skip to main content
POST
/
accounts
/
self
/
ai
/
custom-fields
Create AI custom field definition
curl --request POST \
  --url https://restapi.fax.plus/v3/accounts/self/ai/custom-fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Invoice Number",
  "instructions": "Extract the invoice or reference number from the document",
  "enabled": true
}
'
{
  "id": "507f1f77bcf86cd799439011",
  "name": "Invoice Number",
  "instructions": "Extract the invoice or reference number from the document",
  "enabled": true
}

Documentation Index

Fetch the complete documentation index at: https://apidoc.fax.plus/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

OAuth2 Authorization Grant

Body

application/json

Request to create an AI custom field definition

name
string
required

Display name of the custom field

Example:

"Invoice Number"

instructions
string
required

AI extraction instructions for this field

Example:

"Extract the invoice or reference number from the document"

enabled
boolean
default:true

Whether this custom field is active

Response

Response containing a single custom field definition

AI custom field definition

id
string
required

Unique identifier for the custom field

name
string
required

Display name of the custom field

instructions
string
required

AI extraction instructions for this field

enabled
boolean
required

Whether this custom field is active