Skip to content
Cosdata Documentation

API Overview

Cosdata provides a comprehensive API for interacting with your vector database. This overview will help you understand the key concepts and endpoints.

API Endpoints

Cosdata offers both REST and gRPC interfaces:

  • REST API: Available at http://localhost:8443/api/v1
  • gRPC API: Available at localhost:50051

For the most up-to-date API implementation, you can also check the Cosdata GitHub repository.

Authentication

All API requests require authentication using an API key. You can pass this key in the Authorization header:

Terminal window
Authorization: Bearer YOUR_API_KEY

Common Operations

Collections

  • Create a collection
  • List collections
  • Get collection details
  • Delete a collection

Vectors

  • Insert vectors
  • Search vectors
  • Delete vectors
  • Update vectors

Indexes

  • Create an index
  • List indexes
  • Get index details
  • Delete an index

Transactions

  • Create a transaction
  • Commit a transaction
  • Abort a transaction
  • Perform operations within a transaction

Client Libraries

Cosdata provides official client libraries to simplify integration:

  • Python SDK: A Python client library for Cosdata
  • JavaScript SDK: Coming soon

All client libraries are open-source and available in our GitHub repository.

Error Handling

The API returns standard HTTP status codes:

  • 200 OK: Request succeeded
  • 400 Bad Request: Invalid request
  • 401 Unauthorized: Authentication failed
  • 404 Not Found: Resource not found
  • 500 Internal Server Error: Server error

Support and Community

If you have questions about the API or need help with implementation:

Next Steps

For detailed information about specific endpoints, refer to: