Upload CSV records | Runtype Documentation

Upload and process a CSV file to create records in bulk. Either supply typeColumn to read the type from a column, or typeValue to assign the same constant type to every row (skipping the column lookup). typeValue takes precedence when both are provided.

Authentication

AuthorizationBearer

API key or Clerk session token

Request

This endpoint expects a multipart form.

fileanyOptional

nameColumnstringOptional

typeColumnstringOptional

typeValuestringOptional<=255 characters

Response

CSV upload result

createdinteger

errorDetailslist of strings

errorsinteger

messagestring

recordslist of objects

successboolean

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

1	{
2	"created": 3,
3	"errorDetails": [
4	"Row 2: Missing required field 'Category'"
5	],
6	"errors": 1,
7	"message": "Processed 4 records with 1 error.",
8	"records": [
9	{
10	"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
11	"metadata": {},
12	"name": "Wireless Mouse",
13	"type": "Electronics"
14	}
15	],
16	"success": true
17	}

1	{
2	"created": 3,
3	"errorDetails": [
4	"Row 2: Missing required field 'Category'"
5	],
6	"errors": 1,
7	"message": "Processed 4 records with 1 error.",
8	"records": [
9	{
10	"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
11	"metadata": {},
12	"name": "Wireless Mouse",
13	"type": "Electronics"
14	}
15	],
16	"success": true
17	}

$	curl -X POST https://api.runtype.com/v1/records/upload-csv \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: multipart/form-data"