GET
/
v1
/
projects
/
{id}
curl -X GET "https://api.submagic.co/v1/projects/550e8400-e29b-41d4-a716-446655440000" \
  -H "x-api-key: sk-your-api-key-here"
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "title": "My Awesome Video",
  "language": "en",
  "status": "transcribing",
  "webhookUrl": "https://yoursite.com/webhook/submagic",
  "templateName": "Hormozi 2",
  "transcriptionStatus": "PROCESSING",
  "magicZooms": true,
  "magicBrolls": true,
  "magicBrollsPercentage": 75,
  "videoMetaData": {
    "width": 1920,
    "height": 1080,
    "duration": 185.2,
    "fps": 30
  },
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:32:15.000Z"
}

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

x-api-key
string
required
Your Submagic API key starting with sk-

Path Parameters

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

Response

id
string
Unique identifier of the project (UUID format)
title
string
The title of the project
language
string
Language code used for transcription
status
string
Current processing status: processing, transcribing, exporting, completed, or failed
webhookUrl
string
Webhook URL if provided in the request
templateName
string
Template name applied to the project (if using a built-in template)
userThemeId
string
User theme ID applied to the project (if using a custom theme)
downloadUrl
string
Direct download URL for the processed video (available when status is completed)
transcriptionStatus
string
Current transcription status: PROCESSING, COMPLETED, or FAILED
failureReason
string
Reason for failure if status is failed
magicZooms
boolean
Whether automatic zoom effects are enabled for the video
magicBrolls
boolean
Whether automatic B-roll insertion is enabled for the video
magicBrollsPercentage
number
Percentage of automatic B-rolls to include in the video (0-100)
videoMetaData
object
Video metadata extracted from the source
createdAt
string
ISO 8601 timestamp when the project was created
updatedAt
string
ISO 8601 timestamp when the project was last updated
curl -X GET "https://api.submagic.co/v1/projects/550e8400-e29b-41d4-a716-446655440000" \
  -H "x-api-key: sk-your-api-key-here"
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "title": "My Awesome Video",
  "language": "en",
  "status": "transcribing",
  "webhookUrl": "https://yoursite.com/webhook/submagic",
  "templateName": "Hormozi 2",
  "transcriptionStatus": "PROCESSING",
  "magicZooms": true,
  "magicBrolls": true,
  "magicBrollsPercentage": 75,
  "videoMetaData": {
    "width": 1920,
    "height": 1080,
    "duration": 185.2,
    "fps": 30
  },
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:32:15.000Z"
}