API references
Where to find the HTTP API description of every service of the Arango Contextual Data Platform
Every service of the Arango Contextual Data Platform exposes an HTTP API, and each is documented in the chapter of the service it belongs to. This page lists them in one place.
| Service | Reference pages | What they cover | Generated API reference |
|---|---|---|---|
| Arango Control Plane (ACP) | Control Plane HTTP API | Install, monitor, and remove platform services, manage projects | ACP |
| File Manager | File Manager HTTP API | Upload and manage RAG input files and code packages | File Manager |
| AutoGraph service | Endpoints and call sequence, Corpus Build, RAG Strategizer, Graph Operations, Embeddings, Project Operations, Error Handling, Limitations | Build the Context Graph, maintain it, and inspect a project | AutoGraph |
| Importer | Endpoints, Import endpoints, Parameters, Limits and Quotas, Error Handling | The worker that builds the Knowledge Graph | Importer Service |
| AutoRAG | Execute Queries, Parameters, Custom Prompts, Error Handling | Query a Context Graph with the different search methods | Retriever Service |
| Graph Analytics | HTTP API for Graph Analytics Engines | Manage engines, load graphs, run algorithms | Graph Analytics Engine |
| GraphML | Notebooks & API | Control GraphML from Jupyter notebooks or Python | arangoml API |
| Natural Language to AQL | API Reference | Generate AQL from natural language | Natural Language to AQL |
| Reasoner | API Reference | Analyze and optimize AQL queries | – |
| Container Manager | Deploy a new service via API | Deploy your own services and apps | File Manager |
| Cypher to AQL | Cypher to AQL Translation Service | Translate Cypher queries to AQL | HTTP API |
For the HTTP API of the ArangoDB database system itself, see the ArangoDB HTTP API.
Changes between releases
- API changes: Breaking and non-breaking API changes per data platform release.
- Service versions: The version of every service that each data platform release bundles.