Skip to main content

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:

ParameterTypeDefaultDescription
limitinteger20Items per page (1-100)
cursorstringnullCursor 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

ResourceDescription
EnvironmentsManage isolated environments
ConnectionsDatabase connection management
Embedding ProvidersEmbedding API credentials
Vector TablesVector table CRUD and backfill
QuerySemantic search
SyncSync status and control