Skip to content
FlixMLFlixML Docs

Create Project Scene

POST
/api/projects/{project_id}/scenes
curl --request POST \
  --url https://example.com/api/projects/example/scenes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "id": "example", "project_id": "example", "scene_number": 1, "title": "example", "setting": "interior", "weather": "clear", "summary": "example", "location": "example", "time_of_day": "example", "characters": [ "example" ], "metadata": {} }'

Add a scene to a project.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
project_id
required
Project Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
SceneRecord
object
id
Any of:
string
project_id
Any of:
string
scene_number
required
Scene Number
integer
>= 1
title
Any of:
string
setting
Setting
string
default: interior
weather
Weather
string
default: clear
summary
Any of:
string
location
Any of:
string
time_of_day
Any of:
string
characters
Characters
Array<string>
metadata
Metadata
object
key
additional properties
any

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
SceneRecord
object
id
Any of:
string
project_id
Any of:
string
scene_number
required
Scene Number
integer
>= 1
title
Any of:
string
setting
Setting
string
default: interior
weather
Weather
string
default: clear
summary
Any of:
string
location
Any of:
string
time_of_day
Any of:
string
characters
Characters
Array<string>
metadata
Metadata
object
key
additional properties
any
Example
{
  "setting": "interior",
  "weather": "clear"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}