---
title: "Get Example"
method: GET
path: "/api/v1/example"
tags: ["public-api"]
---

# Get Example

`GET /api/v1/example`

## Request

- Base URL: `https://ndi-api.nace.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://ndi-api.nace.ai/api/v1/example`
- Auth: API key in header `X-API-Key`
- TypeScript: <https://skmtc.dev/nace/apis/ndi-service/docs/api/v1/example/get.ts> (a function with typed inputs; its response is checked against the schema)

Return (provisioning on first call) the tenant's Playground example.

## Response `200`

Successful Response

- ExampleResponse: Response for ``GET /example``.
  - `file` ExampleFile, required: The tenant's copy of the canonical sample document.
    - `file_id` string, uuid, required
    - `file_name` string, required
    - `source_url` string, required: ``ndi://file/<id>`` handle; never expires. Use as source_url on any action.
    - `page_count` integer, required
  - `examples` ExampleJobs, required
    - `parse` ExampleJob, required: One pre-computed example job plus the request that produced it.
      - `job_id` string, uuid, required
      - `request` object, required: Verbatim request body for the action endpoint (prefill editors; POST it to re-run).
    - `extract` ExampleJob, required: One pre-computed example job plus the request that produced it.
      - `job_id` string, uuid, required
      - `request` object, required: Verbatim request body for the action endpoint (prefill editors; POST it to re-run).
    - `categorize` ExampleJob, required: One pre-computed example job plus the request that produced it.
      - `job_id` string, uuid, required
      - `request` object, required: Verbatim request body for the action endpoint (prefill editors; POST it to re-run).
    - `ground` ExampleJob, required: One pre-computed example job plus the request that produced it.
      - `job_id` string, uuid, required
      - `request` object, required: Verbatim request body for the action endpoint (prefill editors; POST it to re-run).

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `402`: Payment Required
- `403`: Forbidden
- `404`: No example is configured (or the tenant's storage mode does not support it).
- `409`: Conflict
- `413`: Request Entity Too Large
- `422`: Unprocessable Entity
- `500`: Internal Server Error
- `503`: The published example manifest is unreadable or invalid — operator attention needed.

---

[API](https://skmtc.dev/nace/apis/ndi-service.md) - [All operations](https://skmtc.dev/nace/apis/ndi-service/llms.txt) - [OpenAPI document](https://skmtc.dev/nace/apis/ndi-service/revisions/d9d1f8ec2207?raw)