Skip to main content

No official SDKs yet — use the OpenAPI spec

Synthpop does not publish official client SDKs at this time. Official SDKs are on the roadmap. In the meantime, the API ships a machine-readable OpenAPI specification that every modern tool understands — so you can import it into an API client, generate a typed client in your language, or call the endpoints directly with cURL or requests.
The API is a small, stable REST surface — eight endpoints over a single Task resource. A generated or hand-written client is a short exercise. See the API reference for the full contract.

Get the OpenAPI spec

You can obtain the spec two ways:
  • Live from the API (always current for that environment):
    • Production: https://app.synthpop.ai/public/v1/openapi.json
    • Staging: https://stage.synthpop.ai/public/v1/openapi.json
  • Rendered reference: browse and try every endpoint in the API reference tab, which is generated from the same spec.
Download the production spec
The spec declares two absolute servers — https://app.synthpop.ai/public/v1 (production) and https://stage.synthpop.ai/public/v1 (staging). Most generators pick the first by default; select the staging server when you want to target staging.

Import into an API client

In Postman: Import → File (or paste the spec URL). Postman generates a collection with every endpoint. Add an Authorization: Bearer <token> header (from POST /auth/get_token) at the collection level so it applies to all requests, and set the base URL variable to your environment host.

Generate a client

Any OpenAPI code generator works. With openapi-generator:
Swap -g python for typescript-axios, go, java, or any other supported generator. Point the generated client’s base URL at your environment host (see the warning above), and feed it a bearer token obtained from POST /auth/get_token.
Generated clients are unofficial and unsupported by Synthpop — treat them as a convenience, and pin the generator version so regenerating the spec doesn’t silently reshape your client.

Call it directly

You don’t need any tooling to use the API. Every call is a plain HTTPS request with a bearer token. These are the two patterns used throughout this documentation.
The bearer token is valid for 365 days (about a year). Cache it and re-exchange your api_secret only when the token expires, rather than calling POST /auth/get_token on every request. See Authentication.

API reference

Every endpoint, request shape, and response field — with a live playground.

Quickstart

From an api_secret to your first result in five steps.

Authentication

How to obtain and use a bearer token.

Versioning

Why the v1 in the base URL is the version that matters.