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
      • POSTBulk delete records
      • GETList records
      • POSTCreate record
      • GETDiscover record schema
      • GETGet field values
      • POSTPreview record filter
      • GETGet record details
      • PUTUpdate record
      • DELDelete record
      • GETGet record step results
      • GETGet record costs
      • GETGet record results
      • DELDelete record result
      • POSTBulk edit records
      • POSTUpload CSV records
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: Bearer <token>" \
>     -H "Content-Type: application/json"
1{
2  "id": "a3f1c9d2-4b7e-4f8a-9d3e-2b5c6f7a8e9d",
3  "userId": "user_987654321",
4  "organizationId": "org_123456789",
5  "type": "document",
6  "name": "Project Proposal Q3",
7  "metadata": {
8    "status": "approved",
9    "version": "1.2",
10    "tags": [
11      "finance",
12      "quarterly",
13      "confidential"
14    ]
15  },
16  "messages": [
17    "Initial draft created",
18    "Reviewed by finance team",
19    "Final approval granted"
20  ],
21  "productSurfaceId": "surface_456def789abc",
22  "createdAt": "2024-05-10T09:15:30Z",
23  "updatedAt": "2024-05-15T16:45:00Z",
24  "metadataSchema": {
25    "status": "string",
26    "version": "string",
27    "tags": "array"
28  },
29  "metadataLabels": {
30    "status": "Approval Status",
31    "version": "Document Version",
32    "tags": "Keywords"
33  }
34}
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
idstring
userIdstring
organizationIdstring or null
typestring
namestring
metadatamap from strings to any
messageslist of any or null
productSurfaceIdstring or null
createdAtstring
updatedAtstring
metadataSchemamap from strings to any
metadataLabelsmap from strings to any

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error