---
title: "Trigger fax field extraction"
method: POST
path: "/accounts/{user_id}/faxes/{fax_id}/ai/field-extraction"
tags: ["Fax AI"]
---

# Trigger fax field extraction

`POST /accounts/{user_id}/faxes/{fax_id}/ai/field-extraction`

## Request

- Base URL: `https://restapi.fax.plus/v3`
- URL: `https://restapi.fax.plus/v3/accounts/{user_id}/faxes/{fax_id}/ai/field-extraction`
- Auth: one of:
  - 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`
  - HTTP bearer

Trigger AI field extraction for a fax. Extracts structured data fields from the fax content. If extraction is already finished, returns the existing result. Consumes AI credits. (Permitted scopes: **fax:all:edit**, **fax:ai:edit**)

## Path parameters

- `user_id` string, required
- `fax_id` string, required

## Response `200`

Response containing field extraction status and result

- FaxAiFieldExtraction: Field extraction result for a fax
  - `status` 'not_requested' | 'pending' | 'finished' | 'failed' | 'content_filtering_policy', required: Field extraction processing status
  - `data` object, nullable: Extracted fields as key-value pairs. Null when status is not finished

## Other responses

- `400`: Error object in case there's a problem with given data
- `401`: Error object in case there's a problem with the authorization
- `402`: Insufficient credits for the requested operation
- `404`: Requested resource was not found
- `500`: Error object in case there's a server error

---

[API](https://skmtc.dev/fax/apis/fax-plus-rest-api.md) - [All operations](https://skmtc.dev/fax/apis/fax-plus-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fax/apis/fax-plus-rest-api/revisions/95a35a892239?raw)