Pictory
  1. Bulk Video Generation APIs
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
        POST
      • Step2: Upload Project
        POST
      • Step3: Update Variables
        POST
      • Step 4: Get Video Preview
        GET
      • Step 5: Render Video
        PUT
      • Step 6: GET Video Download URL
        GET
  • 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. Bulk Video Generation APIs

Step2: Upload Project

Develop Env
https://dev.your-api-server.com
Develop Env
https://dev.your-api-server.com
POST
/v1/templates
Request Request Example
Shell
JavaScript
Java
Swift
Response Response Example
{
    "templateId": "20240516090002850WuJusmZLLCeXMHi",
    "name": "Pending Loan Payment(1)",
    "language": "en",
    "published": true,
    "depricated": false,
    "audio": {
        "musicUrl": "https://tracks.melod.ie/track_versions/8198/MEL357_03_1_The_Move_%28Full%29_Chiara_Kickdrum.mp3?1632623615",
        "musicVolume": 0.1,
        "aiVoice": {
            "speaker": "Adam",
            "speed": 100,
            "amplifyLevel": 0
        }
    },
    "scenes": [
        {
            "sceneId": "20240516090001732n7kGVPq29bPywyQ",
            "subtitles": [
                {
                    "text": "Dear {{customer_name}},"
                }
            ],
            "backgroundVisual": {
                "visualUrl": "https://media.gettyimages.com/id/1460325253/video/handshake-congratulations-and-business-people-meeting-welcome-or-thank-you-for-success.mp4?b=1&s=mp4-640x640-gi&k=20&c=yAbN8GJxxWDVsj-yX-iV4vG_k4-_7IJdBA94D2M30T0=",
                "type": "video"
            }
        },
        {
            "sceneId": "20240516090002830Eiicz536TVyyMdp",
            "subtitles": [
                {
                    "text": "We trust this <strong>video</strong> finds you well and that progress on your new house is going smoothly."
                }
            ],
            "backgroundVisual": {
                "visualUrl": "https://media.gettyimages.com/id/473207285/video/time-lapse-view-of-building-a-house.mp4?b=1&s=mp4-640x640-gi&k=20&c=sobGuwbUbsZStTIoLlyEVT2X4Q6kQJPz2Fych6SyMfw=",
                "type": "video"
            }
        },
        {
            "sceneId": "20240516090003831jU3oex6SI5hdvbr",
            "subtitles": [
                {
                    "text": "As of {{payment_date}}, the payment for {{loan_account_number}} is currently outstanding."
                }
            ],
            "backgroundVisual": {
                "visualUrl": "https://media.gettyimages.com/id/1354359306/video/sticky-note-that-says-to-celebrate-the-repayment.mp4?b=1&s=mp4-640x640-gi&k=20&c=0ircTOf74ptUNCsZxkDaWcrPYBXE7-el56ChibD4f2U=",
                "type": "video"
            }
        },
        {
            "sceneId": "20240516090004831LUKUTBaRCvetUIi",
            "subtitles": [
                {
                    "text": "Timely payments are crucial to maintain a positive financial relationship and ensure the smooth operation of your account."
                }
            ],
            "backgroundVisual": {
                "visualUrl": "https://dm0qx8t0i9gc9.cloudfront.net/watermarks/video/SLT9PsAAFkzcrqd4b/videoblocks-315z_builders6_h4-ctwnci__3d7d6a5a15ecb984ec945b41ed4c418c__P480.mp4?type=preview&origin=VIDEOBLOCKS&timestamp_ms=1715336772913&publicKey=NFKFzias7JkF35W3n9edUuQV1Rnn7udTDco3ZbvzlsXgiAzLXO0a15shkgbMNmXZ&organizationId=103776&apiVersion=2.0&stockItemId=347366487&resolution=480p&endUserId=718890439cf9899e412f4e3d6c8148c452fb5959&projectId=dev&searchId=e87c5f9a-8634-4556-8d9e-c6dd6f658c69&searchPageId=4f1aad32-cb49-45cf-8f19-92d1c7bd504b",
                "type": "video"
            }
        },
        {
            "sceneId": "20240516090005831k4S8gyNSc5YtHOy",
            "subtitles": [
                {
                    "text": "If you have already made the payment, we sincerely <strong>apologize</strong> for any inconvenience caused and kindly request you to disregard this reminder."
                }
            ],
            "backgroundVisual": {
                "visualUrl": "https://media.gettyimages.com/id/2076950150/video/closeup-woman-hands-paying-credit-card-over-terminal-at-store-client-payment.mp4?b=1&s=mp4-640x640-gi&k=20&c=tVhjhWKOjF2DFg1lqAMtQwHCVHYbps8cgd7zwWTAm2Q=",
                "type": "video"
            }
        },
        {
            "sceneId": "20240516090006831ifdyAXHt2oafBWF",
            "subtitles": [
                {
                    "text": "However, if the payment is still pending, we <strong>encourage</strong> you to settle the outstanding amount as soon as possible."
                }
            ],
            "backgroundVisual": {
                "visualUrl": "https://media.gettyimages.com/id/809817018/video/payments.mp4?b=1&s=mp4-640x640-gi&k=20&c=gw4wZJpxghP0gO4pm6WtGqCcnmTRx6nZd9aGC3-aeto=",
                "type": "video"
            }
        },
        {
            "sceneId": "20240516090007832s69idmLVjPByhLI",
            "subtitles": [
                {
                    "text": "Prompt payment not only helps you avoid any additional charges or penalties but also ensures the continued support and services from [Company Name]."
                }
            ],
            "backgroundVisual": {
                "visualUrl": "https://media.gettyimages.com/id/1356815198/video/animation-of-payment-terminal-over-banknotes-statistics-and-financial-data-processing.mp4?b=1&s=mp4-640x640-gi&k=20&c=ymJaZF03Ld9X_pYGH5ru_r6-E_VQDQqBb37tMhJ7afg=",
                "type": "video"
            }
        },
        {
            "sceneId": "20240516090008849MN81M4nzNRcX8Zu",
            "subtitles": [
                {
                    "text": "For your convenience, you can make the payment through our secure <strong>online portal</strong> [Link], or you can refer to the <strong>payment instructions</strong> provided in your loan agreement."
                }
            ],
            "backgroundVisual": {
                "visualUrl": "https://media.gettyimages.com/id/150487265/video/online-payment.mp4?b=1&s=mp4-640x640-gi&k=20&c=AW96b7WR5dZALO_P9Fsx88XcBtnUyh-EXUPKWSFCUHE=",
                "type": "video"
            }
        },
        {
            "sceneId": "202405160900098499xcyZsuLJqL8kT1",
            "subtitles": [
                {
                    "text": "Should you have any <strong>questions</strong> or require <strong>assistance</strong> regarding your payment or account status, please feel free to contact our <strong>customer service</strong> team at {{customer_support_number}}or send email to {{support_email_id}}."
                }
            ],
            "backgroundVisual": {
                "visualUrl": "https://media.gettyimages.com/id/971028990/video/assistant-helping-client-with-online-banking-application-on-tablet-bill-payment.mp4?b=1&s=mp4-640x640-gi&k=20&c=wxuoAQGzMetQ6vHV4nW1V140jwfLuLWQJQsyxcNqmXQ=",
                "type": "video"
            }
        },
        {
            "sceneId": "20240516090010849IRwnOEw1bkrEgL5",
            "subtitles": [
                {
                    "text": "We are here to assist you."
                }
            ],
            "backgroundVisual": {
                "visualUrl": "https://media.gettyimages.com/id/150093405/video/customer-support.mp4?b=1&s=mp4-640x640-gi&k=20&c=ZnscyojurnkbgHj-4DkC4Ej5QQFwhu5eFUoV13tgOyI=",
                "type": "video"
            }
        },
        {
            "sceneId": "20240516090011850Wt4cJyU6kjQOfxO",
            "subtitles": [
                {
                    "text": "Thank you for your <strong>attention</strong> to this matter."
                }
            ],
            "backgroundVisual": {
                "visualUrl": "https://media.gettyimages.com/id/1433131322/video/compliment-and-praise-message-sign.mp4?b=1&s=mp4-640x640-gi&k=20&c=zRY2OmuMVwhIPTN3WFmxqx-E30yKbHdKG8fzGbXqkM0=",
                "type": "video"
            }
        },
        {
            "sceneId": "20240516090012850jGztUHpL5SvvdwD",
            "subtitles": [
                {
                    "text": "We appreciate your <strong>cooperation</strong> in resolving this issue promptly."
                }
            ],
            "backgroundVisual": {
                "visualUrl": "https://media.gettyimages.com/id/805833812/video/process-of-payment.mp4?b=1&s=mp4-640x640-gi&k=20&c=2QK70CFSSUaC4WQY762sksbQAQZXgC-YmWf-ftz_mFw=",
                "type": "video"
            }
        }
    ],
    "templateData": {
        "customer_name": "CUSTOMER_NAME",
        "payment_date": "PAYMENT_DATE",
        "loan_account_number": "LOAN_ACCOUNT_NUMBER",
        "customer_support_number": "CUSTOMER_SUPPORT_NUMBER",
        "support_email_id": "SUPPORT_EMAIL_ID"
    }
}

Request

Header Params
X-Pictory-User-Id
string 
required
Example:
{{X-Pictory-User-Id}}
Authorization
string 
required
Example:
{{access_token}}
Content-Type
string 
required
Example:
application/octet-stream
Body Params application/octet-stream
Not configured

Responses

🟢201Step2: Upload Project
application/json
Body
templateId
string 
required
name
string 
required
language
string 
required
published
boolean 
required
depricated
boolean 
required
audio
object 
required
musicUrl
string 
required
musicVolume
number 
required
aiVoice
object 
required
scenes
array [object {3}] 
required
sceneId
string 
required
subtitles
array [object {1}] 
required
backgroundVisual
object 
required
templateData
object 
required
customer_name
string 
required
payment_date
string 
required
loan_account_number
string 
required
customer_support_number
string 
required
support_email_id
string 
required
Modified at 2024-07-10 08:41:40
Previous
Step 1: Authenticate
Next
Step3: Update Variables
Built with