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
      • GETGet API key permission options
      • GETList API keys
      • POSTCreate API key
      • GETGet aggregate API key analytics
      • GETReveal test key plaintext
      • GETGet API key
      • PUTUpdate API key
      • DELDelete API key
      • POSTRegenerate API key
      • GETGet API key analytics
Dashboard
LogoLogo
Runtype APIAPI Keys

List API keys

GET
/v1/api-keys
GET
/v1/api-keys
$curl https://api.runtype.com/v1/api-keys \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json"
1{
2  "apiKeys": [
3    {
4      "id": "a1b2c3d4-e5f6-7890-ab12-cdef34567890",
5      "name": "Primary API Key",
6      "keyPrefix": "runtype_",
7      "searchHint": "primary-key",
8      "permissions": [
9        "read",
10        "write",
11        "delete"
12      ],
13      "isActive": true,
14      "expiresAt": "2024-12-31T23:59:59Z",
15      "lastUsedAt": "2024-04-20T14:22:10Z",
16      "createdAt": "2023-01-15T09:30:00Z",
17      "updatedAt": "2024-04-01T10:00:00Z",
18      "maskedKey": "runtype_************1234",
19      "isTestKey": false,
20      "canReveal": true
21    }
22  ],
23  "total": 1,
24  "timestamp": "2024-04-20T15:00:00Z"
25}
List the authenticated user's API keys.
Was this page helpful?
Previous

Create API key

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Response

API keys
apiKeyslist of objects
totalinteger
timestampdatetime

Errors

401
Unauthorized Error
500
Internal Server Error