Skip to main content

API Reference

The Embedd.to API is a RESTful JSON API.

Base URL

https://api.embedd.to/v1

Authentication

Embedd.to uses two authentication methods:

Endpoint CategoryAuth MethodHeader
Organizations, members, invitationsSupabase JWTAuthorization: Bearer <jwt>
All other endpointsAPI keyAuthorization: Bearer sk_...

See Authentication for details.

Environment Scoping

API key requests are scoped to an environment via the X-Environment-Id header:

X-Environment-Id: env_abc123

If omitted, requests default to the prod environment.

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"
}
}

See Errors for the full error code reference.

Endpoints

ResourceDescription
AuthPasswordless authentication (OTP, verify, refresh)
OrganizationsOrganization management, members, invitations
API KeysAPI key creation, listing, revocation
EnvironmentsManage isolated environments
ConnectionsDatabase connection management
Embedding ProvidersEmbedding API credentials and model catalog
Vector TablesVector table CRUD, backfill, and schema
QuerySemantic search
SyncSync status and control
TasksBackground task monitoring