Sume basics

Sume is primarily a video agent platform. People author and iterate in chat. Partners invoke saved recipes over HTTP. Each generation tool (Image, Video, Avatar, TTS, timeline, and more) is also available as an HTTP API. But the primary partner path is a call to a sandbox Agent / Format that composes those tools. It is not a set of raw model calls that you connect yourself.

Because of that composition, you can ship deliverables that a single Video 1.0 clip cannot give: multi-minute host footage, B-roll, voiceover, and timeline assembly into a post-ready video.

For job admission, polls, and the mechanics of media.sume.com, refer to Core concepts.

In a nutshell

• Agents — a person in the loop authors with the Agent at sume.com/agents
• Formats / Format API — the primary partner invoke surface
• Models — atomic generation APIs (components in a support role)
• Agent Completions / Scheduled — ad-hoc and repeated agent runs
• SDK — the TypeScript client around the same Developer API
• Dashboard — keys, jobs, usage, billing
• Developer API + media — api.sume.com and media.sume.com
• Workspaces — where keys and spend resolve

Agents

Agents is the chat UI where a person works with the sandbox Agent: write a brief, approve spend, examine artifacts, and shape a house style over a few turns.

People author Formats here. A person can edit a Format in the library, or ask the Agent in chat to save a recipe (SKILL.md plus references). When a human must stay in the loop, interactive chat is the correct surface.

Docs: Agents overview · Safe automation

Formats / Format API

A Format is a saved recipe to author a deliverable. Partners call it by handle and slug. Sume then starts a fresh sandbox, loads the recipe, runs the Agent with generation tools, and returns artifacts and optional structured JSON.

This is the recommended surface for most partners. One HTTP call carries the judgment and orchestration that otherwise live in your own glue code.

Docs: Format API overview · Calling a Format · Bulk runs · Cookbook: embed a Format

Models

Models are atomic generation endpoints. They create an avatar, render a talking clip, generate an image or a short video clip, add captions, and more. They are real product surfaces. Use them when you need one model invocation and nothing else.

They support Formats. A Format decides which tools to call, in which order, and how to assemble the result. If you need only a single clip or image, call the model. If you need a packaged workflow, call a Format.

Docs: Models overview · Video 1.0 · Avatar videos

Agent Completions / Scheduled

It is not necessary to save each agent task as a Format.

Surface	When to use
Agent Completions	A one-off backend task, with nothing to save as a recipe
Scheduled	The same saved task on a cadence (Actions)

Both run the Agent. Completions is ad-hoc, and Scheduled repeats. When the recipe is fixed and only the inputs change, Formats stay the path.

SDK

The TypeScript SDK is a thin client over the same Developer API for Node / Bun / Deno / Workers. It includes subscribeFormatRun, so you do not write your own poll loop. You can also do all of its operations over plain HTTP.

Two more clients exist and still work, but they are not part of the primary path today. They are the CLI for local shells and scripts, and hosted MCP for clients that speak remote MCP. Use them when your environment needs them, not as the default integration.

Dashboard

The dashboard is the surface for human operators. It shows the same workspace that the API key resolves to:

• API keys
• Jobs
• Usage
• Billing & subscription
• Playground

Docs: API keys · Jobs · Usage · Billing

Developer API + media

Domain	Role
api.sume.com	Public Developer API (/v1) and OpenAPI (/reference/json)
media.sume.com	First-party generated media artifacts

Keys authenticate. The API is workspace-scoped. The API returns the generated outputs that belong to Sume as media.sume.com URLs. That is the public artifact contract.

Docs: Public API · API reference · Authentication · Media inputs

Workspaces

API keys and spend resolve to a workspace. The key carries that context. Do not send workspace_id in request bodies. You can reach team-owned Formats on both vanity and opaque paths with a key created in that team workspace. A personal key fails with 403 workspace_key_required. Refer to Team Formats need a team key.

What next?

• Quick start — your first run, in the Agents tab or over the API
• Format API — why Formats exist and how a run works end to end
• Core concepts — jobs, admission, artifacts, usage