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

# Get extraction request

`GET /extraction/{request_id}`

## Request

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

Retrieves the status of an extraction request.

## Path parameters

- `request_id` string, required

## Response `200`

The status of the extraction request

- ExtractionRequestStatus
  - `error` HttpErrorDetails
    - `code` string, required: A unique string identifying the error.
    - `message` string, required: An error message providing more details and potential steps to resolve.
  - `file_id` string, required
  - `request_id` string, required
  - `status` 'queued' | 'processing' | 'complete' | 'failed', required

## Other responses

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

## Changes

- **2023-12-13** `51f2a4c5de2e`: 1 warning
  - removed the optional property `field_ids` from the response with the `200` status

[Operation history](https://skmtc.dev/zuva/apis/zuva-docai/changes/extraction/:request_id/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)