estudjo API: List Scenes with GET /scenes Endpoint

GET /scenes returns both predefined (estudjo-provided) and user-created scenes. Only name, scene_id, and type are returned here — use GET /scenes/{scene_id} for full details of your own scenes.

Endpoint

string

required

Your API key.

GET https://v1.api.estudjo.com/scenes

Query Parameters

string

Filter by category slug (e.g. womens-clothing).

string

Filter by full model identifier (e.g. estudjo/economic-video). URL-encode the slash as %2F.

string

Pass user_created to list only your own scenes. Any other value returns 400.

integer

Page number. Defaults to 1.

integer

Number of results per page. Accepted range: 1–250. Defaults to 250.

Example Request

curl 'https://v1.api.estudjo.com/scenes?category=womens-clothing&type=user_created&limit=50' \
  -H 'X-Api-Key: YOUR_API_KEY'

Response

200 — Success

{
  "success": true,
  "data": {
    "scenes": [
      { "name": "Lit-Modern Room", "scene_id": "54fde974-7b3a-4cda-bec3-b82aed8ddb32", "type": "predefined" },
      { "name": "Grand Historic Interior", "scene_id": "59b4a671-1b90-453e-92c3-a28ceee177af", "type": "user_created" }
    ],
    "page": 1,
    "per_page": 250,
    "total": 2
  }
}

array

Array of scene objects matching your query.

Show Scene object

string

Display name of the scene.

string

UUID uniquely identifying the scene.

string

Either predefined (estudjo-provided) or user_created (owned by your account).

integer

The current page number returned.

integer

The number of results per page used for this response.

integer

Total number of scenes matching the query across all pages.

Requesting a page number beyond the last page returns an empty scenes array — total is still populated with the full count. This is not treated as an error.

Errors

Code	HTTP	Cause
`invalid_input`	400	`page` is not a positive integer, `limit` is outside `1`–`250`, or `type` is not `user_created`.

Health

API Keys

Wallet

Generations

Scenes

estudjo API: List Scenes with GET /scenes Endpoint

Endpoint

Query Parameters

Example Request

Response

200 — Success

Errors

​Endpoint

​Query Parameters

​Example Request

​Response

​200 — Success

​Errors

Endpoint

Query Parameters

Example Request

Response

200 — Success

Errors