API Reference
Complete reference for the VectorAmp REST API. All endpoints are accessible through the VectorAmp API gateway.
Gateway Architecture
The VectorAmp API gateway is the public entry point for SDK, CLI, and REST traffic. API routes are unprefixed and are routed to the service that owns the resource:
| Path Prefix | Service | Technology |
|---|---|---|
/datasets/* | WebService / VectorAmp Core | Express / Node.js + Rust |
/api-keys/* | WebService | Express / Node.js |
/org-secrets/* | WebService / VectorAmp Core | Express / Node.js + Rust |
/embeddings/* | WebService / VectorAmp Core | Express / Node.js + Rust |
/intelligence/* | Intelligence | Python / FastAPI |
/ingestion/* | Ingestion | Python / FastAPI |
/connections/* | Ingestion | Python / FastAPI |
/auth/* | WebService / SuperTokens | Express / Node.js |
Public API paths are unprefixed. The legacy /v1 prefix is deprecated — it still routes for backward compatibility but should not be used in new code. An /api/v1 prefix is not routed at all (returns 404). Use the unprefixed paths shown throughout this reference.
Dashboard-only routes may still use SuperTokens session authentication, but client-facing API examples should prefer the unprefixed public API.
Base URL
https://api.vectoramp.com
Authentication
Public API endpoints require a VectorAmp API key. Keys have the format vsk_<64hex>. Pass it with X-API-Key:
X-API-Key: vsk_<64hex>
Authorization: Bearer <api_key> is also accepted by the gateway, but X-API-Key is the recommended form for SDKs, CLI, and cURL examples. The gateway resolves the organization from the API key, so client requests do not need to send X-Organization-Id.
API keys can be generated from the VectorAmp dashboard for SDK and CLI access.
Content Type
All request and response bodies use JSON:
Content-Type: application/json
Common Conventions
All resource identifiers (dataset IDs, job IDs, schedule IDs, source IDs, organization IDs) are UUID v4 format. Path parameters always expect UUIDs, not resource names.
Example: 550e8400-e29b-41d4-a716-446655440000
HTTP Status Codes
| Code | Description |
|---|---|
200 | Success |
201 | Created |
204 | No Content (successful deletion) |
400 | Bad Request — invalid parameters |
401 | Unauthorized — missing or invalid auth |
403 | Forbidden — insufficient permissions |
404 | Not Found — resource doesn't exist |
409 | Conflict — resource already exists |
429 | Rate Limited |
500 | Internal Server Error |
API Sections
- Datasets — Create, manage, search, delete vectors, and configure vector datasets
- Embeddings — Configure managed embeddings and organization provider secrets
- Jobs — Monitor and manage ingestion jobs
- Schedules — Automated ingestion scheduling
- Sources — Data source management, cleanup, and file access
- Connections — OAuth grants for authenticated sources (Google, Atlassian)
- Intelligence — RAG queries with streaming support