REST API Reference#

OpenAPI Schema#

The complete OpenAPI schema is available in JSON format in the following locations:

  • File: openapi_schema_cds.json

  • Live Documentation: http://localhost:8888/v1/docs (when running locally)

  • Raw Schema Endpoint: http://localhost:8888/v1/openapi.json

Interactive Documentation#

When the CDS service is running, you can access the interactive API documentation:

  • Swagger UI: http://localhost:8888/v1/docs

  • ReDoc: http://localhost:8888/v1/redoc

Practical Examples#

For hands-on curl examples and practical usage, refer to the API User Guide.

Key Endpoints Overview#

The CDS API provides the following main endpoint categories:

Health & Status#

  • GET /v1/health - Service health check

  • GET /v1/pipelines - List available pipelines

Collection Management#

  • POST /v1/collections - Create new collection

  • GET /v1/collections - List all collections

  • GET /v1/collections/{collection_id} - Get collection details

  • DELETE /v1/collections/{collection_id} - Delete collection

Document Indexing#

  • POST /v1/collections/{collection_id}/documents - Index documents

  • POST /v1/collections/{collection_id}/embeddings - Bulk embeddings ingestion

  • POST /v1/collections/{collection_id}/status - Check ingestion status

Search & Retrieval#

  • POST /v1/collections/{collection_id}/search - Semantic search

  • POST /v1/collections/{collection_id}/search/hybrid - Hybrid search

Pipeline Operations#

  • GET /v1/pipelines/{pipeline_id}/collections - Get pipeline collections

  • GET /v1/pipelines/{pipeline_id}/visualize - Visualize pipeline

Secrets Management#

  • POST /v1/secrets - Store secrets

  • GET /v1/secrets - List secrets

  • DELETE /v1/secrets/{secret_name} - Delete secret

Authentication#

Currently, the CDS API does not require authentication for local development. For production deployments, refer to the AWS EKS Deployment Guide for security configuration.

Rate Limits#

Refer to the API Guide for current rate limits and usage guidelines.