---
title: "Sample Records"
method: GET
path: "/api/models/{id}/sample"
tags: ["Models"]
---

# Sample Records

`GET /api/models/{id}/sample`

Returns a sample of records from a model.

Synchronous requests must complete within 10 seconds. If the source query or
enrichment step can exceed that budget, use the asynchronous option so the
work runs as a background job.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `async` boolean

## Headers

- `X-Polytomic-Version` string

## Response `200`

OK

- ModelSampleResponseEnvelope
  - `data` ModelSample
    - `records` SampleRecord[]
    - `warnings` string[]
  - `job` JobResponse
    - `error` string, nullable — Error message if the job failed.
    - `job_id` string, uuid — Identifier of the job.
    - `result` unknown
    - `status` 'created' | 'running' | 'done' | 'failed'
    - `type` string — Job type. Matches the type used to fetch the job.

## Other responses

- `400` — Bad Request
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/polytomic/apis/polytomic-api.md) · [All operations](https://skmtc.net/polytomic/apis/polytomic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/polytomic/polytomic-api/versions/5e9bcd4cfb2d/schema)