VBase API Reference
Package: dodil.vbase.v1 · Service: VBaseService
VBase is vector-database-as-a-service on Milvus 2.6, fully Milvus-SDK-compatible. This API is the control plane: you use it to provision a database, fetch its connection details, list what you have, and delete it. Once you have an endpoint, all the vector work — creating collections, building indexes, inserting and searching — happens on the data plane, which is Milvus itself.
Control plane vs data plane
VBase has two distinct surfaces, and this reference documents only the first:
| What it does | How you reach it | |
|---|---|---|
Control plane (VBaseService, this API) | Allocate a database, get its access details, list, delete, health-check. | The Dodil gateway — HTTP/gRPC calls described here. |
| Data plane (Milvus) | Collections, schemas, indexes, insert, search, query — the actual vector operations. | The standard Milvus SDK, pointed at the endpoint VBase gives you. See Connecting with the Milvus SDK. |
The key idea: VBase hands you a Milvus endpoint, and you talk to Milvus directly from there. There is no VBase-specific data API to learn — if you know Milvus, you already know the data plane. (An advanced RunCommand bridge exists as a fallback, but the SDK is the primary path.)
The collection / index / search operations are not documented here — they live on Milvus. See Connecting with the Milvus SDK and Recipes.
What’s available today
- Serverless database allocation is GA. Allocate a database, get an endpoint and
db_name, and connect with the Milvus SDK. This is the surface most clients use. - Dedicated clusters and backup/restore are Preview — the RPCs exist but are not generally available yet. They are documented for completeness under Clusters & Backup.
Conventions
Every RPC is reachable over both HTTP (gateway) and gRPC.
| Environment | HTTP base | gRPC target |
|---|---|---|
| Staging | https://api.dev.dodil.io | rpc.dev.dodil.io:443 |
| Production | https://api.dodil.io | rpc.dodil.io:443 |
- HTTP paths are under
/v1/vbase/.... - gRPC reaches every method at
dodil.vbase.v1.VBaseService/<Method>. - Authenticate every request with
Authorization: Bearer <IAM token>. See Auth and Access for how to obtain a token. - gRPC requests use proto field names (snake_case); the HTTP gateway accepts and returns JSON (camelCase). Examples below show HTTP first.
Responses that carry a status wrapper use response, a MsgResp:
message MsgResp {
bool success = 1;
optional string message = 2;
optional uint32 code = 3;
}Sections
- Databases (Serverless) — the GA surface:
AllocateDatabase,GetService,GetServiceAccess,ListServices,DeleteDatabase,HealthCheck. Covers the async allocate → poll → access flow. - RunCommand (Advanced) — a fallback bridge to run Milvus operations through the control plane. Prefer the Milvus SDK.
- Clusters & Backup (Preview) — dedicated-cluster lifecycle and backup/restore. Not generally available yet.
See also
- Connecting with the Milvus SDK — point the Milvus SDK at your allocated endpoint and start working with collections.
- Recipes — end-to-end vector-search examples.
- Auth and Access — tokens, scopes, and access model.