---
title: "POST /v1/extract/{model}"
method: POST
path: "/v1/extract/{model}"
tags: ["inference"]
---

# POST /v1/extract/{model}

`POST /v1/extract/{model}`

Successful extract work results may carry an aligned per-item error alongside partial data. Transport-level mixed failures retain generic batch behavior: the 200 response includes only successful work results.

## Path parameters

- `model` string, required

## Headers

- `X-SIE-MACHINE-PROFILE` string, nullable
- `X-SIE-Pool` string, nullable
- `X-SIE-SDK-Version` string, nullable

## Request body

- ExtractRequest
  - `items` ItemInput[], required
    - `audio` AudioInput
      - `data` string, byte, required — Media bytes. Base64-encoded on the JSON path; native binary on the msgpack path.
      - `format` string, nullable
      - `sample_rate` integer, nullable — Sample rate in Hz. Must be positive.
    - `document` DocumentInput
      - `data` string, byte, required — Media bytes. Base64-encoded on the JSON path; native binary on the msgpack path.
      - `format` string, nullable
    - `id` string, nullable
    - `images` ImageInput[], nullable
      - `data` string, byte, required — Media bytes. Base64-encoded on the JSON path; native binary on the msgpack path.
      - `format` string, nullable
    - `metadata` unknown
    - `text` string, nullable
    - `video` VideoInput
      - `data` string, byte, required — Media bytes. Base64-encoded on the JSON path; native binary on the msgpack path.
      - `format` string, nullable
  - `params` ExtractParams
    - `instruction` string, nullable
    - `labels` string[], nullable
    - `options` unknown
    - `output_schema` unknown

## Response `200`

Extract response

- ExtractResponse
  - `items` ExtractResult[], required
    - `classifications` unknown[]
      - unknown
    - `data` unknown
    - `entities` Entity[]
      - `bbox` number[], nullable
      - `end` integer, nullable
      - `label` string, required
      - `score` number, double, required
      - `start` integer, nullable
      - `text` string, required
    - `error` ExtractItemError
      - `code` string, required
      - `message` string, required
    - `id` string, required
    - `relations` Relation[]
      - `head` string, required
      - `relation` string, required
      - `score` number, double, required
      - `tail` string, required
  - `model` string, required
  - `usage` Usage — Authoritative worker-emitted usage. Post-tokenization counts, never a character estimate. A reported `0` is a measurement (a request that read no text); an absent block means the serving path could not count. Structurally identical to `ScoreUsage`, which shipped this shape first.
    - `images` integer, nullable
    - `input_tokens` integer, required

## Other responses

- `400` — Invalid request
- `401` — Missing or invalid bearer token
- `404` — Model not found
- `409` — Bundle override conflicts with model routing
- `413` — Request body too large
- `500` — All batch items failed or gateway internal error; gateway auth enabled but no tokens configured
- `502` — Terminal model load failure (MODEL_LOAD_FAILED)
- `503` — Provisioning in progress, queue unavailable, GPU not configured, model loading, or capacity exhausted
- `504` — Result channel closed

## Changes

> 41 revisions in range; 2 could not be searched.

- **2026-07-22** `9f3153c32a93` — 4 info
  - added the optional property `items/items/error` to the response with the `200` status (media type: application/json)
  - added the optional property `items/items/error` to the response with the `200` status (media type: application/msgpack)
  - added the optional property `items/items/error` to the response with the `200` status (media type: application/vnd.msgpack)
  - added the optional property `items/items/error` to the response with the `200` status (media type: application/x-msgpack)
- **2026-07-03** `a07e76b98502` — 1 warning
  - deleted the `header` request parameter `X-SIE-Engine`
- **2026-06-13** `a7b0c412cdd4` — 1 breaking
  - removed the success response with the status `202`
- **2026-06-03** `f4131a4016da` — 1 info
  - added the new optional `header` request parameter `X-SIE-Engine`
- **2026-05-08** `a499d5bea359` — 1 info
  - added the success response with the status `202`

[Change history](https://skmtc.dev/superlinked/apis/sie-gateway/changes/v1/extract/:model/post.md)

---

[API](https://skmtc.dev/superlinked/apis/sie-gateway.md) · [All operations](https://skmtc.dev/superlinked/apis/sie-gateway/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/superlinked/sie-gateway/revisions/78eeecd83405/schema)