DocsAPI reference

REST API overview

HTTP endpoints exposed by seedkit — synthetic data sampling and deterministic avatar rendering.

seedkit ships two REST surfaces, each focused on a different use case:

SurfacePathAuthUse it for
Data API/api/v1/data/<dataset>sk_live_ PAT (Pro+)Sampling from seedkit's curated identity / company / post / product / review pools.
Avatar API/api/avatars/<seed>noneDeterministic SVG avatars for any seed.

Both are read-only, return JSON (or SVG for avatars), and are deterministic — given the same inputs, you get the same response bytes.

Base URL

https://app.seedkit.dev

Response shape

JSON endpoints return a stable envelope:

{
  "data": [ /* records or single record */ ],
  "dataset": "identities"
}

List responses also include count and total_available. See the per-endpoint pages for full details.

Versioning

The Data API is versioned in the URL (/api/v1/...). Backward-compatible additions — new fields on records, new datasets, new query parameters — can happen at any time without a version bump. Breaking changes will move to /api/v2/... and the previous version will be supported for at least 12 months.

The Avatar API is unversioned; the renderer guarantees byte-stable output for any given seed + style.

See also

PreviousExisting PostgresNext Authentication