API reference

Every endpoint you can call today with an API key, grouped by resource. Each entry shows the method + path, what it does, its parameters and response fields, a live “Try it”, and the scope it requires.

Scopes gate every call

A key can call only the endpoints whose scope it holds — a key without the required scope gets 403. The scope for each endpoint is shown next to its title. See Authentication for the full scope list.

Conventions

Base URL — https://api.jetwild.com/v1
Auth — Authorization: Bearer <key> on every request.
IDs & paths are mono; {id} / {slug} are path parameters.
Pagination — list endpoints return either { items, total, page, limit, hasMore } (page-based) or { items, cursor, hasMore } (cursor-based); the fields table on each endpoint says which.
Big objects (Scene, Model) are documented once under Objects and linked from the endpoints that return them.

Resources

Scenes — create, read, and manage scenes.
Models — performers + roster, incl. CSV import.
§2257 records — the model records flag + the coming-soon records store.
Batches — bulk upload cohorts + the ledger.
Sites — the paysite network + branded output.
Raw masters — source-file records.
Uploads — the staging queue + upload sources.
Analytics — KPIs, throughput, revenue, studios.
Dashboard — the aggregate console payload.
Search — fuzzy search across scenes/models/batches.
Activity — recent workspace events.
Pipeline — compact live pipeline state.
Catalog snapshots — daily catalog rollups.

Coming-soon APIs are documented separately

Shield, Metadata, Fingerprint, and Distribution are coming soon — documented as product guides under APIs, not here, because they aren’t callable yet. This reference covers only what’s live today. (Scene Intelligence, the pipeline, is live — it’s POST /v1/scenes.)