/v1/transcription

Develop Env

https://dev.your-api-server.com

POST

/v1/transcription

This v1 endpoint only supports English video transcription and does not provide video highlights. To obtain a highlight reel, make a call to /v1/transcription/highlights

The v2 transcription provides a number of updates:

Multi-language support.

Highlights are now directly available, no separate endpoint call needed.

Highlight reels available: 30s, 1m, 5m, and 10m.

The response includes txt (full transcription), and srt/vtt with caption timings. In v1, this requires manual sentence assembly and timing extraction.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://dev.your-api-server.com/v1/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", //Text language: English only
    "webhook":"{{webhookurl}}" //Use default webhook in Postman. Custom option coming soon
}'

Response Example

{
    "data": {
        "jobId": "6830fe00-872b-4e96-86b5-e4b527f0295b"
    },
    "success": true
}

Request

Header Params

Authorization

string

required

Example:

X-Pictory-User-Id

string

required

Used for logging purposes

Example:

Body Params application/json

fileUrl

string

required

mediaType

string

required

language

string

required

webhook

string

required

Examples

Responses

🟢200/v1/transcription

application/json

Body

data

object

required

jobId

string

required

success

boolean

required

Modified at 2024-07-10 08:41:40

/v2 GET Default Transcription & Highlights Settings

/v1 GET Default Transcription Settings