PricingAPI keys
OverviewQuickstartAuthentication
GenerateModelsImagesVideoUploads
JobsJobs and pollingWebhooks
ReferenceErrors and retriesLimitsClient
BillingBilling
Media toolsOverviewAvatarRemix mediaFace swapMusicTimelineVideo captions
MCPOverviewQuickstartOAuthTools and gates
CLIOverviewInstall and loginCommandsAgent skills
API referenceAPI reference
EnterpriseOverviewAgentsFormatsBest practices

Enterprise

Agents

How Sume developer tools fit into agent workflows.

Sume developer tools use one boundary: the public API is the source of truth, and wrappers stay thin.

Tooling layers

  1. Developer API: workspace-scoped HTTP endpoints.
  2. CLI: shell-friendly wrapper around the Developer API.
  3. Hosted MCP: remote MCP at https://mcp.sume.com/mcp for Cursor, Claude, and similar clients.
  4. Local sume mcp: future CLI surface (coming_soon in current releases). Use hosted MCP or direct CLI commands instead.
  5. Dashboard tools: app-integrated tools with server-resolved workspace context.

Agents must use catalog, jobs, media schema, and usage reads to make a plan. They must do this before they ask for confirmation for write or paid actions. Refer to Safe automation.

Where to start

GoalStart here
Call a saved authoring recipe from your backendFormat API · Format catalog
Interactive Cursor / Claude connectorMCP quickstart
Local shell agent with CLIQuick start · CLI overview
Backend / server integrationQuick start (API) · Public API
Run the Agent on an ad-hoc task from your backendAgent Completions
Run an agent on a recurring scheduleScheduled
Create an API keyAPI Keys dashboard
Agents product UIAgents
Avatar or Image first jobCreate new avatar · Image 1.0

Hosted MCP paid tools include generate_image, generate_video and generate_audio (speech and music) on every connection. An API key on https://api.sume.com/mcp also has music_create, tts_create, stt_create and the Avatar creates. Sume Image 1.0 and Video 1.0 (images_create / videos_create) stay REST-only. For those two products, call the Developer API. Details: MCP overview.

Workspace context

Agent tools must not ask the user for a workspace id. Workspace context comes from the API key or the authenticated app session.

On this page

  1. Tooling layers
  2. Where to start
  3. Workspace context