API Endpoint Index¶

This page lists the main public HTTP routes exposed by the current router.

Endpoint Families¶

flowchart TD
    Router[Router] --> Health[Health and readiness]
    Router --> Identity[Version and datasets]
    Router --> Query[Genes transcripts sequence]
    Router --> Diff[Diff routes]
    Router --> Meta[OpenAPI and query validate]

This endpoint-family map gives the fastest overview of the public HTTP surface. It helps readers separate health, identity, query, diff, and metadata routes before drilling into individual paths.

Public Runtime and Health Routes¶

/
/health
/healthz
/healthz/overload
/ready
/readyz
/live
/metrics

Public API Routes¶

/v1/openapi.json
/v1/version
/v1/datasets
/v1/datasets/{release}/{species}/{assembly}
/v1/releases/{release}/species/{species}/assemblies/{assembly}
/v1/genes
/v1/genes/count
/v1/query/validate
/v1/diff/genes
/v1/diff/region
/v1/sequence/region
/v1/genes/{gene_id}/sequence
/v1/genes/{gene_id}/transcripts
/v1/transcripts/{tx_id}

flowchart LR
    Datasets[Dataset identity routes] --> Queries[Query routes]
    Queries --> Diffs[Diff routes]
    Queries --> Meta[Validation and OpenAPI]

This relationship view shows how the route families build on dataset identity. Most useful Atlas query work starts by naming the dataset explicitly and then choosing the query or diff path.

Debug Routes¶

Additional /debug/... routes may be enabled depending on runtime settings. Treat them as operationally sensitive and configuration-dependent rather than universal public surface.

Purpose¶

This page is the lookup reference for api endpoint index. Use it when you need the current checked-in surface quickly and without extra narrative.

Stability¶

This page is a checked-in reference surface. Keep it synchronized with the repository state and generated evidence it summarizes.