---
title: "Get extraction results"
method: GET
path: "/extraction/{request_id}/results/text"
tags: ["Field Extraction"]
---

# Get extraction results

`GET /extraction/{request_id}/results/text`

## Request

- Base URL: `https://us.app.zuva.ai/api/v2`
- URL: `https://us.app.zuva.ai/api/v2/extraction/{request_id}/results/text`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/zuva/apis/zuva-docai/docs/extraction/:request_id/results/text/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the results of an extraction request. The response includes a result object
for each field, which may include zero or more extractions of that field from the document.

## Path parameters

- `request_id` string, required

## Response `200`

The text result of an extraction

- ExtractionTextResultResponse
  - `file_id` string, required
  - `request_id` string, required
  - `results` ExtractionResult[], required
    - `answers` Answer[]
      - `option` string, required
      - `value` string, required
    - `extractions` TextExtraction[], required
      - `currencies` CurrencyValues[]
        - `value` string, required
        - `symbol` string, required
        - `precision` integer, required
      - `dates` DateValues[]
        - `day` integer, required
        - `month` integer, required
        - `year` integer, required
      - `defined_term` DefinedTerm
        - `term` string, required
        - `spans` CharacterSpan[], required
          - `bounds` BoundingBoxSummary: This bounding box captures the top left position of the first character and the bottom right position of the last character of the extraction.
            - `bottom` integer, required
            - `left` integer, required
            - `right` integer, required
            - `top` integer, required
          - `bboxes` BoundingBoxesByPage[], required
            - `page` integer, required
            - `bounds` BoundingBox[], required
              - …
          - `end` integer, required
          - `pages` Span, required
            - `end` integer, required
            - `start` integer, required
          - `score` number, double, required
          - `start` integer, required
      - `durations` DurationValues[]
        - `unit` string, required
        - `value` integer, required
      - `spans` CharacterSpan[]
        - `bounds` BoundingBoxSummary: This bounding box captures the top left position of the first character and the bottom right position of the last character of the extraction.
          - `bottom` integer, required
          - `left` integer, required
          - `right` integer, required
          - `top` integer, required
        - `bboxes` BoundingBoxesByPage[], required
          - `page` integer, required
          - `bounds` BoundingBox[], required
            - `bottom` integer, required
            - `left` integer, required
            - `right` integer, required
            - `top` integer, required
        - `end` integer, required
        - `pages` Span, required
          - `end` integer, required
          - `start` integer, required
        - `score` number, double, required
        - `start` integer, required
      - `text` string
    - `field_id` string, required
    - `field_name` string, required

## Other responses

- `400`: Invalid request ID
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Request not found.
- `409`: Results not ready yet
- `500`: Internal Server Error

## Changes

- **2024-03-07** `7397ad071d55`: 2 info
  - added the required property `results/items/extractions/items/defined_term/spans/items/score` to the response with the `200` status
  - added the required property `results/items/extractions/items/spans/items/score` to the response with the `200` status
- **2024-02-13** `cf0ba7502ab1`: 1 info
  - added the required property `results/items/field_name` to the response with the `200` status
- **2023-12-13** `51f2a4c5de2e`: 5 info
  - added the optional property `results/items/answers` to the response with the `200` status
  - added the optional property `results/items/extractions/items/currencies` to the response with the `200` status
  - added the optional property `results/items/extractions/items/dates` to the response with the `200` status
  - added the optional property `results/items/extractions/items/defined_term` to the response with the `200` status
  - …1 more

[Operation history](https://skmtc.dev/zuva/apis/zuva-docai/changes/extraction/:request_id/results/text/get.md)

---

[API](https://skmtc.dev/zuva/apis/zuva-docai.md) - [All operations](https://skmtc.dev/zuva/apis/zuva-docai/llms.txt) - [OpenAPI document](https://skmtc.dev/zuva/apis/zuva-docai/revisions/7397ad071d55?raw)