For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
User GuideDeveloper GuidesAPI Reference
User GuideDeveloper GuidesAPI Reference
    • Overview
  • Runtype API
      • GETList records
      • POSTCreate record
      • POSTBulk delete records
      • POSTBulk edit records
      • GETExport records as CSV
      • GETGet field values
      • POSTPreview record filter
      • GETDiscover record schema
      • POSTUpload CSV records
      • GETGet record details
      • PUTUpdate record
      • DELDelete record
      • GETGet record costs
      • GETGet record results
      • DELDelete record result
      • GETGet record step results
Dashboard
LogoLogo
Runtype APIRecords

Create record

POST
/v1/records
POST
/v1/records
$curl -X POST https://api.runtype.com/v1/records \
>     -H "Authorization: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "name": "John Smith",
>  "type": "customer",
>  "metadata": {
>    "active": true,
>    "company_name": "TechCorp Inc",
>    "customer_name": "John Smith",
>    "customer_type": "enterprise client",
>    "details": "This is a comprehensive quarterly business review covering Q4 performance metrics, detailed analysis of key performance indicators, customer satisfaction scores, revenue growth patterns, and strategic planning initiatives for the upcoming 2024 fiscal year including market expansion opportunities and technology investment priorities.",
>    "features": [
>      "advanced analytics",
>      "24/7 support",
>      "custom integrations"
>    ],
>    "priority_score": 8.5,
>    "product": {
>      "name": "Premium Software Suite",
>      "price": "299.99"
>    },
>    "recipient_name": "Sarah Johnson",
>    "review_type": "detailed",
>    "subject": "Quarterly Business Review",
>    "tone": "friendly yet professional"
>  }
>}'
1{
2  "createdAt": "string",
3  "id": "string",
4  "messages": [
5    null
6  ],
7  "metadata": {},
8  "name": "string",
9  "organizationId": "string",
10  "productSurfaceId": "string",
11  "type": "string",
12  "updatedAt": "string",
13  "userId": "string",
14  "metadataLabels": {},
15  "metadataSchema": {
16    "keys": [
17      "string"
18    ]
19  }
20}
Create a new record with metadata. Returns 409 if a record with the same type and name already exists in the tenant.
Was this page helpful?
Previous

Bulk delete records

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Request

This endpoint expects an object.
namestringRequired1-500 characters
typestringRequired1-255 characters
messageslist of objects or nullOptional
metadatamap from strings to anyOptionalDefaults to {}

Response

Created record
createdAtstring
idstring
messageslist of any or null
metadatamap from strings to any
namestring
organizationIdstring or null
productSurfaceIdstring or null
typestring
updatedAtstring
userIdstring
metadataLabelsmap from strings to strings
metadataSchemaobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
500
Internal Server Error