---
title: "Upload a document"
method: POST
path: "/documents"
tags: ["Documents"]
---

# Upload a document

`POST /documents`

## Request

- Base URL: `https://klaaro.ai/api/v1`
- URL: `https://klaaro.ai/api/v1/documents`
- Auth: HTTP bearer

## Headers

- `Idempotency-Key` string, uuid

## Request body

- object
  - `datasetId` string, uuid, required: Dataset UUID (from `GET /datasets`).
  - `url` string, uri, required: Public URL to fetch and ingest.
  - `fixedClass` string: Lock class to this slug (e.g. `invoice`). Skips the classification step.

## Response `201`

Document created

- Document
  - `id` string, uuid, required
  - `datasetId` string, uuid, required: UUID of the dataset this document belongs to
  - `datasetSlug` string, required: Slug of the dataset this document belongs to
  - `filename` string, required
  - `fileType` string, required
  - `fileSize` integer, required
  - `status` 'queued' | 'processing' | 'completed' | 'failed' | 'cancelled', required
  - `currentStep` 'ocr' | 'classify' | 'defineClass' | 'extract' | 'validate' | 'approve', required: Pipeline step identifier — used in currentStep (document state) and fromStep (re-run trigger).
  - `class` DocumentClassRef, required
    - `slug` string, nullable, required: Class slug, e.g. invoice
    - `name` string, nullable, required: Display name at read time
  - `error` string, nullable
  - `ingestSourceDisplay` string, nullable
  - `pipeline` object
    - `lastRunId` string, nullable
    - `lastFinishedAt` string, date-time, nullable
    - `fromStep` 'ocr' | 'classify' | 'defineClass' | 'extract' | 'validate' | 'approve': Pipeline step identifier — used in currentStep (document state) and fromStep (re-run trigger).
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `429`: Rate limited

---

[API](https://skmtc.dev/klaaro/apis/klaaro-api.md) · [All operations](https://skmtc.dev/klaaro/apis/klaaro-api/llms.txt) · [OpenAPI document](https://skmtc.dev/klaaro/apis/klaaro-api/revisions/053a1638b76c?raw)