Get a key
Retrieve one of your keys: what you called it, when you made it, and when it last let something in.
This endpoint also answers QUERY, with the same parameters sent in the request body. How QUERY works.
Path parameters
Sent as JSON. Anything not listed here is ignored.
The id of the key.
Returns
A key object. A key belonging to somebody else answers 404, which is also what a key that never existed answers.
The key.
Always api_key. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from.
The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes.
Everything the record holds.
What the key is for, between 3 and 255 characters, as the person who minted it wrote it. Two keys may share a name; the id is what tells them apart.
What the key was minted for: script for something you wrote yourself, assistant for an assistant connecting over MCP. It tells the two apart on the security screen and in your account log, and it restricts nothing: a key of either kind reaches exactly what you reach.
Whether the key reaches the values of fields marked sensitive. False unless that was chosen when the key was minted, because a key is handed to a device and an address book on a phone can be read by the other applications on it.
Whether the key reaches the support queue of the whole instance. Only an administrator of the instance can mint such a key, and only when it was chosen at that moment.
When the key last let something in, as a count of seconds, or null if it never has. A key with null here has been minted and never used.
When the key stops working, as a count of seconds, or null when it never does. Every key issued today is null: expiry is not something this API sets yet.
When the key was minted, as a count of seconds since 1970.
When the row last changed, as a count of seconds, or null. Using a key changes it, so in practice it tracks last_used_at.
Where to find this record.
The absolute address this record is read from.
Rate limit
Sixty requests per minute, per user, shared by every key and device. Every answer carries the budget left in X-RateLimit-Remaining.
Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.