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/transcription (Transcript & Highlights)

Develop Env
https://dev.your-api-server.com
Develop Env
https://dev.your-api-server.com
POST
/v2/transcription
This endpoint generates a transcription and highlights for the video supplied.
This new v2 transcription provides a number of updates over v1:
1.
Multi-language support.
2.
Highlights are now directly available, no separate endpoint call needed.
3.
Highlight reels available: 30s, 1m, 5m, and 10m.
4.
The response includes txt (full transcription), and srt/vtt with caption timings. In v1, this required manual sentence assembly and timing extraction.
Supported Languages
en-US - English, US - English Demo video
en-AU - English, AU - English Demo video
en-GB - English, UK - English Demo video
en-IN - English, IN - English Demo video
en-IE - English, IE - English Demo video
en-AB - English, AB - English Demo video
en-WL - English, WL - English Demo video
fr-CA - French, CA - French Demo video
fr-FR - French, FR - French Demo video
de-CH - German, CH - German Demo video
de-DE - German, DE - German Demo video
it-IT - Italian, IT - Italian Demo video
es-ES - Spanish, ES - Spanish Demo video
es-US - Spanish, US - Spanish Demo video
nl-NL - Dutch, NL - Dutch Demo video
pt-BR - Portuguese, BR - Portuguese Demo video
ja-JP - Japanese, JA - Japanese Demo video
ko-KR - Korean, KO - Korean Demo video
ru-RU - Russian, RU - Russian Demo video
hi-IN - Hindi, IN - Hindi Demo video
ta-IN - Tamil, IN - Tamil Demo video
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://dev.your-api-server.com/v2/transcription' \
--header 'Authorization: {{access_token}}' \
--header 'X-Pictory-User-Id: {{X-Pictory-User-Id}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fileUrl":  "{{uploaded_file_url}}", //Demo video: https://pictory-api-prod.s3.us-east-2.amazonaws.com/b6d6bc06-5060-444f-aeaa-bc4cd6d04811/englishtest
	"mediaType": "video", //Accepted value: video
	"language": "en-US", //Supported Languages listed below
    "webhook":"{{webhookurl}}" //Use default webhook in Postman. Custom option coming soon
}

//Supported Languages
// en-US - English, US - Demo video: https://pictory-api-prod.s3.us-east-2.amazonaws.com/b6d6bc06-5060-444f-aeaa-bc4cd6d04811/englishtest
// en-AU - English, AU
// en-GB - English, UK
// en-IN - English, IN
// en-IE - English, IE
// en-AB - English, AB
// en-WL - English, WL
// fr-CA - French, CA - Demo video: https://pictory-api-dev.s3.us-east-2.amazonaws.com/003ecd73-479c-4b01-9e7d-4de8e5d638e0/frenchtest
// fr-FR - French, FR
// de-CH - German, CH - Demo video: https://pictory-api-dev.s3.us-east-2.amazonaws.com/4a9ea3da-0f4d-4cf9-866d-f58fcc1295a9/germantest
// de-DE - German, DE
// it-IT - Italian, IT - Demo video: https://pictory-api-dev.s3.us-east-2.amazonaws.com/94a138c7-c7cc-4ff2-9a09-910b7507b13a/italiantest
// es-ES - Spanish, ES - Demo video: https://pictory-api-dev.s3.us-east-2.amazonaws.com/fd910d7d-f28f-4f34-bf4d-dc014a0e085d/spanishtest
// es-US - Spanish, US
// nl-NL - Dutch, NL - Demo video: https://pictory-api-dev.s3.us-east-2.amazonaws.com/d0067ac7-bacf-49ee-bac2-582b87777cca/dutchtest
// pt-BR - Portuguese, BR - Demo video: https://pictory-api-dev.s3.us-east-2.amazonaws.com/71c22044-0d38-4c95-87bf-60b1a9250cde/portuguesetest
// ja-JP - Japanese, JA - Demo video: https://pictory-api-dev.s3.us-east-2.amazonaws.com/f2f040e2-b0c6-4d30-9cb7-b6d0f4daa571/japanesetest
// ko-KR - Korean, KO - Demo video: https://pictory-api-dev.s3.us-east-2.amazonaws.com/bdef8e66-fd00-4231-9a98-60981871a260/koreantest
// ru-RU - Russian, RU - Demo video: https://pictory-api-dev.s3.us-east-2.amazonaws.com/9b62e855-5adc-484d-8c31-6e0273702707/russiantest
// hi-IN - Hindi, IN - Demo video: https://pictory-api-dev.s3.us-east-2.amazonaws.com/bcea1f02-f3d1-4c1f-9bb2-62b269b7152b/hinditest
// ta-IN - Tamil, IN - Demo video: https://pictory-api-dev.s3.us-east-2.amazonaws.com/d1168d8b-b132-42a7-91f2-c59398a3b5bd/tamiltest'
Response Response Example
{
    "data": {
        "jobId": "6830fe00-872b-4e96-86b5-e4b527f0295b"
    },
    "success": true
}

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
fileUrl
string 
required
mediaType
string 
required
language
string 
required
webhook
string 
required
Examples

Responses

🟢200/v2/transcription
application/json
Body
data
object 
required
jobId
string 
required
success
boolean 
required
Modified at 2024-07-10 08:41:40
Previous
Upload video to Pictory
Next
/v2 GET Default Transcription & Highlights Settings
Built with