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

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

# Label documents, or find where each one starts

POST https://api.cloudraker.com/v1/classify
Content-Type: application/json

Classify decides what a file is. [Split](https://docs.cloudraker.com/capabilities/split) cuts it — they are two calls, and this is the only one that runs a model.

Send `classes`: at least two, each an `{id, description}`. The description is the accuracy lever — there is no training data — and the `id` is your branch key, returned untouched. One class is the catch-all; supply `{"id": "other", …}` or one is injected and echoed back in `config`.

**Two granularities:**

| `granularity`        | Answer                                        | Billed                         |
| -------------------- | --------------------------------------------- | ------------------------------ |
| `document` (default) | one label for the whole file                  | the first and last window only |
| `page`               | one label per page, plus derived `segments[]` | every page                     |

Page mode is what feeds split: the model marks the first page of each document, and contiguous, non-overlapping `segments[]` are derived from that in code — so two invoices back to back come back as two segments, not one. Pass the run id to [POST /v1/split](https://docs.cloudraker.com/capabilities/split) as `classifyRunId`.

`confidence` is 0–5. A low score never rewrites the label: threshold it yourself, and re-run with a sharper `description` when the model is unsure.

```json
{
  "file": { "url": "https://acme.example/scans/mail.pdf" },
  "classes": [
    { "id": "invoice", "description": "A bill from a supplier with line items and a total due." },
    { "id": "contract", "description": "A signed agreement with clauses and signature blocks." }
  ],
  "granularity": "page"
}
```

### Waiting for the result

Sync by default: the call holds open until the run finishes, up to `?wait=` seconds (default `60`, max `120`, `0` returns immediately).

| Outcome                    | Response                                     |
| -------------------------- | -------------------------------------------- |
| Finished inside the window | `200` with the full run                      |
| Still running at the cap   | `202` with `{object, id, status, statusUrl}` |

The `202` is a graceful degrade, never an error — poll [the run](https://docs.cloudraker.com/api/cloud-raker-api/runs/get-run) or wait for a [webhook](https://docs.cloudraker.com/api/cloud-raker-api/webhooks/create-webhook-endpoint). Replaying an `idempotency-key` returns the original run alongside an `idempotent-replay: true` response header.

**Learn more:** [Classification guide](https://docs.cloudraker.com/capabilities/classify)

Reference: https://docs.cloudraker.com/paperwork/api/capabilities/classify

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Query parameters

- `wait` (integer, optional, default: 60) — How many seconds to hold the request open waiting for the run to finish. Finishing inside the window returns `200` with the full run; running past it returns `202` with a `statusUrl` to poll. Send `0` to skip waiting entirely and always get the `202`.

### Body (application/json)

This endpoint expects a V1ClassifyBody.

- `classes` (list of V1ClassSpec, optional) — The classes to choose from, at least 2 and at most 50. Required unless you name a saved `action` that carries them. One class is the catch-all. Supply one with `id: "other"`, or one is injected for you and echoed back on the run — a closed set with no exit makes the model guess.
- `granularity` (enum, optional) — What one label covers. `document` (the default) answers once for the whole file and bills only the pages sent to the model; `page` answers per page, derives `segments[]` from where documents start, and bills every page.
  - Allowed values: `document`, `page`
- `rules` (V1ClassifyBodyRules, optional) — Page mode only. A segment shorter than `minPages` (default 1) merges into its neighbour.
- `instructions` (string, optional) — Free-form guidance applied on top of the class descriptions — how to treat continuation sheets, which class wins a tie.
- `pageRange` (V1ClassifyBodyPageRange, optional) — The pages to consider, 1-based inclusive. Defaults to the first 750 pages, which is also the maximum — a wider range is a `page_limit_exceeded` error, never a silent truncation.
- `action` (string, optional) — A saved classify config to run, by id or slug. Config you send inline is merged over it.
- `file` (V1ClassifyBodyFile, optional) — An input file, given one of two ways. * `{ "url": "…", "name"?: "…", "processing"?: "…" }` — fetched over http(s) for this run and purged with it. * `{ "id": "…" }` — a file you already registered with `POST /v1/files`, reusable across runs and never re-parsed. * `{ "id": "…", "ephemeral": true }` — a file you uploaded only for this run, purged with it. Use it only on a file no other run uses.
- `files` (list of V1ClassifyBodyFilesItems, optional)
- `metadata` (map from string to any, optional) — Arbitrary JSON you attach to the run and get back on every read of it. Use it to carry your own identifiers — an order number, a customer id — so a webhook or a polled run reconciles without a lookup table. Capped at 10 KB serialized.
- `webhook` (V1ClassifyBodyWebhook, optional) — Where to deliver this run's events, given one of two ways. * `{ "url": "…" }` — a one-off https endpoint for this run only. * `{ "id": "whe_…" }` — a saved endpoint from `POST /v1/webhooks`. Runs hold the reference, so pausing or re-pointing that endpoint applies to this run too. Deliveries are at-least-once and signed — dedupe on `eventId` and verify against `GET /v1/webhooks/jwks.json`.
- `ttl` (integer, optional, default: 86400) — How long, in seconds, to keep this run and its files before purging them automatically. The maximum is 604800 (7 days). The deadline comes back as `expiresAt` on every read of the run. Call `POST /v1/runs/{id}/keep` before then to clear the TTL and move the results into a space permanently. E-signature runs are exempt — an envelope waits for its signers however long that takes.

## Response

### 200

The finished run.

- `object` ("classify_run", required)
- `id` (string, required)
- `status` (enum, required) — Where the run is in its life. | Status | Meaning | | --- | --- | | `queued` | Accepted, not started | | `processing` | Work in flight | | `needs_input` | Waiting for an external action, such as an e-signature | | `processed` | Finished; `output` is populated | | `failed` | Finished unsuccessfully | | `cancelled` | Stopped on request | | `expired` | TTL elapsed and the data was purged | The last four are terminal.
  - Allowed values: `queued`, `processing`, `processed`, `failed`, `cancelled`, `expired`, `needs_input`
- `expiresAt` (string, required, nullable)
- `statusUrl` (string, required)
- `files` (list of V1ClassifyRunFilesItems, required)
- `file` (V1ClassifyRunFile, optional)
- `error` (V1ClassifyRunError, optional) — Why the run failed. Present whenever `status` is `failed`, and only then. `code` is the stable, snake_case reason (`input_unavailable`, `parse_failed`, …); `message` is the human-readable detail. Per-file and per-step failures are also reported in `files[].error` and, for a pipeline, `steps[].error`.
- `metadata` (map from string to any, optional)
- `config` (V1ClassifyRunConfig, optional)
- `usage` (V1Usage, optional)
- `output` (V1ClassifyRunOutput, optional) — The labels. Present once `status` is `processed`. In document mode `classId`, `confidence` and `reasoning` are the first document's, and `documents[]` is authoritative for a multi-file run. In page mode `pages[]` is the raw per-page answer and `segments[]` is what `POST /v1/split` consumes.

### 202

Accepted — still running, or awaiting human input.

- `object` (string, required)
- `id` (string, required)
- `status` (enum, required) — Where the run is in its life. | Status | Meaning | | --- | --- | | `queued` | Accepted, not started | | `processing` | Work in flight | | `needs_input` | Waiting for an external action, such as an e-signature | | `processed` | Finished; `output` is populated | | `failed` | Finished unsuccessfully | | `cancelled` | Stopped on request | | `expired` | TTL elapsed and the data was purged | The last four are terminal.
  - Allowed values: `queued`, `processing`, `processed`, `failed`, `cancelled`, `expired`, `needs_input`
- `statusUrl` (string, required)
- `envelopeUrl` (string, optional)

## Errors

### 400 Bad Request Error

Invalid request (`classes_required`, `duplicate_class_id`, `too_many_classes`, `config_too_large`, `page_limit_exceeded`, `capability_mismatch`).

- `any`

### 422 Unprocessable Entity Error

Unusable input file or webhook endpoint.

- `any`

### 429 Too Many Requests Error

Rate limited. The `/v1` API allows at least **67 requests per minute per organization** (about 1,000 requests per 15 minutes) — a guaranteed floor, enforced per edge location, so a geographically spread caller may get more. Wait for the `Retry-After` interval and retry — the error is `retryable`.

- `code` (enum, required)
  - Allowed values: `rate_limited`
- `message` (string, required)
- `retryable` (boolean, required)
- `requestId` (string, required)
- `docUrl` (string, optional)

## Types

### V1ClassSpec

One class the document can be labelled with. The `description` is the accuracy lever — there is no training data and no examples field, so say what the document looks like in plain words. `id` is what you branch on and is never rewritten.

- `id` (string, required)
- `description` (string, required)

### V1ClassifyBodyRules

Page mode only. A segment shorter than `minPages` (default 1) merges into its neighbour.

- `minPages` (integer, optional)

### V1ClassifyBodyPageRange

The pages to consider, 1-based inclusive. Defaults to the first 750 pages, which is also the maximum — a wider range is a `page_limit_exceeded` error, never a silent truncation.

- `start` (integer, required)
- `end` (integer, required)

### V1ClassifyBodyFile

An input file, given one of two ways. * `{ "url": "…", "name"?: "…", "processing"?: "…" }` — fetched over http(s) for this run and purged with it. * `{ "id": "…" }` — a file you already registered with `POST /v1/files`, reusable across runs and never re-parsed. * `{ "id": "…", "ephemeral": true }` — a file you uploaded only for this run, purged with it. Use it only on a file no other run uses.

- V1ClassifyBodyFile0
- V1ClassifyBodyFile1

### V1ClassifyBodyFilesItems

An input file, given one of two ways. * `{ "url": "…", "name"?: "…", "processing"?: "…" }` — fetched over http(s) for this run and purged with it. * `{ "id": "…" }` — a file you already registered with `POST /v1/files`, reusable across runs and never re-parsed. * `{ "id": "…", "ephemeral": true }` — a file you uploaded only for this run, purged with it. Use it only on a file no other run uses.

- V1ClassifyBodyFilesItems0
- V1ClassifyBodyFilesItems1

### V1ClassifyBodyWebhook

Where to deliver this run's events, given one of two ways. * `{ "url": "…" }` — a one-off https endpoint for this run only. * `{ "id": "whe_…" }` — a saved endpoint from `POST /v1/webhooks`. Runs hold the reference, so pausing or re-pointing that endpoint applies to this run too. Deliveries are at-least-once and signed — dedupe on `eventId` and verify against `GET /v1/webhooks/jwks.json`.

- V1ClassifyBodyWebhook0
- V1ClassifyBodyWebhook1

### V1ClassifyRunFilesItems

- `id` (string, required)
- `name` (string, required)
- `status` (string, required)
- `error` (string, optional)

### V1ClassifyRunFile

- `id` (string, required)
- `name` (string, required)
- `status` (string, required)
- `error` (string, optional)

### V1ClassifyRunError

Why the run failed. Present whenever `status` is `failed`, and only then. `code` is the stable, snake_case reason (`input_unavailable`, `parse_failed`, …); `message` is the human-readable detail. Per-file and per-step failures are also reported in `files[].error` and, for a pipeline, `steps[].error`.

- `code` (string, required)
- `message` (string, required)

### V1ClassifyRunConfig

- `classes` (list of V1ClassSpec, optional)
- `granularity` (enum, optional) — What one label covers. `document` (the default) answers once for the whole file and bills only the pages sent to the model; `page` answers per page, derives `segments[]` from where documents start, and bills every page.
  - Allowed values: `document`, `page`
- `rules` (V1ClassifyRunConfigRules, optional)

### V1Usage

- `pages` (double, optional)
- `parse` (double, optional)
- `split` (double, optional)

### V1ClassifyRunOutput

The labels. Present once `status` is `processed`. In document mode `classId`, `confidence` and `reasoning` are the first document's, and `documents[]` is authoritative for a multi-file run. In page mode `pages[]` is the raw per-page answer and `segments[]` is what `POST /v1/split` consumes.

- `granularity` (enum, optional) — What one label covers. `document` (the default) answers once for the whole file and bills only the pages sent to the model; `page` answers per page, derives `segments[]` from where documents start, and bills every page.
  - Allowed values: `document`, `page`
- `classId` (string, optional)
- `confidence` (double, optional) — How sure the model was, 0–5. Route below 4 to a human; the label itself is never rewritten by a threshold.
- `reasoning` (string, optional)
- `documents` (list of V1ClassifyDocument, optional)
- `pages` (list of V1ClassifyPage, optional)
- `segments` (list of V1ClassifySegment, optional)
- `unassignedPages` (list of double, optional)

### V1ClassifyBodyFile0

- `url` (string, required)
- `name` (string, optional)
- `processing` (enum, optional)
  - Allowed values: `auto`, `ocr`, `simple`, `transcribe`, `transcribe_diarize`

### V1ClassifyBodyFile1

- `id` (string, required)
- `ephemeral` (boolean, optional) — Purge this file with the run (TTL expiry or `DELETE /v1/runs/{id}`), unless you `keep` the run. API workspace only: ignored under `/v1/spaces/{spaceId}/…`.

### V1ClassifyBodyFilesItems0

- `url` (string, required)
- `name` (string, optional)
- `processing` (enum, optional)
  - Allowed values: `auto`, `ocr`, `simple`, `transcribe`, `transcribe_diarize`

### V1ClassifyBodyFilesItems1

- `id` (string, required)
- `ephemeral` (boolean, optional) — Purge this file with the run (TTL expiry or `DELETE /v1/runs/{id}`), unless you `keep` the run. API workspace only: ignored under `/v1/spaces/{spaceId}/…`.

### V1ClassifyBodyWebhook0

- `url` (string, required)

### V1ClassifyBodyWebhook1

- `id` (string, required)

### V1ClassifyRunConfigRules

- `minPages` (double, optional)

### V1ClassifyDocument

- `fileId` (string, required)
- `status` (string, optional)
- `error` (string, optional)
- `classId` (string, optional)
- `confidence` (double, optional) — How sure the model was, 0–5. Route below 4 to a human; the label itself is never rewritten by a threshold.
- `reasoning` (string, optional)

### V1ClassifyPage

- `page` (double, required)
- `classId` (string, required)
- `documentStart` (boolean, optional)
- `confidence` (double, optional) — How sure the model was, 0–5. Route below 4 to a human; the label itself is never rewritten by a threshold.
- `reasoning` (string, optional)

### V1ClassifySegment

- `startPage` (double, required)
- `endPage` (double, required)
- `classId` (string, optional)
- `confidence` (double, optional) — How sure the model was, 0–5. Route below 4 to a human; the label itself is never rewritten by a threshold.

## Examples

### Example 1

**Request**

```json
{}
```

**Response**

```json
{
  "object": "string",
  "id": "string",
  "status": "queued",
  "expiresAt": "string",
  "statusUrl": "string",
  "files": [
    {
      "id": "string",
      "name": "string",
      "status": "string",
      "error": "string"
    }
  ],
  "file": {
    "id": "string",
    "name": "string",
    "status": "string",
    "error": "string"
  },
  "error": {
    "code": "string",
    "message": "string"
  },
  "metadata": {},
  "config": {
    "classes": [
      {
        "id": "invoice",
        "description": "A bill from a supplier listing line items, quantities and a total amount due."
      }
    ],
    "granularity": "document",
    "rules": {
      "minPages": 1.1
    }
  },
  "usage": {
    "pages": 1.1,
    "parse": 1.1,
    "split": 1.1
  },
  "output": {
    "granularity": "document",
    "classId": "string",
    "confidence": 1.1,
    "reasoning": "string",
    "documents": [
      {
        "fileId": "string",
        "status": "string",
        "error": "string",
        "classId": "string",
        "confidence": 1.1,
        "reasoning": "string"
      }
    ],
    "pages": [
      {
        "page": 1.1,
        "classId": "string",
        "documentStart": true,
        "confidence": 1.1,
        "reasoning": "string"
      }
    ],
    "segments": [
      {
        "startPage": 1.1,
        "endPage": 1.1,
        "classId": "string",
        "confidence": 1.1
      }
    ],
    "unassignedPages": [
      1.1
    ]
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.cloudraker.com/v1/classify"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.cloudraker.com/v1/classify';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

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

```go
package main

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

func main() {

	url := "https://api.cloudraker.com/v1/classify"

	payload := strings.NewReader("{}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

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

}
```

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

url = URI("https://api.cloudraker.com/v1/classify")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

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

HttpResponse<String> response = Unirest.post("https://api.cloudraker.com/v1/classify")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.cloudraker.com/v1/classify', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.cloudraker.com/v1/classify");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.cloudraker.com/v1/classify")! 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()
```

### Example 2

**Request**

```json
{}
```

**Response**

```json
{
  "object": "string",
  "id": "string",
  "status": "queued",
  "statusUrl": "string",
  "envelopeUrl": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.cloudraker.com/v1/classify"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.cloudraker.com/v1/classify';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

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

```go
package main

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

func main() {

	url := "https://api.cloudraker.com/v1/classify"

	payload := strings.NewReader("{}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

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

}
```

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

url = URI("https://api.cloudraker.com/v1/classify")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

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

HttpResponse<String> response = Unirest.post("https://api.cloudraker.com/v1/classify")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.cloudraker.com/v1/classify', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.cloudraker.com/v1/classify");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.cloudraker.com/v1/classify")! 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()
```