Skip to main content
Custom scenes let you define reusable prompt templates scoped to specific AI models and product categories. Once created, reference a scene by its scene_id in any generation request — this keeps your prompts consistent across products and makes bulk generation straightforward.

​
Scene Management Flow

1

List available scenes

Retrieve all scenes available to your account, including both predefined scenes provided by estudjo and any scenes you have created.
Each entry in the response includes name, scene_id, and type (predefined or user_created).
2

Inspect a scene

To view the full details of a scene you created — including its description and prompt — fetch it by ID. This endpoint is only available for user_created scenes.
3

Create a scene

Send a POST request with a name, target models and categories, and the prompt text.
The response includes the server-generated scene_id:
The scene_id is generated server-side and is permanent — save it to use in generation requests.
4

Use the scene in a generation

Pass the scene_id as the scene field in your POST /generate request body:
See Generate Image or Generate Video for full request examples.
5

Update a scene

You can update the name, description, and prompt of a scene at any time. The models, categories, and scene_id are immutable and cannot be changed after creation.
6

Archive a scene

When you no longer need a scene, archive it with a DELETE request.
Archiving is permanent — there is no restore endpoint. Archived scenes cannot be used in new generation requests.

​
Validation Rules

Keep these constraints in mind when creating or updating scenes:
  • Name must be at least 5 characters long
  • Prompt cannot be empty
  • models and categories are set at creation time and cannot be updated afterward