/v1/transcription/highlights

Develop Env

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

POST

If using /v2/transcription, this call is unnecessary as it already provides highlight settings for 30s, 1m, 5m, and 10m. This endpoint can capture custom video length highlights, but v1 only supports English transcriptions.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://dev.your-api-server.com/v1/transcription/highlights' \
--header 'Authorization: {{access_token}}' \
--header 'X-Pictory-User-Id: {{X-Pictory-User-Id}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "transcript": {{transcript_settings}},
    "highlight_duration": 30, //Duration in seconds
    "webhook":"{{webhookurl}}" //Use default webhook in Postman. Custom option coming soon
}'

Response Example

{
    "data": {
        "job_id": "0dc6656f-7440-4b69-969b-03c37561b904"
    },
    "success": true
}

Request

Header Params

Authorization

string

required

Example:

X-Pictory-User-Id

string

required

Used for logging purposes

Example:

Body Params application/json

object {0}

Examples

Responses

🟢200/v1/transcription/highlights

application/json

Body

data

object

required

job_id

string

required

success

boolean

required

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

/v1 GET Default Transcription Settings

/v2/transcription/highlights