Skip to main content
GET

Get Project

Retrieve detailed information about a specific video project, including its current processing status, metadata, and download links when available.
This endpoint requires authentication and has a rate limit of 100 requests per hour.

Authentication

string
required
Your Submagic API key starting with sk-

Path Parameters

string
required
The unique identifier (UUID) of the project to retrieve

Response

string
Unique identifier of the project (UUID format)
string
The title of the project
string
AI description of the project
string
Language code used for transcription
string
Current processing status: processing, transcribing, exporting, completed, or failed
string
Webhook URL if provided in the request
string
Template name applied to the project (if using a built-in template)
string
User theme ID applied to the project (if using a custom theme)
string
Preset ID applied to the project (if using a preset)
string
AI edit template applied to the project (if any): kelly, karl, or ella
string
Direct download URL for the processed video (available when status is completed)
string
Direct URL that can be embedded on your website or used to play the video directly (available when status is completed)
string
User-friendly preview page URL where the exported project can be previewed or downloaded: https://app.submagic.co/view/{projectId} (available when status is completed)
string
Current transcription status: PROCESSING, COMPLETED, or FAILED
string
Reason for failure if status is failed
boolean
Whether automatic zoom effects are enabled for the video
boolean
Whether automatic B-roll insertion is enabled for the video
number
Percentage of automatic B-rolls to include in the video (0-100)
string
Pace setting for automatic silence removal: natural, fast, or extra-fast
boolean
Whether automatic bad takes and silence removal is enabled
boolean
Whether automatic audio cleanup (noise removal) is enabled
boolean
Whether captions are disabled for the video
object
Video metadata extracted from the source
string
ISO 8601 timestamp when the project was created
string
ISO 8601 timestamp when the project was last updated
array
Array of transcribed words and silence segments with timing information (available when transcription is completed)
array
Array of generated Magic Clips (only present for Magic Clips projects)