Skip to content

Add API user guide for script writers - #115

Merged
ForisKuang merged 1 commit into
mainfrom
docs/api-user-guide
Oct 8, 2026
Merged

ForisKuang merged 1 commit into
mainfrom
docs/api-user-guide

Conversation

@ForisKuang

Copy link
Copy Markdown
Collaborator

What

Documentation only; no code changes.

  • New docs/api.md: a user guide for MSK staff calling ACGC from scripts.
    • Getting an API key from the /api-keys page, and the key rules: expiry, revoking, 60 requests a minute, and keys can't manage keys.
    • A first request, then each /v1/genes/* endpoint with its request body and every response field.
    • Background jobs, how caching and force_refresh affect speed, and every error code with what to do about it, including the per-gene errors in batch responses.
    • A complete Python example that runs a job, checks on it and handles 429.
  • README links:
    • A pointer to the guide near the top.
    • Links at the start of the "ACGC API Keys (for scripts)" and "Gene query API" sections.
    • The old ## API Keys heading, which is about outside services ACGC itself uses (Anthropic, NCBI…), is renamed to ## Third-Party API Keys (used by ACGC) and points script writers to the right place. Nothing in the repo linked to the old #api-keys anchor.

Accuracy

Field names, limits and status codes were checked against the code on main:

- docs/api.md: getting an API key, first request, endpoints, request and
  response fields, background jobs, speed/caching, error codes, Python example.
- README: link the guide from the intro, the API-keys and gene-query sections;
  rename the third-party key section so it isn't confused with ACGC API keys.
@ForisKuang
ForisKuang merged commit fc96de2 into main Oct 8, 2026
4 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.

1 participant