README.md

---
title: ColPali Backend API
emoji: 🔍
colorFrom: blue
colorTo: purple
sdk: docker
pinned: false
license: apache-2.0
suggested_hardware: t4-small
---

# ColPali Backend API

This Space provides the backend services for ColPali visual document retrieval:
- **Hono Proxy API** on port 7860
- **ColPali Embedding Service** on port 8001 (internal)

## API Endpoints

### Query Endpoint
```
POST /api/query
Content-Type: application/json

{
  "query": "your search query",
  "limit": 10
}
```

### Health Check
```
GET /api/health
```

## Usage

Configure your frontend to point to:
```
https://[your-username]-[space-name].hf.space
```

## Environment Variables

Set these in your HF Space settings:
- `VESPA_ENDPOINT`: Your Vespa cluster endpoint
- `VESPA_CERT_PATH`: Path to Vespa certificates
- `CORS_ORIGIN`: Allowed origins for CORS (default: *)