API Reference

OpenAPI spec

The OpenAPI spec is public and machine-readable for SDK generation, docs, and contract tests.

Overview

The public OpenAPI URL does not require login.

It describes the hosted control-plane API and public request/response shapes.

Use it for generated clients, docs, and API contract tests.

Developer notes

Keep OpenAPI public and unauthenticated.
Version breaking API changes.
Generate SDK clients from reviewed specs.
Add contract tests for every public endpoint.

Fetch the spec

curl

curl -fsS https://synapsor.ai/openapi.json > synapsor-openapi.json

Examples

python

import json

with open("synapsor-openapi.json", "r", encoding="utf-8") as handle:
    spec = json.load(handle)

assert "/v1/control/signup-requests/{request_id}/approve" in spec["paths"]