Field Extraction

Create extraction requests

Changed on

Creates a new request for extraction of the specified fields from each of the specified files, returning one request for each file.

A maximum of 100 field IDs and 100 file IDs can be included in each request.

post/extraction

Request

Request body

field_idsstring[] required
file_idsstring[] required

Example request

{
  "field_ids": [
    "c83868ae-269a-4a1b-b2af-c53e5f91efca"
  ],
  "file_ids": [
    "c5e407f1qk1er7odm6tg"
  ]
}

Response

See response body for status of each request.

Example response

{
  "file_ids": [
    {
      "file_id": "c5e407f1qk1er7odm6tg",
      "field_ids": [
        "c83868ae-269a-4a1b-b2af-c53e5f91efca"
      ],
      "request_id": "c5e463f1qk154j5e3sjg",
      "status": "complete"
    }
  ]
}

Changes

    • warning

      removed the optional property // from the response with the status

    • info

      the response property // became required for the status