docs: Add API key permissions#361
Merged
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Explains how admins can scope developer API keys to specific endpoints, lists the available permissions and the endpoints they cover, and walks through the create / edit flows in the account UI. Co-Authored-By: Claude Code
List every publicly documented v2 and v3 endpoint each scope grants, with links to the matching API reference pages, and clarify that endpoints without a permission requirement remain accessible to scoped keys. Co-Authored-By: Claude Code
Co-Authored-By: Claude Code
Co-Authored-By: Claude Code
sejla
force-pushed
the
AE-485/api-key-permissions
branch
from
16590eb to
b5b57df
Compare
wints
reviewed
Jun 12, 2026
Contributor
There was a problem hiding this comment.
@sejla I think this page belongs in the "Admin" section of the "Documentation" tab rather than "API Reference" tab, since it's not actually an API spec. Does that make sense? It could also be a section or sub-page of "Managing API Keys", if not a standalone page: https://deepl-c950b784-ae-485-api-key-permissions.mintlify.app/docs/getting-started/managing-api-keys
Relocate the API key permissions content out of the Admin API reference into a new section of the self-admin Managing API keys guide, where the dashboard-based workflow belongs. - Reframe from admin-centric to developer voice - Replace raw <style>/<table>/JSX with Markdown tables and Frame images to match peer pages - Use sentence case headings consistent with the destination page - Revert managing-admin-keys title to sentence case - Remove the standalone page and its nav entry
- Add a private-beta callout and 'when to use scoped keys' table - Add a Voice API limitation note and an example 403 response body - Use bold subsection headings to keep the page TOC clean - Fix the 'API Keys & Limits' tab name and Admin API eligibility copy - Add a June 15 changelog entry and drop the shipped roadmap item
Cap the create, edit-menu, and edit-dialog screenshots so the portrait and small-UI images render in proportion instead of stretching full-width.
wints
approved these changes
Jun 15, 2026
wints
changed the title
wints
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new section to "Managing API keys" page describing API key permissions (scopes): how scoped vs. unrestricted developer keys behave, the available scopes and the endpoints each one covers, and how admins create or edit a key's scopes from the account UI. Also updates the endpoint reference to document the 403 returned when a scoped key lacks a required scope.
Details