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 generation sessions
      • POSTCreate a generation session
      • GETGet session details
      • DELDelete a generation session
      • PATCHUpdate a generation session
      • POSTAppend an event to a session
Dashboard
LogoLogo
Runtype APIProduct Generation

Get session details

GET
/v1/products/generation/sessions/:id
GET
/v1/products/generation/sessions/:id
$curl https://api.runtype.com/v1/products/generation/sessions/id \
>     -H "Authorization: <apiKey>" \
>     -H "Content-Type: application/json"
1{
2  "assemblyState": {
3    "step": "assembling",
4    "progress": 75,
5    "details": {
6      "componentsCompleted": 3,
7      "componentsPending": 1
8    }
9  },
10  "catalogVersion": "v2.4.1",
11  "createdAt": "2024-06-10T09:15:30Z",
12  "events": [
13    {
14      "createdAt": "2024-06-10T09:16:00Z",
15      "id": "evt_8f3b2c9d7a1e4f2b",
16      "message": "Generation started",
17      "organizationId": "org_9a8b7c6d5e4f3g2h",
18      "payload": {
19        "inputParameters": {
20          "model": "runtype-v1",
21          "temperature": 0.7
22        }
23      },
24      "sessionId": "sess_1234567890abcdef",
25      "stage": "generating",
26      "type": "info",
27      "userId": "user_4d3c2b1a0f9e8d7c"
28    }
29  ],
30  "expiresAt": "2024-06-17T09:15:30Z",
31  "id": "sess_1234567890abcdef",
32  "organizationId": "org_9a8b7c6d5e4f3g2h",
33  "plan": {
34    "name": "Pro Plan",
35    "limits": {
36      "maxSessions": 1000,
37      "maxRequestsPerMinute": 60
38    }
39  },
40  "prd": {
41    "productId": "prod_9876543210fedcba",
42    "name": "AI Content Generator",
43    "version": "1.3.0"
44  },
45  "productObject": {
46    "type": "text-generation",
47    "config": {
48      "maxTokens": 512,
49      "language": "en"
50    }
51  },
52  "productObjectHash": "a1b2c3d4e5f67890123456789abcdef0",
53  "schemaVersion": "1.0.0",
54  "status": "generating",
55  "updatedAt": "2024-06-10T09:20:00Z",
56  "userId": "user_4d3c2b1a0f9e8d7c"
57}
Returns a generation session with its associated events.
Was this page helpful?
Previous

Delete a generation session

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired
Session ID

Response

Session with events
assemblyStatemap from strings to any or null
catalogVersionstring or null
createdAtstring
eventslist of objects
expiresAtstring
idstring
organizationIdstring or null
planmap from strings to any or null
prdmap from strings to any or null
productObjectmap from strings to any or null
productObjectHashstring or null
schemaVersionstring or null
statusenum
Allowed values:
updatedAtstring
userIdstring

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error