Pictory
  1. API Reference
Pictory
  • API Flows
    • Text to Video API Flow
      • Step 1: Authenticate
      • Step 2: Generate Video Preview from Text
      • Step 3: GET Video Preview & Default Settings
      • Step 4: Render Video
      • Step 4: Render PUT
      • Step 5: GET Video Download URL
    • Video Editing API Flow
      • Step 1: Authenticate
      • Step 2: Obtain Pictory Upload URL
      • Step 3: Upload video to Pictory
      • Step 4: v2 Transcribe Uploaded Video
      • Step 5: GET Default Transcription & Highlights Settings
      • Step 6: Render Video
      • Step 7: GET Video Download URL
    • Bulk Video Generation APIs
      • Step 1: Authenticate
      • Step2: Upload Project
      • Step3: Update Variables
      • Step 4: Get Video Preview
      • Step 5: Render Video
      • Step 6: GET Video Download URL
  • API Reference
    • /v1/oauth2/token
      POST
    • /v1/video/storyboard
      POST
    • /v1/job/{job_id}
      GET
    • /v1/media/generateUrl
      POST
    • Upload video to Pictory
      PUT
    • /v2/transcription (Transcript & Highlights)
      POST
    • /v2 GET Default Transcription & Highlights Settings
      GET
    • /v1/transcription
      POST
    • /v1 GET Default Transcription Settings
      GET
    • /v1/transcription/highlights
      POST
    • /v2/transcription/highlights
      POST
    • /v1 GET Default Highlight Settings
      GET
    • /v1/video/storyboard/fonts
      GET
    • Create Template
      POST
    • Update Template
      PUT
    • Get Templates
      GET
    • Create Template Video
      POST
    • Get Template By Id
      GET
    • Delete Template By Id
      DELETE
    • /v1/video/render
      POST
    • v1/media/search
      GET
  1. API Reference

/v1/video/storyboard

Develop Env
https://dev.your-api-server.com
Develop Env
https://dev.your-api-server.com
POST
/v1/video/storyboard
This endpoint processes text to set up default video configurations and produce a preview link. Post-call, access the settings and link via the GET Video Preview & Default Settings API call response.
"preview": "https://feature-share-preview.d1tv7y7t27ylrr.amplifyapp.com/preview/5ebf0ad3-6839-4e0c-a569-2e40a67598fb"
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://dev.your-api-server.com/v1/video/storyboard' \
--header 'Authorization: {{access_token}}' \
--header 'X-Pictory-User-Id: {{X-Pictory-User-Id}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "videoName": "Santa Claus", //Desired video file name
    "videoDescription": "Santa Claus is coming to town", //*optional*
    "language": "en", //Text language: English only
    "audio": {
        "autoBackgroundMusic": true, //Automatically add background music
        "backGroundMusicVolume": 0.5, //Decimal range: 0 (mute) to 1 (full). 0.5 = 50% volume
        "aiVoiceOver": {
            "speaker": "Jackson", //English voices. See Pictory WebApp'\''s Audio -> Voice-over.
            "speed": 100, //Speed: 50% (slow) to 200% (fast); 100% is normal
            "amplifyLevel": 0  //AI voice volume: -1 (mute), 0 (normal), up to 1 (double volume)
        }
    },
    "scenes": [
        {
            "text": "In the North Pole, beneath the shimmering stars, Santa Claus, with a merry twinkle in his eyes, gears up for his Christmas ride. His workshop buzzes as elves craft toys, while Santa, in his festive red suit, checks his list of children worldwide. Come Christmas Eve, Santa and his reindeer, guided by Rudolph'\''s bright nose whisk through the sky with Santa'\''s sleigh brimming with gifts. At every stop, Santa descends chimneys, leaves presents, and heartily nibbles on cookies. With the break of dawn, Santa returns home leaving behind a world infused with Christmas magic and love.",
            "voiceOver": true, //AI voice reads the text
            "splitTextOnNewLine": false, //Split scenes on '\''\n'\'' in text
            "splitTextOnPeriod": true //Split scenes at periods
        }
    ]
}'
Response Response Example
{
    "jobId": "5865feea-16c7-4f48-b7d4-a1fc97dc3943",
    "success": true,
    "data": {
        "job_id": "5865feea-16c7-4f48-b7d4-a1fc97dc3943"
    }
}

Request

Header Params
Authorization
string 
required
Example:
{{access_token}}
X-Pictory-User-Id
string 
required
Used for logging purposes
Example:
{{X-Pictory-User-Id}}
Body Params application/json
videoName
string 
required
videoDescription
string 
required
language
string 
required
audio
object 
required
autoBackgroundMusic
boolean 
required
backGroundMusicVolume
number 
required
aiVoiceOver
object 
required
scenes
array [object {4}] 
required
text
string 
optional
voiceOver
boolean 
optional
splitTextOnNewLine
boolean 
optional
splitTextOnPeriod
boolean 
optional
Examples

Responses

🟢200/v1/video/storyboard
application/json
Body
jobId
string 
required
success
boolean 
required
data
object 
required
job_id
string 
required
Modified at 2024-07-10 08:41:40
Previous
/v1/oauth2/token
Next
/v1/job/{job_id}
Built with