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

/v2 GET Default Transcription & Highlights Settings

Develop Env
https://dev.your-api-server.com
Develop Env
https://dev.your-api-server.com
GET
/v1/jobs/{{job_id}}
The response depends on job status. View variations by selecting a response from the Example Response section's top-right dropdown.
Upon successful completion, transcription and highlights settings are returned.
The transcription settings from this response should be used to build out the scene data of the Render Video call.
The response includes txt (full transcription), and srt and vtt with caption timings. In v1, this required manual sentence assembly and timing extraction.
The response provides highlight reel settings: 0.5 (30s), 1.0 (1m), 2.0 (2m), 5.0 (5m), and 10.0 (10m). Reference the highlight setting object that matches your desired highlight duration.
Note: by making the GET Default Transcription & Highlights Settings call, transcription data is automatically captured in the Postman environment.
To view the capture method see API call Tests.
To view the stored data in the Postman environment, see values: transcript_settings, mediaInfo_settings, original_transcription, original_srt, original_vtt, video_highlights_for_30_seconds_settings, video_highlights_for_1_minute_settings, video_highlights_for_2_minutes_settings, video_highlights_for_5_minutes_settings, video_highlights_for_10_minutes_settings
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://dev.your-api-server.com/v1/jobs/{{job_id}}' \
--header 'Authorization: {{access_token}}' \
--header 'X-Pictory-User-Id: {{X-Pictory-User-Id}}'
Response Response Example
200 - Default Transcription & Highlight Settings - Default Transcription & Highlight Settings
{
    "success": true,
    "data": {
        "transcript": [
            {
                "uid": "f6e87197-21e7-4c9b-864d-f73ca54f5f4c",
                "speakerId": 1,
                "words": [
                    {
                        "uid": "ef4b1282-5b34-45a2-984d-d84e6700756e",
                        "word": "",
                        "start_time": 0,
                        "end_time": 0.88,
                        "sentence_index": 0,
                        "is_pause": true,
                        "pause_size": "small",
                        "state": "active",
                        "speakerId": 1
                    },
                    {
                        "uid": "6d6c0e2d-ac40-4775-9d1d-86bb7607d0fa",
                        "word": "Once",
                        "start_time": 0.88,
                        "end_time": 1.12,
                        "speakerId": 1,
                        "sentence_index": 0
                    },
                    {
                        "uid": "eb1159b1-40f2-48e2-b8e8-d6f810ac34b9",
                        "word": "again,",
                        "start_time": 1.12,
                        "end_time": 1.4399999,
                        "speakerId": 1,
                        "sentence_index": 0
                    },
                    {
                        "uid": "b20c6fc7-2659-4f63-8293-9de7b038aef7",
                        "word": "I",
                        "start_time": 1.4399999,
                        "end_time": 1.52,
                        "speakerId": 1,
                        "sentence_index": 0
                    },
                    {
                        "uid": "a58bf5ae-ea38-4986-b179-b8639959a449",
                        "word": "want",
                        "start_time": 1.52,
                        "end_time": 1.76,
                        "speakerId": 1,
                        "sentence_index": 0
                    },
                    {
                        "uid": "ff489c17-0ea3-4f77-bb1a-d0322fc6c6e0",
                        "word": "to",
                        "start_time": 1.76,
                        "end_time": 1.92,
                        "speakerId": 1,
                        "sentence_index": 0
                    },
                    {
                        "uid": "4188046e-ecb5-4087-a29b-a0d647acebf2",
                        "word": "welcome",
                        "start_time": 1.92,
                        "end_time": 2.32,
                        "speakerId": 1,
                        "sentence_index": 0
                    },
                    {
                        "uid": "ec837e3f-48b7-4b86-bbb9-4e1961a18c30",
                        "word": "prime",
                        "start_time": 2.32,
                        "end_time": 2.56,
                        "speakerId": 1,
                        "sentence_index": 0
                    },
                    {
                        "uid": "e0ac1a2a-ed79-41eb-a566-83407bc5648c",
                        "word": "minister",
                        "start_time": 2.56,
                        "end_time": 2.96,
                        "speakerId": 1,
                        "sentence_index": 0
                    },
                    {
                        "uid": "d43222be-e753-485a-9c6e-63c44dbaecd2",
                        "word": "Trudeau",
                        "start_time": 2.96,
                        "end_time": 3.1999998,
                        "speakerId": 1,
                        "sentence_index": 0
                    },
                    {
                        "uid": "dafba551-de8e-4d6b-925c-b7511e1040bc",
                        "word": "to",
                        "start_time": 3.1999998,
                        "end_time": 3.36,
                        "speakerId": 1,
                        "sentence_index": 0
                    },
                    {
                        "uid": "decd54d8-bf6f-4964-8961-7aa42dc0beb3",
                        "word": "the",
                        "start_time": 3.36,
                        "end_time": 3.4399998,
                        "speakerId": 1,
                        "sentence_index": 0
                    },
                    {
                        "uid": "5aa9245f-98a8-4496-b956-e8aa8205f804",
                        "word": "White",
                        "start_time": 3.4399998,
                        "end_time": 3.6799998,
                        "speakerId": 1,
                        "sentence_index": 0
                    },
                    {
                        "uid": "8be57457-b531-4bc8-892b-b83828803392",
                        "word": "House.",
                        "start_time": 3.6799998,
                        "end_time": 4.29,
                        "speakerId": 1,
                        "sentence_index": 0
                    }
                ],
                "before": [

Request

Header Params
Authorization
string 
required
Example:
{{access_token}}
X-Pictory-User-Id
string 
required
Used for logging purposes
Example:
{{X-Pictory-User-Id}}

Responses

🟢200Default Transcription & Highlight Settings
application/json
Body
success
boolean 
required
data
object 
required
transcript
array [object {11}] 
required
url
string 
required
mediaInfo
object 
required
txt
string 
required
srt
string 
required
vtt
string 
required
debug_analysis
object 
required
debug_analysis_request
string 
required
highlights
object 
required
job_id
string 
required
🟢200Transcription in Progress
Modified at 2024-07-10 08:41:40
Previous
/v2/transcription (Transcript & Highlights)
Next
/v1/transcription
Built with