Edge API overview
Base URL: https://api.uservane.com
Full shapes: OpenAPI reference and the machine-readable /openapi.yaml.
Publishable key routes
Section titled “Publishable key routes”| Method | Path | Purpose |
|---|---|---|
POST | /v1/sdk/bootstrap | Surveys, suppression, unbound show-tokens |
POST | /v1/sdk/responses | Token-verified response ingest |
POST | /v1/dismissals | Token-verified dismiss + suppression |
Pass the publishable key as body key and/or query key.
Secret key routes
Section titled “Secret key routes”Auth: Authorization: Bearer <uv_sk_...> or X-UserVane-Key: <uv_sk_...>.
| Method | Path | Purpose |
|---|---|---|
POST | /v1/sdk/tokens | Session-bound show-token mint (server-only) |
GET | /v1/sdk/pending-scores | Linked scores awaiting Langfuse push (PII) |
POST | /v1/sdk/pending-scores/ack | Adapter delivery ack |
GET | /v1/privacy/export | DSAR / admin export |
DELETE | /v1/privacy/erase | DSAR erase / survey or account purge |
Design notes (from the wire contract)
Section titled “Design notes (from the wire contract)”- Caps and quiet period are enforced at token issue only.
- A valid unused show-token is always accepted at submit.
- Invalid / expired / reused tokens → 4xx (not 5xx for those cases).
- Pending-scores is tenant-scoped: the secret key only reads that project’s rows.
- Publishable key as Bearer on a secret route → 401.
Internal aliases exist (GET /v1/definitions, POST /v1/responses) with the same shapes as bootstrap/submit. Prefer the /v1/sdk/* paths in new integrations.