Core concepts
The main objects and lifecycle behind the Sume developer platform.
This page is the job and admission map: catalog, jobs, artifacts, usage. For a product map of Agents, Formats, Models, and clients, refer to Sume basics.
Sume generation workflows use a small set of public objects: catalog items, media inputs, jobs, artifacts, usage entries, and dashboard resources.
Platform domains
| Domain / URL | Role |
|---|---|
www.sume.com/dashboard | Dashboard home and operator surfaces. |
www.sume.com/dashboard/api-keys | API key management. |
www.sume.com/dashboard/jobs | Job inspection. |
www.sume.com/dashboard/usage | Usage and balance summary. |
www.sume.com/dashboard/subscription | Billing & subscription / credit purchases. |
www.sume.com/playground | Avatar playground. |
api.sume.com | Public Developer API (/v1) and OpenAPI (/reference/json). |
media.sume.com | First-party generated media artifacts. |
Catalog
GET /v1/catalog is the best first call for programmatic discovery. It
lists available capabilities, model ids, endpoint paths, runtime readiness, and
pricing metadata.
Jobs
Generation requests create durable jobs. A job tracks request metadata, status, public provider model, result, public error, events, and webhook delivery state.
The supported statuses are:
Generation lifecycle
If a client disconnects or times out locally, keep the job id. Then recover with the jobs API. Do not submit duplicate paid work.
Artifacts
Completed jobs can include public artifacts under https://media.sume.com.
Sume-owned artifact URLs are the public contract. Raw provider URLs are not.
Media inputs
Launch generation requests accept public HTTPS media URLs in schema-defined
fields, for example input.image_url, product_image, scene.image_url, and
video_url (face-swap / captions). Normal integrations do not need a separate
asset upload step. The API returns generated outputs as Sume-hosted
artifacts under media.sume.com. Refer to Media inputs.
Usage
All usage is in credits. Provider-backed generation can reserve its estimated
credits. It can capture the credits that it used on success. It can return them on
failure, or on cancellation before capture. Use /v1/balance and /v1/usage to
examine the current credits and the ledger entries.
Dashboard
The dashboard mirrors the API surfaces for humans: