SynchronexBack to synchronex.ai
Docs
Synchronex

Getting Started

OverviewQuickstartAuthentication

Core Concepts

Identity KernelMemoryDecisions FeedAI WorkersWorkspaces / Teams

Integration

REST APIMCP ServerMCP ToolsCloud Developer ModeOAuthSendinelBYOK

Reference

API ReferenceChangelog

REST API

Synchronex API

Programmatic access to Synchronex memory, scope, BYOK credentials, kernel exports, and AI cost telemetry.

8 min read

Base URL

Production requests use https://synchronex.ai/api/v1. Local development uses http://localhost:3010/api/v1.

Authenticate with Authorization: Bearer sx_live_YOUR_KEY or an OAuth access token beginning with sxo_.

Endpoints

GET
/api/v1/memory/identity

Get Identity Kernel

read
PUT
/api/v1/memory/identity

Update Identity Kernel

write
GET
/api/v1/memory/product/{name}/state

Get Product State

read
POST
/api/v1/memory/product/{name}/state

Update Product State

write
GET
/api/v1/memory/search

Search memory and product state

read
GET
/api/v1/memory/export-mif

Export portable Memory Interchange Format

read
POST
/api/v1/memory/import-mif

Import portable Memory Interchange Format

write
POST
/api/v1/memory/consolidate

Run async memory consolidation

write
GET
/api/v1/memory/decisions/search

Search Decision Index

read
POST
/api/v1/memory/decisions

Create Decision

write
DELETE
/api/v1/memory/decisions/{id}

Delete Decision

write
POST
/api/v1/ingest/{project_id}

Ingest Project Signal

write
GET
/api/v1/ai/costs

Get AI Cost Summary

read
GET
/api/v1/ai/costs/{product}

Get Product AI Costs

read
GET
/api/v1/byok

List BYOK Credentials

read
POST
/api/v1/byok

Create BYOK Credential

write
DELETE
/api/v1/byok/{id}

Delete BYOK Credential

write
GET
/api/v1/kernel/export

Export Active Kernel

read
POST
/api/v1/kernel/export

Export Active Kernel

read
GET
/api/v1/scope

Get Active Scope

read
PATCH
/api/v1/scope

Set Active Scope

write

First Read

bash
curl https://synchronex.ai/api/v1/memory/identity \
  -H "Authorization: Bearer sx_live_YOUR_KEY"
ts
const res = await fetch('https://synchronex.ai/api/v1/memory/identity', {
  headers: { Authorization: 'Bearer sx_live_YOUR_KEY' },
})
const identity = await res.json()

Write Schemas

POST and PUT endpoints accept JSON and return JSON unless the endpoint is an export route.

EndpointBody shape
/memory/identity PUT{ identity?, products?, constraints?, model_preferences? }
/memory/product/{name}/state POST{ status?, what_works?, what_is_blocked?, open_questions?, next_session_starts_here? }
/memory/decisions POST{ decision, product_name, reasoning?, affects_products? }
/byok POST{ service, label, key }
/scope PATCH{ workspace_id: string | null }

Pagination and Limits

List endpoints use bounded query parameters such as limit, offset, and days where applicable. Rate limit headers are included on authenticated API responses and reflect the active minute or day window.

HeaderMeaning
X-RateLimit-LimitMaximum requests in the active window
X-RateLimit-RemainingRequests remaining in the active window
X-RateLimit-ResetUnix timestamp when the active window resets
Retry-AfterSeconds to wait after a 429 response

OpenAPI

Machine-readable OpenAPI 3.1 is served from /api/v1/openapi.json, /api/v1/openapi.yaml, and the root alias /openapi.yaml. Update src/lib/api/v1/openapi.ts in the same PR as any v1 route contract change so SDK generation stays aligned.

Error Response

json
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing, expired, or revoked bearer token."
  }
}

Common codes: UNAUTHORIZED, FORBIDDEN, NOT_FOUND, RATE_LIMITED, VALIDATION_ERROR, TIER_REQUIRED, INTERNAL_ERROR.

json
{
  "error": "rate_limit_exceeded",
  "retry_after": 30,
  "limit": 60,
  "remaining": 0,
  "reset_at": "2026-05-03T12:01:00.000Z"
}