API Reference
The Embedd.to API is a RESTful JSON API. All endpoints require authentication via API key.
Base URL
https://api.embedd.to/v1
Authentication
Include your API key in the Authorization header:
Authorization: Bearer sk_your_api_key
Environment Scoping
Most endpoints require an environment ID in the X-Environment-Id header:
X-Environment-Id: env_abc123
Pagination
List endpoints support cursor-based pagination:
| Parameter | Type | Default | Description |
|---|---|---|---|
limit | integer | 20 | Items per page (1-100) |
cursor | string | null | Cursor from previous response |
Responses include a pagination object:
{
"data": [...],
"pagination": {
"limit": 20,
"has_more": true,
"next_cursor": "eyJpZCI6ICIxMjMifQ=="
}
}
Error Format
All errors follow a consistent format:
{
"error": {
"code": "resource_not_found",
"message": "Connection 'conn_123' not found",
"resolution": "Verify the connection ID and ensure it belongs to your organization",
"docs_url": "https://embedd.to/errors/resource_not_found",
"request_id": "req_abc123"
}
}
Endpoints
| Resource | Description |
|---|---|
| Environments | Manage isolated environments |
| Connections | Database connection management |
| Embedding Providers | Embedding API credentials |
| Vector Tables | Vector table CRUD and backfill |
| Query | Semantic search |
| Sync | Sync status and control |