Skip to main content

​
Convex backend

Your Convex project holds OpenSync’s database, functions, subscriptions, HTTP API and static-hosting component.

​
Set up your project

Start with the reviewed release in Quick start, then initialize your own deployment:
Set the matching WorkOS client ID and private key on that deployment. Add an OpenAI key only if you need semantic search. Keep development and production separate. Deploy reviewed backend changes to your own production deployment with:
Then upload the frontend using the static-hosting guide. Uploading assets does not deploy backend changes.

​
API and data

The release stores users, sessions, messages, parts, embeddings, wrapped summaries, API logs, usage aggregates and owner-console records. Do not infer that future features are live from files in a separate development checkout. Plugins call /sync/session, /sync/message and /sync/batch. The HTTP health endpoint is /health. REST reads include /api/sessions and /api/sessions/get; see the API reference for parameters. Authenticated endpoints scope access to the API key’s account. Hosted HTTP requests use https://api.opensync.dev. Convex client queries and live subscriptions use https://app.opensync.dev. Use your own deployment’s corresponding URLs for a fork.

​
Operations

Use the Convex dashboard to inspect functions, logs, environment variables and deployment health. Review transaction limits and index behavior before changing queries or migrations. Verify changes against retained session data and old plugin payloads. Managed Convex Cloud is the documented deployment path. Running the backend yourself is a separate operational choice; see requirements.