Quickstart

Create an API keyCopy Anchor Link

In the Synqed app, open Settings → API keys → Create key. Name it (e.g. quickstart), choose the Read & write preset, and leave data access on Workspace-wide.

Copy the key — it starts with sk_live_ and is shown once. Store it in an environment variable:

export SYNQED_API_KEY="sk_live_us_…"

Verify the keyCopy Anchor Link

curl https://api.synqed.dev/v1/me \
  -H "Authorization: Bearer $SYNQED_API_KEY"

The response shows the workspace, region, permissions, and data access the key carries.

Push a documentCopy Anchor Link

Documents are keyed by source (a label for your system) and external_id (the record's id there). Pushing the same pair again updates the document instead of duplicating it.

curl https://api.synqed.dev/v1/documents \
  -H "Authorization: Bearer $SYNQED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "source": "handbook",
    "external_id": "deploys",
    "title": "How we deploy",
    "body": "We deploy from main with a canary at 5% for 30 minutes. Rollbacks go through the deploy bot.",
    "url": "https://wiki.example.com/deploys"
  }'

The text is encrypted at rest and indexed for search within a few seconds.

Search the brainCopy Anchor Link

curl https://api.synqed.dev/v1/search \
  -H "Authorization: Bearer $SYNQED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "query": "how do canary deploys work?", "limit": 5 }'

Results span every resource the key can read — your document, plus tickets, PRs, Slack discussions and decisions from connected tools.