Keys
List your API keys
Returns the active keys, newest first.
GET
/user/api-keysTL;DR
| Question | Answer |
|---|---|
| What does it do? | List your API keys. |
| What does it take? | Nothing. |
| What does it return? | Status 200 with a body of type ApiKeyList. |
| What can go wrong? | 401 not signed in; 429 too many requests. Every failure uses the one error envelope. |
What it does
Returns the active keys, newest first. A key is shown as its first characters and its last four. revealable says whether the full value can be asked for with the reveal route.
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The active keys. | ApiKeyList |
| 401 | Not signed in. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
Response body
A 200 answer has the type ApiKeyList.
| Field | Type | Required | Description |
|---|---|---|---|
items | ApiKeySummary[] | yes | |
items[].id | string | yes | |
items[].name | string | yes | |
items[].prefix | string | yes | |
items[].last4 | string | yes | |
items[].createdAt | integer | yes | Milliseconds since the epoch. |
items[].lastUsedAt | integer | null | yes | Milliseconds since the epoch, or null if never used. |
items[].revealable | boolean | yes | True when the full key can be shown again with the reveal route. False for a key made before that was possible, or on a server that cannot seal keys. |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |