v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB

Models

Sample Records

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.

get/api/models/{id}/sample

Path parameters

idstring uuid required

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Query parameters

asyncboolean

Headers

X-Polytomic-Versionstring

Response

Example response

{
  "data": {
    "records": [
      {
        "enricher-uuid": {
          "name": "James"
        },
        "model-uuid": {
          "name": "Jim"
        }
      }
    ],
    "warnings": [
      "Enrichment failed for 4 records: you have ran out of credits"
    ]
  },
  "job": {
    "error": "error message",
    "job_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "type": "createmodel"
  }
}