API Reference
May 18, 2026 · View on GitHub
This section is the canonical source for protocol and endpoint definitions.
Start Here
- HTTP endpoint reference: openapi.md
- Machine-readable HTTP spec: openapi.yaml
- Cypher function index: cypher-functions/README.md
- Bolt protocol notes: bolt-protocol.md
Find by Interface
Cypher
- Function catalog: cypher-functions/README.md
HTTP (Neo4j-compatible + Nornic extensions)
- Human-readable reference: openapi.md
- OpenAPI source: openapi.yaml
Bolt
- Protocol compatibility notes: bolt-protocol.md
- Driver compatibility context: ../neo4j-migration/feature-parity.md
GraphQL
- Practical usage guide: ../user-guides/graphql.md
Common Questions
- "What endpoint should I call?" → openapi.md
- "Can I generate clients from this API?" → openapi.yaml
- "Which Cypher function should I use?" → cypher-functions/README.md
- "Will my Neo4j driver work?" → ../neo4j-migration/feature-parity.md
Related Docs
- Usage walkthroughs: ../user-guides/README.md
- Troubleshooting by symptom: ../issues-index.md
- Operations and deployment behavior: ../operations/README.md