ScenebrewDevelopers
API reference

API reference

Every operation of api.scenebrew.com, rendered from the published OpenAPI contract.

This reference is generated from the OpenAPI document the API itself serves at /openapi.json. Contract version 0.14.0, published as @scenebrew/public-api-spec 0.14.0.

Every operation takes an API key as a Bearer token and answers errors as application/problem+json — see Authentication and Errors. Each page has a playground that sends real requests with your key from your browser to the API; nothing passes through this site.

MethodPathSummary
GET/v1/meGet Me
GET/v1/me/creditsGet Credits
GET/v1/modelsList Models
GET/v1/projectsList Projects
POST/v1/projectsCreate Project
GET/v1/projects/{project_id}Get Project
PATCH/v1/projects/{project_id}Update Project
DELETE/v1/projects/{project_id}Delete Project
POST/v1/filesUpload Files
GET/v1/files/{file_id}Get File
GET/v1/projects/{project_id}/scenesList Scenes
POST/v1/projects/{project_id}/scenesCreate Scene
GET/v1/scenes/{scene_id}Get Scene
PATCH/v1/scenes/{scene_id}Update Scene
DELETE/v1/scenes/{scene_id}Delete Scene
GET/v1/scenes/{scene_id}/sessionsList Scene Sessions
GET/v1/scenes/{scene_id}/artifactsList Scene Artifacts
GET/v1/scenes/{scene_id}/artifacts/{kind}Get Scene Artifact
PUT/v1/scenes/{scene_id}/artifacts/{kind}Upload Scene Artifact
GET/v1/scenes/{scene_id}/artifacts/{kind}/contentDownload Scene Artifact
POST/v1/scenes/{scene_id}/stepsRun Scene Step
GET/v1/projects/{project_id}/sessionsList Sessions
POST/v1/projects/{project_id}/sessionsCreate Session
GET/v1/sessions/{session_id}Get Session
PATCH/v1/sessions/{session_id}Update Session
DELETE/v1/sessions/{session_id}Delete Session
GET/v1/sessions/{session_id}/messagesList Session Messages
POST/v1/sessions/{session_id}/messagesSend Session Message
POST/v1/sessions/{session_id}/contextLink Session Context
DELETE/v1/sessions/{session_id}/context/{kind}/{entity_id}Unlink Session Context
GET/v1/operations/{operation_id}Get Operation
GET/v1/operationsList Operations
POST/v1/operations/{operation_id}/cancelCancel Operation
GET/v1/projects/{project_id}/themesList Themes
POST/v1/projects/{project_id}/themesCreate Theme
GET/v1/themes/{entity_id}Get Theme
PATCH/v1/themes/{entity_id}Update Theme
DELETE/v1/themes/{entity_id}Delete Theme
GET/v1/projects/{project_id}/designsList Designs
POST/v1/projects/{project_id}/designsCreate Design
GET/v1/designs/{entity_id}Get Design
PATCH/v1/designs/{entity_id}Update Design
DELETE/v1/designs/{entity_id}Delete Design
GET/v1/projects/{project_id}/recipesList Recipes
POST/v1/projects/{project_id}/recipesCreate Recipe
GET/v1/recipes/{entity_id}Get Recipe
PATCH/v1/recipes/{entity_id}Update Recipe
DELETE/v1/recipes/{entity_id}Delete Recipe
GET/v1/projects/{project_id}/assetsList Assets
POST/v1/projects/{project_id}/assetsCreate Asset
GET/v1/assets/{entity_id}Get Asset
PATCH/v1/assets/{entity_id}Update Asset
DELETE/v1/assets/{entity_id}Delete Asset
GET/v1/assets/{asset_id}/files/{role}Download Asset File
PUT/v1/assets/{asset_id}/files/{role}Replace Asset File
POST/v1/assets/{asset_id}/filesAdd Asset File
GET/v1/themes/{theme_id}/exportExport Theme
POST/v1/themes/{theme_id}/designsLink Theme Design
DELETE/v1/themes/{theme_id}/designs/{design_id}Unlink Theme Design
POST/v1/designs/{design_id}/recipesLink Design Recipe
DELETE/v1/designs/{design_id}/recipes/{recipe_id}Unlink Design Recipe
POST/v1/recipes/{recipe_id}/assetsLink Recipe Asset
DELETE/v1/recipes/{recipe_id}/assets/{asset_id}Unlink Recipe Asset
DELETE/v1/recipes/{recipe_id}/slots/{slot}Unlink Recipe Slot
GET/v1/design-typesList Design Types
GET/v1/recipe-typesList Recipe Types
POST/v1/projects/{project_id}/generationsGenerate Library Entity
POST/v1/recipes/{recipe_id}/previewPreview Recipe

Rate limits

No per-key limits are enforced today; here is how they will look when they arrive.

Get Me GET

Next Page