Get Transcription Job by ID
Pictory Jobs
Get Transcription Job by ID
Retrieve the status and results of a video transcription job
GET
Get Transcription Job by ID
Documentation Index
Fetch the complete documentation index at: https://docs.pictory.ai/llms.txt
Use this file to discover all available pages before exploring further.
Overview
This endpoint retrieves the current status and results of a transcription job using its unique job ID. While processing is in progress, it returns the current job status. Once the job completes, it returns the full transcript data including word-level timing, speaker identification, and subtitle formats (SRT, VTT).A valid API key is required to use this endpoint. Obtain your API key from the API Access page in your Pictory dashboard.
API Endpoint
Request Parameters
Path Parameters
The unique identifier (UUID) of the transcription job. This value is the
jobId returned by the Video Transcription endpoint.Example: "cbbc5305-3c1c-46f0-bdde-468e5ecd763f"Headers
API key for authentication (starts with
pictai_)Response
In-Progress Response
Returned while the transcription is still being processed:The unique identifier of the transcription job
true while the job is processingCompleted Response
Returned when the transcription has finished successfully. The response contains the full transcript data:true when the job has completed successfullyThe unique identifier of the transcription job
Contains the complete transcription results.
Response Examples
Code Examples
Understanding the Transcript Response
The completed transcription response includes several output formats:| Field | Description |
|---|---|
transcript | Structured array of segments with word-level timing, speaker IDs, and pause markers. Suitable for building custom subtitle renderers or transcript editors. |
txt | Full transcript as plain text. Suitable for search indexing, summarization, or display. |
srt | Transcript in SRT subtitle format. Can be saved directly as a .srt file for video players. |
vtt | Transcript in WebVTT format. Can be saved as a .vtt file for web-based video players. |
mediaInfo | Source media metadata including duration, dimensions, and aspect ratio. |
Pause Markers
Thetranscript array includes pause markers alongside spoken words. These entries are identified by the following characteristics:
is_pauseis set totrue- The
wordfield contains an empty string pause_sizeindicates the duration category (e.g.,"small")
Polling Best Practices
-
Use webhooks when possible. Configure a
webhookURL in the transcription request to receive automatic notification when the job completes, rather than polling. - Implement timeouts. Set a maximum wait time based on the expected file duration. Longer files require more processing time.
-
Handle all states. Verify both the
in-progressstatus and the presence of transcript data in the response to determine completion. - Cache results. Once a transcription job completes, store the results locally. Completed job data may be cleaned after a retention period.
