API reference
API reference
Every operation of the Sume Open API.
Base URL https://api.open.sume.com · Auth Authorization: Bearer <key> or x-api-key: <key> · Body JSON
Every successful response wraps its body in data. Errors return one error object; see Errors and retries. Every response carries x-sume-request-id.
Images
| Operation | Endpoint |
|---|---|
| Generate an image | POST /v1/image-router/generate |
| List image models | GET /v1/image-router/models |
| Get an image model | GET /v1/image-router/models/{model_id} |
Video
| Operation | Endpoint |
|---|---|
| Generate a video | POST /v1/video-router/generate |
| List video models | GET /v1/video-router/models |
| Get a video model | GET /v1/video-router/models/{model_id} |
Jobs
| Operation | Endpoint |
|---|---|
| Get job status | GET /v1/jobs/{id}/status |
| Get a job result | GET /v1/jobs/{id}/result |
| Get a job | GET /v1/jobs/{id} |
| List jobs | GET /v1/jobs |
| Cancel a job | POST /v1/jobs/{id}/cancel |
Models and prices
| Operation | Endpoint |
|---|---|
| List open models | GET /v1/open/catalog |
| Get an open model | GET /v1/open/catalog/{model_id} |
| Estimate a price | POST /v1/open/estimate |
| Top up your balance | POST /v1/open/top-ups |
| Get a top-up | GET /v1/open/top-ups/{id} |