Sample Records | Polytomic Docs

Returns sample records from the model. The first ten records that the source provides will be returned after being enriched (if applicable). Synchronous requests must complete within 10s. If either querying or enrichment exceeds 10s, please use the async option.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Query parameters

asyncbooleanOptional

Response

dataobject

jobobject

Errors

400

Models Sample Request Bad Request Error

401

Models Sample Request Unauthorized Error

404

Models Sample Request Not Found Error

500

Models Sample Request Internal Server Error

1	{
2	"data": {
3	"records": [
4	{
5	"enricher-uuid": {
6	"name": "James"
7	},
8	"model-uuid": {
9	"name": "Jim"
10	}
11	}
12	],
13	"warnings": [
14	"Enrichment failed for 4 records: you have ran out of credits"
15	]
16	},
17	"job": {
18	"error": "error message",
19	"job_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
20	"result": {
21	"key": "value"
22	},
23	"status": "created",
24	"type": "createmodel"
25	}
26	}

1	import { PolytomicClient } from "polytomic";
2
3	const client = new PolytomicClient({ token: "YOUR_TOKEN", version: "YOUR_VERSION" });
4	await client.models.sample("248df4b7-aa70-47b8-a036-33ac447e668d");

Authentication

Path parameters

Headers

Query parameters

Response

Errors