> This page is for version v1 (default).
> For other versions, use one of these documentation indexes:
> - v1 (default): https://docs.plextera.com/v-1/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.plextera.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.plextera.com/_mcp/server.

# Upload and extract document

POST https://api.plextera.com/api/public/v1/document-insights/extractions/upload
Content-Type: multipart/form-data

Uploads a document and creates an extraction in one request.

Workspace configuration determines routing and output fields.
See [Configuration, routing, and output](/guides/core-guides/document-extraction#configuration-routing-and-output) before sending `docType`.


Reference: https://docs.plextera.com/api/api-reference/document-insights/upload-and-extract-document

## Authentication

- `Authorization` header (required) — Use the API key format: `api-key <token>`.

## Request

### Body (multipart/form-data)

This endpoint expects a multipart form containing a file.

- `file` (file, required) — Document file to extract.
- `labels` (map from string to string, optional) — Optional string key-value pairs. Custom labels are returned for correlation and do not affect extraction. The reserved `docType` label controls routing; use the exact value from the relevant Document Insights configuration in Plextera, or ask your workspace administrator or Plextera if you cannot find it. With default routing, omit `docType` but keep any custom correlation labels you need. Up to 50 labels; keys 1-64 characters; values 1-512 characters.

## Response

### 202

File stored and extraction accepted. Poll or subscribe for the result.

- `id` (string, optional) — Extraction identifier. Store this value for polling, feedback, and event correlation. Example: `69654f0bc073ef404baec649`.
- `status` (enum, optional) — Current processing state. `FAILED` covers routing, processing, or extracted-data validation problems. `REJECTED` covers document-level problems such as duplicate content or an unsupported language. Stop polling when the value is `COMPLETED`, `FAILED`, or `REJECTED`.
  - Allowed values: `QUEUED`, `PROCESSING`, `COMPLETED`, `FAILED`, `REJECTED`
- `outputAvailable` (boolean, optional) — `true` means the final `output` is ready and included in the extraction details or completed event payload.
- `createdAt` (datetime, optional) — UTC timestamp when Plextera accepted the extraction request. Example: `2026-04-07T10:05:04Z`.
- `updatedAt` (datetime, optional) — UTC timestamp of the latest known state change. Example: `2026-04-07T10:22:00Z`.
- `completedAt` (datetime, optional) — UTC timestamp when the extraction reached `COMPLETED`, `FAILED`, or `REJECTED`. Omitted while the extraction is still queued or processing.
- `error` (RunError, optional) — Failure or rejection details. Present only when `status` is `FAILED` or `REJECTED`.
- `labels` (map from string to string, optional) — String key-value pairs submitted with the extraction and returned for correlation.
- `document` (DocumentInsightsDocument, optional) — Summary of the source document that was processed.

## Errors

### 400 Bad Request Error

INVALID_REQUEST — The request is malformed: unreadable JSON, an invalid parameter value, or a bad multipart body.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 401 Unauthorized Error

UNAUTHORIZED — The API key is missing, malformed, or revoked.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 403 Forbidden Error

FORBIDDEN — The API key is valid but not allowed to perform this operation.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 405 Method Not Allowed Error

METHOD_NOT_ALLOWED — The HTTP method is not supported for this path.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 406 Not Acceptable Error

NOT_ACCEPTABLE — The requested response media type is not supported.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 409 Conflict Error

CONFLICT — The request conflicts with existing state in an upstream Plextera service.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 413 Content Too Large Error

PAYLOAD_TOO_LARGE — The uploaded file exceeds the maximum supported size of 50 MB.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 415 Unsupported Media Type Error

UNSUPPORTED_MEDIA_TYPE — The uploaded file type is not allowed. Executable and script files are rejected.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 422 Unprocessable Entity Error

VALIDATION_FAILED — one or more request fields are invalid. See `details`.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 429 Too Many Requests Error

RATE_LIMITED — Too many requests in a short window. 429 responses are enforced at the network edge; the body may be plain text instead of this envelope, so rely on the status code and the Retry-After header.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 500 Internal Server Error

INTERNAL_ERROR — Unexpected failure inside Plextera. Retry with backoff; contact support with the requestId if it persists.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 502 Bad Gateway Error

DOWNSTREAM_ERROR — A downstream Plextera service failed while handling the request. Retry with backoff.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

## Types

### RunError

Terminal failure details. Present only for failed or rejected extractions and workflow runs.

- `code` (string, optional) — Stable machine-readable reason code. Document Insights returns `DOCUMENT_NOT_ROUTED` with `FAILED` for routing problems, `DOCUMENT_EXTRACTION_FAILED` with `FAILED` for processing or extracted-data validation problems, and `DOCUMENT_REJECTED` with `REJECTED` for document-level problems such as duplicate content or an unsupported language.
- `message` (string, optional) — Human-readable explanation of the failure or rejection.

### DocumentInsightsDocument

Document summary used inside Document Insights extraction and event payloads. Includes file metadata returned by File Service and page count returned by Document Insights; optional fields are omitted if the upstream service does not return them.

- `fileId` (string, optional) — Plextera File Service identifier for the source document.
- `fileName` (string, optional) — Source file name returned by File Service. Omitted when the upstream file record does not include a name.
- `mimeType` (string, optional) — Standard MIME media type of the source document, for example `application/pdf`. Omitted when Document Insights cannot determine the media type.
- `size` (long, optional) — Source document size in bytes returned by File Service. Omitted when file size is unavailable.
- `pageCount` (integer, optional) — Source document page count returned by Document Insights. Omitted when page count has not been computed.
- `contentUrl` (string, optional, nullable) — Short-lived pre-signed URL to download the source document directly from File Service. Returned only by Get extraction (`GET /extractions/{id}`); it is minted per request and expires, so use it promptly and do not store it. Omitted from List extractions responses and whenever the download URL cannot be resolved.

### ApiError

Machine-readable error details shared by every error response.

- `code` (string, optional) — Stable machine-readable error code. Branch your handling on this, not on `message`.
- `message` (string, optional) — Human-readable explanation. Wording may change; do not parse it.
- `requestId` (string, optional) — Unique request identifier, also returned in the X-Request-Id response header. Include it in support requests.
- `retryable` (boolean, optional) — True when retrying the same request later may succeed.
- `details` (list of ApiErrorDetail, optional) — Field-level validation issues. Present only for VALIDATION_FAILED.

### ApiErrorDetail

Field-level validation issue.

- `field` (string, optional) — Name of the invalid request field.
- `issue` (string, optional) — What is wrong with the field value.

## Examples

### Queued extraction

**Request**

```json
{}
```

**Response**

```json
{
  "id": "69654f0bc073ef404baec649",
  "status": "QUEUED",
  "outputAvailable": false,
  "createdAt": "2026-04-07T10:05:04Z",
  "updatedAt": "2026-04-07T10:05:04Z",
  "labels": {
    "customerDocumentId": "doc-42",
    "docType": "invoice"
  },
  "document": {
    "fileId": "file_01JY7M4ZVX5R1P3M3Q0TA1S7ZM",
    "fileName": "invoice.pdf",
    "mimeType": "application/pdf"
  }
}
```

**SDK Code**

```python Queued extraction
import requests

url = "https://api.plextera.com/api/public/v1/document-insights/extractions/upload"

headers = {"Authorization": "<apiKey>"}

response = requests.post(url, headers=headers)

print(response.json())
```

```javascript Queued extraction
const url = 'https://api.plextera.com/api/public/v1/document-insights/extractions/upload';
const options = {method: 'POST', headers: {Authorization: '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Queued extraction
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.plextera.com/api/public/v1/document-insights/extractions/upload"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Queued extraction
require 'uri'
require 'net/http'

url = URI("https://api.plextera.com/api/public/v1/document-insights/extractions/upload")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java Queued extraction
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.plextera.com/api/public/v1/document-insights/extractions/upload")
  .header("Authorization", "<apiKey>")
  .asString();
```

```php Queued extraction
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.plextera.com/api/public/v1/document-insights/extractions/upload', [
  'headers' => [
    'Authorization' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Queued extraction
using RestSharp;

var client = new RestClient("https://api.plextera.com/api/public/v1/document-insights/extractions/upload");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Queued extraction
import Foundation

let headers = ["Authorization": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.plextera.com/api/public/v1/document-insights/extractions/upload")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Direct upload

**Request**

```json
{
  "file": "<file: invoice.pdf>",
  "labels": {
    "customerDocumentId": "doc-42",
    "docType": "YOUR_CONFIGURED_DOCUMENT_TYPE"
  }
}
```

**Response**

```json
{
  "id": "69654f0bc073ef404baec649",
  "status": "QUEUED",
  "outputAvailable": false,
  "createdAt": "2026-04-07T10:05:04Z",
  "updatedAt": "2026-04-07T10:05:04Z",
  "labels": {
    "customerDocumentId": "doc-42",
    "docType": "invoice"
  },
  "document": {
    "fileId": "file_01JY7M4ZVX5R1P3M3Q0TA1S7ZM",
    "fileName": "invoice.pdf",
    "mimeType": "application/pdf"
  }
}
```

**SDK Code**

```python Direct upload
import requests

url = "https://api.plextera.com/api/public/v1/document-insights/extractions/upload"

files = { "file": "open('invoice.pdf', 'rb')" }
payload = { "labels": "{
  \"customerDocumentId\": \"doc-42\",
  \"docType\": \"YOUR_CONFIGURED_DOCUMENT_TYPE\"
}" }
headers = {"Authorization": "<apiKey>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.json())
```

```javascript Direct upload
const url = 'https://api.plextera.com/api/public/v1/document-insights/extractions/upload';
const form = new FormData();
form.append('file', 'invoice.pdf');
form.append('labels', '{
  "customerDocumentId": "doc-42",
  "docType": "YOUR_CONFIGURED_DOCUMENT_TYPE"
}');

const options = {method: 'POST', headers: {Authorization: '<apiKey>'}};

options.body = form;

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Direct upload
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.plextera.com/api/public/v1/document-insights/extractions/upload"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"invoice.pdf\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"labels\"\r\n\r\n{\n  \"customerDocumentId\": \"doc-42\",\n  \"docType\": \"YOUR_CONFIGURED_DOCUMENT_TYPE\"\n}\r\n-----011000010111000001101001--\r\n")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Direct upload
require 'uri'
require 'net/http'

url = URI("https://api.plextera.com/api/public/v1/document-insights/extractions/upload")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<apiKey>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"invoice.pdf\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"labels\"\r\n\r\n{\n  \"customerDocumentId\": \"doc-42\",\n  \"docType\": \"YOUR_CONFIGURED_DOCUMENT_TYPE\"\n}\r\n-----011000010111000001101001--\r\n"

response = http.request(request)
puts response.read_body
```

```java Direct upload
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.plextera.com/api/public/v1/document-insights/extractions/upload")
  .header("Authorization", "<apiKey>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"invoice.pdf\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"labels\"\r\n\r\n{\n  \"customerDocumentId\": \"doc-42\",\n  \"docType\": \"YOUR_CONFIGURED_DOCUMENT_TYPE\"\n}\r\n-----011000010111000001101001--\r\n")
  .asString();
```

```php Direct upload
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.plextera.com/api/public/v1/document-insights/extractions/upload', [
  'multipart' => [
    [
        'name' => 'file',
        'filename' => 'invoice.pdf',
        'contents' => null
    ],
    [
        'name' => 'labels',
        'contents' => '{
  "customerDocumentId": "doc-42",
  "docType": "YOUR_CONFIGURED_DOCUMENT_TYPE"
}'
    ]
  ]
  'headers' => [
    'Authorization' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Direct upload
using RestSharp;

var client = new RestClient("https://api.plextera.com/api/public/v1/document-insights/extractions/upload");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "<apiKey>");
request.AddParameter("undefined", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"invoice.pdf\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"labels\"\r\n\r\n{\n  \"customerDocumentId\": \"doc-42\",\n  \"docType\": \"YOUR_CONFIGURED_DOCUMENT_TYPE\"\n}\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Direct upload
import Foundation

let headers = ["Authorization": "<apiKey>"]
let parameters = [
  [
    "name": "file",
    "fileName": "invoice.pdf"
  ],
  [
    "name": "labels",
    "value": "{
  \"customerDocumentId\": \"doc-42\",
  \"docType\": \"YOUR_CONFIGURED_DOCUMENT_TYPE\"
}"
  ]
]

let boundary = "---011000010111000001101001"

var body = ""
var error: NSError? = nil
for param in parameters {
  let paramName = param["name"]!
  body += "--\(boundary)\r\n"
  body += "Content-Disposition:form-data; name=\"\(paramName)\""
  if let filename = param["fileName"] {
    let contentType = param["content-type"]!
    let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8)
    if (error != nil) {
      print(error as Any)
    }
    body += "; filename=\"\(filename)\"\r\n"
    body += "Content-Type: \(contentType)\r\n\r\n"
    body += fileContent
  } else if let paramValue = param["value"] {
    body += "\r\n\r\n\(paramValue)"
  }
}

let request = NSMutableURLRequest(url: NSURL(string: "https://api.plextera.com/api/public/v1/document-insights/extractions/upload")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```