Infer a schema from existing records

Sample the type’s most recently updated records and return a PROPOSED dialect-conformant schema with per-field confidence and sample values. Does not save anything — review the proposal, then PATCH the collection. Works for registered and unregistered slugs alike (register-then-infer or infer-then-register).

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

slugstringRequired

Request

This endpoint expects an object.

sampleintegerOptional1-1000

Response

Schema proposal

fieldslist of objects

sampledRecordsinteger

schemamap from strings to any or null

Constrained JSON Schema dialect: root object with string/number/boolean/array/object properties, one nesting level, no $ref/oneOf/pattern

skippedKeyslist of strings

slugstring

totalRecordsinteger

Errors

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

$	curl -X POST https://api.runtype.com/v1/collections/slug/infer-schema \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"fields": [
3	{
4	"confidence": 0.98,
5	"name": "status",
6	"presence": 0.95,
7	"sampleValues": [
8	"completed",
9	"pending",
10	"failed"
11	],
12	"type": "string",
13	"enum": [
14	"pending",
15	"completed",
16	"failed"
17	],
18	"format": "date-time"
19	}
20	],
21	"sampledRecords": 150,
22	"schema": {},
23	"skippedKeys": [
24	"internalNotes"
25	],
26	"slug": "user-transactions",
27	"totalRecords": 200
28	}