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

OperationEndpoint
Generate an imagePOST /v1/image-router/generate
List image modelsGET /v1/image-router/models
Get an image modelGET /v1/image-router/models/{model_id}

Video

OperationEndpoint
Generate a videoPOST /v1/video-router/generate
List video modelsGET /v1/video-router/models
Get a video modelGET /v1/video-router/models/{model_id}

Jobs

OperationEndpoint
Get job statusGET /v1/jobs/{id}/status
Get a job resultGET /v1/jobs/{id}/result
Get a jobGET /v1/jobs/{id}
List jobsGET /v1/jobs
Cancel a jobPOST /v1/jobs/{id}/cancel

Models and prices

OperationEndpoint
List open modelsGET /v1/open/catalog
Get an open modelGET /v1/open/catalog/{model_id}
Estimate a pricePOST /v1/open/estimate
Top up your balancePOST /v1/open/top-ups
Get a top-upGET /v1/open/top-ups/{id}