Quick Start

Get up and running with Gilial’s REST API in 5 minutes.

1. Set Up Your Credentials

Configure your Pinecone credentials in your terminal:

export PINECONE_API_KEY="your-pinecone-api-key"
export PINECONE_INDEX_NAME="your-index-name"
export PINECONE_ENVIRONMENT="us-west-1"  # or your region

2. Start the Gilial Server

Start the Gilial backend:

python backend/main.py

Server will start at http://localhost:8000

3. Check Your Index

curl http://localhost:8000/status

Response:

{
  "index_name": "your-index",
  "total_vector_count": 10000,
  "dimension": 768
}

4. Estimate Savings

Preview how much space you’ll save:

curl http://localhost:8000/estimate?strategy=balanced

Response:

{
  "original_vectors": 10000,
  "compressed_vectors": 9739,
  "savings_pct": 2.61
}

5. Run Compression

Dry-Run Mode (Preview Only)

curl -X POST http://localhost:8000/compress \
  -H "Content-Type: application/json" \
  -d '{"strategy": "balanced", "dry_run": true}'

Apply Compression

curl -X POST http://localhost:8000/compress \
  -H "Content-Type: application/json" \
  -d '{"strategy": "balanced", "dry_run": false}'

Choose Your Strategy

Balanced (default) - Good mix of compression and safety
Aggressive - Maximum compression for space-critical scenarios