Get a record by id or type+name (hosted RecordStore.get)

POST

/v1/runtime/records/get

POST

/v1/runtime/records/get

$ curl -X POST https://api.runtype.com/v1/runtime/records/get \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "id": "rec_8f3b2a1d4c5e7f90"
> }'

1 {
2   "record": {
3     "createdAt": "2024-05-20T10:15:30Z",
4     "id": "rec_8f3b2a1d4c5e7f90",
5     "metadata": {},
6     "name": "UserSessionRecord",
7     "organizationId": "org_1234567890abcdef",
8     "type": "session",
9     "updatedAt": "2024-05-21T08:45:00Z",
10     "userId": "user_9876543210fedcba",
11     "messages": [
12       {
13         "content": "Initialization complete. Ready to process requests.",
14         "role": "system"
15       }
16     ],
17     "metadataLabels": {},
18     "metadataSchema": {},
19     "productSurfaceId": "prod_surface_01",
20     "schemaValid": true
21   }
22 }

Hosted fulfillment of the runtime RecordStore seam. Looks up a single record by id OR by (type, name), scoped to the authenticated caller. Returns { record: null } when nothing matches. Requires an Enterprise plan: ineligible accounts receive 403 (code BYOC_PLAN_REQUIRED).

Authentication

AuthorizationBearer

API key or Clerk session token

Request

This endpoint expects an object.

objectRequired

Response

The matched record or null

recordobject or null

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error