---
title: "Retrieve extraction results"
method: GET
path: "/extractors/{extractor_id}/results"
tags: ["Extractors"]
---

# Retrieve extraction results

`GET /extractors/{extractor_id}/results`

## Request

- Base URL: `https://h2ogpte.genai.h2o.ai/api/v1`
- URL: `https://h2ogpte.genai.h2o.ai/api/v1/extractors/{extractor_id}/results`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/h2o/apis/h2ogpte-rest-api/docs/extractors/:extractor_id/results/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves extraction results produced by this extractor. If job_id is specified,
returns results for that specific extraction run. If job_id is omitted, returns all
results produced by this extractor across all runs.

## Path parameters

- `extractor_id` string, required

## Query parameters

- `job_id` string
- `offset` integer
- `limit` integer

## Response `200`

Extraction results retrieved successfully. Returns an array of extraction results.

- DocumentExtractionResult[]
  - `id` string, required: ID of the document extraction result
  - `document_id` string, nullable: ID of the document that was processed. Null when the extraction was run on uploaded files without a collection.
  - `document_name` string, required: Name of the document that was processed
  - `content` unknown, required
  - `error` string, required: Contains error in case extraction failed for this document. Otherwise empty.

## Other responses

- `400`: Bad request
- `401`: Unauthorized - Invalid or missing API key
- `404`: Not found
- `default`: Unexpected error

---

[API](https://skmtc.dev/h2o/apis/h2ogpte-rest-api.md) - [All operations](https://skmtc.dev/h2o/apis/h2ogpte-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/h2o/apis/h2ogpte-rest-api/revisions/a82a117320f4?raw)