Create a collection | Runtype Documentation

Register a record type as a collection, optionally with a schema (constrained JSON Schema dialect). validationMode defaults to off — creating a collection changes no existing behavior.

Authentication

AuthorizationBearer

API key or Clerk session token

Request

This endpoint expects an object.

displayNamestringRequired1-255 characters

slugstringRequired1-255 characters

descriptionstring or nullOptional<=4000 characters

iconstring or nullOptional<=64 characters

schemamap from strings to any or nullOptional

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

validationModeenumOptional

Allowed values:

Response

Created

createdAtstring

descriptionstring or null

displayNamestring

iconstring or null

idstring

indexedFieldslist of strings

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

schemaVersioninteger

slugstring

updatedAtstring

validationModeenum

recordCountinteger

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

500

Internal Server Error

$	curl -X POST https://api.runtype.com/v1/collections \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"displayName": "User Profiles",
>	"slug": "user-profiles"
>	}'

1	{
2	"createdAt": "2024-06-01T12:00:00Z",
3	"description": "Collection of user profile records",
4	"displayName": "User Profiles",
5	"icon": "user-circle",
6	"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
7	"indexedFields": [
8	"email",
9	"username"
10	],
11	"schema": {},
12	"schemaVersion": 1,
13	"slug": "user-profiles",
14	"updatedAt": "2024-06-01T12:00:00Z",
15	"validationMode": "off",
16	"recordCount": 42
17	}