---
title: "Create Text Extraction"
method: POST
path: "/api/v1/files/{file_id}/extraction"
tags: ["files"]
---

# Create Text Extraction

`POST /api/v1/files/{file_id}/extraction`

Create or return text extraction for a file.

- If extraction is completed, returns existing result
- If extraction failed, retries the extraction
- If extraction is pending/in-progress, returns current status
- If no extraction exists, creates a new one

## Path parameters

- `file_id` string, uuid, required

## Query parameters

- `context_id` string, uuid, nullable

## Request body

- TextExtractionRequest — Request schema for text extraction.
  - `settings` TextExtractionSettings
    - `formats` ExtractionFormat[]

## Response `201`

Successful Response

- AgentstackServerApiSchemaCommonEntityModelClassGetitemLocalsModelOutput10
  - `id` string, uuid, required
  - `file_id` string, uuid, required
  - `extracted_files` ExtractedFileInfo[]
    - `file_id` string, uuid, required
    - `format` 'markdown' | 'vendor_specific_json'
  - `status` 'pending' | 'in_progress' | 'completed' | 'failed' | 'cancelled'
  - `job_id` string, nullable
  - `error_message` string, nullable
  - `extraction_metadata` ExtractionMetadata
    - `backend` string, nullable
    - `settings` TextExtractionSettings
      - `formats` ExtractionFormat[]
  - `started_at` string, date-time, nullable
  - `finished_at` string, date-time, nullable
  - `created_at` string, date-time

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/i-am-bee/apis/agentstack-server.md) · [All operations](https://skmtc.net/i-am-bee/apis/agentstack-server/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/i-am-bee/agentstack-server/revisions/7d68b3f8bf7f/schema)