Skip to content
FlixMLFlixML Docs

Create Project

POST
/api/projects
curl --request POST \
  --url https://example.com/api/projects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "id": "example", "title": "example", "description": "example", "aspect_ratio": "9:16", "duration_seconds": 1, "status": "draft", "characters": [ "example" ], "narrator_voice": { "provider": "elevenlabs", "voice_id": "example", "name": "example", "settings": {} }, "metadata": {} }'

Create a new project (script) with title, aspect ratio, and cast.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ProjectRecord
object
id
Any of:
string
title
required
Title
string
>= 1 characters
description
Any of:
string
aspect_ratio
Aspect Ratio
string
default: 9:16
duration_seconds
Any of:
integer
status
Status
string
default: draft
characters
Characters
Array<string>
narrator_voice
Any of:
VoiceConfig

TTS voice configuration for a character or narrator.

object
provider
Provider
string
default: elevenlabs
voice_id
required
Voice Id
string
name
Any of:
string
settings
Settings
object
key
additional properties
any
metadata
Metadata
object
key
additional properties
any

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
ProjectRecord
object
id
Any of:
string
title
required
Title
string
>= 1 characters
description
Any of:
string
aspect_ratio
Aspect Ratio
string
default: 9:16
duration_seconds
Any of:
integer
status
Status
string
default: draft
characters
Characters
Array<string>
narrator_voice
Any of:
VoiceConfig

TTS voice configuration for a character or narrator.

object
provider
Provider
string
default: elevenlabs
voice_id
required
Voice Id
string
name
Any of:
string
settings
Settings
object
key
additional properties
any
metadata
Metadata
object
key
additional properties
any
Example
{
  "aspect_ratio": "9:16",
  "status": "draft",
  "narrator_voice": {
    "provider": "elevenlabs"
  }
}

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"
    }
  ]
}