Quick start

Sume exposes a workspace-scoped Public API and an agent-friendly CLI. Both follow the same pattern: authenticate, create or search something in the API-key workspace, then read results through stable job and asset endpoints.

Base URL

Use this production base URL unless you are intentionally testing another Sume environment.

1. Authenticate

Create an API key in Sume and keep it server-side.

Check the account and workspace attached to the key:

The API key determines workspace scope. Do not send workspace_id or user_id in request bodies.

2. Check credits

Generation endpoints can spend credits. Check balance and concurrency before creating jobs:

CLI equivalent:

3. Create an image job

The response is accepted asynchronously and includes a job id.

CLI equivalent:

4. Poll status

Common terminal states are completed, failed, canceled, or expired. If the job is still queued, running, or processing, wait and poll again.

CLI equivalent:

5. Fetch result

Result payloads may include safe public media URLs and metadata. Avoid logging full URLs if they contain query strings or private tokens.

CLI equivalent:

6. Search Asset Library

Asset Library returns indexed scene-level records. Use it to find reusable clips, generated outputs, hooks, CTAs, product demos, and source-video metadata.

CLI equivalent:

Next steps

• Use Public API overview for endpoint groups and workflow maps.
• Use Jobs and results for polling and result handling.
• Use Asset Library for scene search and filters.
• Use CLI commands for shell examples.