Skip to main content

Locations

Locations are project-scoped settings that can be assigned to scenes. They carry a name, description, and optional background image, all of which inform AI generation and are displayed in the studio UI.

Data model​

FieldTypeDescription
idnumberPrimary key
projectIdnumberOwning project
namestringShort display name
descriptionstringProse description of the setting
tagsstring[]Searchable labels (e.g. interior, sci-fi)
imageUrlstring | nullBackground image URL

Assigning to a scene​

PATCH /scenes/:sceneId/assign-location sets the scene's locationId. In the studio, the location background image is used as the context for start/end frame generation.

AI helpers​

Two AI endpoints help writers manage locations consistently:

  • POST /locations/ai/recommend — suggests new locations given episode context
  • POST /locations/ai/check-duplicate — flags when a proposed location is too similar to an existing one

Both use the LLM service and count against the generation rate limit.

Permission scopes​

ScopeWhat it guards
LOCATION_CREATECreating a location
LOCATION_EDITEditing name / description / tags
LOCATION_DELETEDeleting a location
LOCATION_IMAGE_GENERATEAI image generation
LOCATION_IMAGE_UPLOADManual upload
SCENE_LOCATION_ASSIGNAssigning a location to a scene