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 client tokens
      • POSTCreate client token
      • GETGet client token
      • PUTUpdate client token
      • DELDelete client token
      • GETGet client token value
      • POSTRegenerate client token
      • GETList conversations for client token
Dashboard
LogoLogo
Runtype APIClient Tokens

Get client token

GET
/v1/client-tokens/:id
GET
/v1/client-tokens/:id
$curl https://api.runtype.com/v1/client-tokens/id \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json"
1{
2 "clientToken": {
3 "id": "ct_9f8b7a6c-1234-4d56-8e9f-0a1b2c3d4e5f",
4 "name": "Customer Support Token",
5 "flowIds": [
6 "flow_abc123def456"
7 ],
8 "defaultFlowId": "flow_abc123def456",
9 "agentIds": [
10 "agent_789xyz456uvw"
11 ],
12 "allowedOrigins": [
13 "https://app.example.com",
14 "https://dashboard.example.com"
15 ],
16 "environment": "test",
17 "pinToVersion": "v1.2.3",
18 "rateLimitPerMinute": 60,
19 "rateLimitPerHour": 1000,
20 "maxMessagesPerSession": 500,
21 "sessionIdleTimeoutMinutes": 30,
22 "config": {
23 "enableLogging": true,
24 "maxRetries": 3
25 },
26 "isActive": true,
27 "tokenPrefix": "CST",
28 "tokenHint": "Support token for web app",
29 "tokenValue": "a1b2c3d4e5f6g7h8i9j0",
30 "lastUsedAt": "2024-06-10T15:45:30Z",
31 "createdAt": "2023-11-01T09:00:00Z",
32 "updatedAt": "2024-06-01T12:00:00Z",
33 "conversationCount": 1245
34 }
35}
Get a client token by ID with conversation count.
Was this page helpful?
Previous

Update client token

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired

Response

Client token details
clientTokenobject

Errors

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