Skip to main content
POST
/
v1
/
video
/
create
Create Video Job
curl --request POST \
  --url https://api.opennote.com/v1/video/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "picasso",
  "messages": [
    {
      "role": "user",
      "content": "<string>"
    }
  ],
  "include_sources": false,
  "search_for": "<string>",
  "source_count": 3,
  "length": 3,
  "script": "<string>",
  "upload_to_s3": false,
  "title": "",
  "webhook_url": "<string>"
}
'
{
  "success": true,
  "message": "<string>",
  "video_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request model for creating a video generation job.

​
model
string | null
default:picasso

The model to use for the video generation

​
messages
BasicMessage · object[] | null

The messages that will be used to generate the video script

​
include_sources
boolean | null
default:false

Whether to gather data from the web to help with the video script

​
search_for
string | null

The query to search the web for

Maximum string length: 100
​
source_count
integer | null
default:3

The number of sources to gather from the web

Required range: 1 <= x <= 5
​
length
integer | null
default:3

The number of paragraphs to generate for the video script

Required range: 1 <= x <= 5
​
script
string | null

The script to use for the video, with sections delimited by '-----'

Maximum string length: 6000
​
upload_to_s3
boolean | null
default:false

Whether to upload the video to S3

​
title
string | null
default:""

The title of the video, if you want to provide one

​
webhook_url
string | null

The Webhook URL to send the video completion response to

Response

Successful Response

Response model for video job creation.

​
success
boolean
required
​
message
string | null
​
video_id
string | null