Skip to content

docs(usage-api): add Usage API reference via remote spec (blocked on dashboard#8050) #1403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
lohnim wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

docs(usage-api): add Usage API reference via remote spec (blocked on dashboard#8050) #1403

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eb40c49
docs(usage-api): add Usage API reference under the Admin API section
lohnim Jun 24, 2026
60b74df
docs(usage-api): use admin-api.alchemy.com as the server
lohnim Jun 24, 2026
03ea226
docs(usage-api): use remote spec instead of vendored copy
lohnim Jun 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions content/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,9 @@ navigation:
- api: Admin API Endpoints
api-name: admin-api
flattened: true
- api: Usage API Endpoints
api-name: usage-api
flattened: true
Comment on lines +128 to +130

@dslovinsky dslovinsky Jun 24, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this actually be under Admin API? I thought it was a separate API entirely

@alchemy-bot alchemy-bot Jun 25, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Usage API is served under admin-api.alchemy.com (path-routed through the Apps API ALB via /v1/usage*), so nesting it beneath the Admin API in docs.yml matches where it actually lives operationally — even though it's a logically distinct product surface. If we'd rather present it as its own top-level API in the docs nav, that's an easy reshuffle into a separate section. Deferring to your preference on the nav structure; happy to split it out if you'd like.

- section: Activity Log
hidden: true
contents:
Expand Down
4 changes: 4 additions & 0 deletions content/remote-specs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
"name": "admin-api",
"url": "https://admin-api.alchemy.com/openapi.yaml"
},
{
"name": "usage-api",
"url": "https://admin-api.alchemy.com/v1/usage/openapi.json"
},
{
"name": "wallet-api",
"url": "https://txe-api-specs.docs.alchemy.com/wallet/openrpc.yaml",
Expand Down
Loading