Keys
Reveal an API key
Shows the full value of one of your keys again, when a sealed copy was kept.
POST
/user/api-keys/{id}/revealTL;DR
| Question | Answer |
|---|---|
| What does it do? | Reveal an API key. |
| What does it take? | id in the path. |
| What does it return? | Status 200 with a body of type RevealedApiKey. |
| What can go wrong? | 401 not signed in; 403 the request came from an origin that may not make changes; 404 no such key; 409 this key has no sealed copy to show; 429 too many requests; 503 revealing keys is not set up on this server. Every failure uses the one error envelope. |
What it does
Shows the full value of one of your keys again, when a sealed copy was kept. Audited by key id, never by value.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The key, with its full value. | RevealedApiKey |
| 401 | Not signed in. | ErrorResponse |
| 403 | The request came from an origin that may not make changes. | ErrorResponse |
| 404 | No such key. | ErrorResponse |
| 409 | This key has no sealed copy to show. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Revealing keys is not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type RevealedApiKey.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
key | string | yes | The full key. |
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 |