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

Get record details

GET
/v1/records/:id
GET
/v1/records/:id
$curl https://api.runtype.com/v1/records/id \
>     -H "Authorization: <apiKey>" \
>     -H "Content-Type: application/json"
1{
2  "createdAt": "2024-06-10T09:15:30Z",
3  "id": "a3f1c9d2-7b4e-4f8a-9d3e-2b5c6f7a8e9d",
4  "messages": [
5    {
6      "role": "system",
7      "content": "Record created successfully."
8    },
9    {
10      "role": "user",
11      "content": "Initial input data for processing."
12    }
13  ],
14  "metadata": {
15    "priority": "high",
16    "category": "automation",
17    "tags": [
18      "ai",
19      "workflow",
20      "integration"
21    ]
22  },
23  "name": "Customer Onboarding Workflow",
24  "organizationId": "org_9f8e7d6c5b4a3",
25  "productSurfaceId": "prod_surface_12345",
26  "type": "workflow",
27  "updatedAt": "2024-06-12T16:45:00Z",
28  "userId": "user_abc123xyz",
29  "metadataLabels": {
30    "priority": "Priority Level",
31    "category": "Record Category",
32    "tags": "Associated Tags"
33  },
34  "metadataSchema": {
35    "keys": [
36      "priority",
37      "category",
38      "tags"
39    ]
40  }
41}
Get a specific record by ID including its metadata.
Was this page helpful?
Previous

Update record

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired

Response

Record details
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
404
Not Found Error
500
Internal Server Error