Skip to content

[docs-agent] Add Admin API + Usage APIs skill coverage (DX-3680) - #45

Merged
CodesMcCabe merged 1 commit into
skills/aggregated-2026-08-24from
skills/dx-3680-admin-usage-apis
Aug 24, 2026
Merged

CodesMcCabe merged 1 commit into
skills/aggregated-2026-08-24from
skills/dx-3680-admin-usage-apis

Conversation

@alchemy-bot

Copy link
Copy Markdown
Contributor

Stacked on top of #44. Once #44 merges, GitHub auto-rebases this PR onto main.

Addresses DX-3680 — Apps Management + Usage APIs skill coverage. Split out from the aggregated queue-drain PR so reviewers can evaluate this surface separately.

Summary

Adds skill coverage for Alchemy's public Admin API (now unhidden as of 2026-08 per docs PRs #1525 / #1531 / #1534) plus the CLI wrappers for it.

Files changed

6 files (3 canonical + 3 mirror), +330 lines. One NEW reference file.

  • NEW skills/alchemy-api/references/operational-admin-api.md — full reference for the Admin API REST surface at api.g.alchemy.com/admin-api/v1/...:
    • Documents the Apps endpoints (list, get, create, update, delete, allowlist management for addresses/origins/IPs).
    • Documents the Chains endpoints (canonical chain identifier list used by apps create/update).
    • Documents the Usage endpoints (summary + timeseries), with plan-based range limits (Free 7d / PAYG 30d / longer via sales) and the truncation behavior (server returns the allowed range without erroring).
    • Notes the 2026-08 usd-metric removal from /usage/timeseries (still valid on /usage/summary).
    • Enumerates the six time-series product IDs (SUPERNODE_CU, SUPERNODE_ENHANCED_CU, NOTIFY_CU, BUNDLER_CU, PAYMASTER_CU, SUBSCRIPTION_BYTES) with their meters.
    • Documents Bearer-token auth (distinct from URL-embedded RPC API keys) and the API key rotation flow with the 2-minute grace window (per PR #1487).
    • Cross-references the CLI wrappers and MCP tools so agents can route to the right execution surface.
  • skills/alchemy-cli/SKILL.md — new ### Usage and metering section:
    • alchemy usage summary — full flag surface (--start-date, --end-date, --app-ids, --networks, --metrics amount,usd).
    • alchemy usage timeseries — full flag surface (granularity, products, metrics, filters, group-by).
    • Range limits by plan (Free 7d / PAYG 30d).
    • --metrics semantics: timeseries accepts only amount; summary accepts both amount and usd (per PR #1526).
    • Pointer paragraph before the section noting that app and usage are thin wrappers over the Admin API, with a link to operational-admin-api.md.
  • skills/alchemy-api/references/skill-map.md — new indexed row for operational-admin-api.md under the Operational section.

Plus the three matching plugins/alchemy/skills/... mirror updates (regenerated via plugins/alchemy/scripts/sync_from_catalog.py, byte-identical to canonical).

Source docs

  • alchemyplatform/docs#1525 — Nav restructure (Admin API → Apps / Chains / Usage each with own hidden flag) and indexer support for /docs/admin-api/{apps|chains|usage}/... stable URLs.
  • alchemyplatform/docs#1534 — Unhide Apps + Chains (Usage still hidden but self-serve for app-scoped queries).
  • alchemyplatform/docs#1531 — Time-series products table and usd-metric drop from timeseries examples.
  • alchemyplatform/docs#1526 — Remove usd from --metrics flag on alchemy usage timeseries.
  • alchemyplatform/docs#1487 — Document API key rotation flow (2-minute grace window).
  • alchemyplatform/docs#1408 — Original alchemy usage CLI namespace.
  • alchemyplatform/docs#1419 — Usage API range limits.

Notes for reviewers

Requested by

@SahilAujla (via Slack thread)

Documents Alchemy's public Admin API surface (Apps + Chains + Usage endpoints) as a new skill reference, and adds the alchemy usage summary / alchemy usage timeseries CLI commands to the alchemy-cli skill.

Base: skills/aggregated-2026-08-24 (PR #44). Stack this on top of the aggregated PR; once #44 merges, this rebases onto main automatically.

Refs DX-3680

Requested-by: @SahilAujla
@CodesMcCabe
CodesMcCabe merged commit d07a1ad into skills/aggregated-2026-08-24 Aug 24, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants