Skip to main content
GET
Get Project Details
For AI agents: a documentation index is at /llms.txt. Every page is also available as markdown, just append .md to the URL.

Overview

Get comprehensive information about a video project, including processing configuration, metadata, and current status. This endpoint returns the full project object with all settings and URLs.

Response

string
Unique project identifier
string
Project title (usually the filename or video title)
string
URL to the project thumbnail image
number
Duration in seconds that was billed to your account
string
Current processing status (“processing”, “completed”, “failed”, “cancelled”)
string
Type of project (“clipping”, “captions”, “reframe”, “dubbing”, “transcription”)
string
Source of the original video (“Youtube”, “Upload”, “Generic”)
string
Video genre for AI analysis (“talking”, “screenshare”, “gaming”)
array
Array of topic strings identified in the video
array
Array of clip duration objects with min/max values
number
Start time in seconds for processing (null if entire video)
number
End time in seconds for processing (null if entire video)
integer
Output resolution for clips (720, 1080, 1440, 2160)
string
Output orientation (“landscape”, “portrait”, “square”)
string
Caption style preset ID (null if captions disabled)
boolean
Whether captions are enabled for this project
boolean
Whether emojis are added to captions
boolean
Whether keywords are highlighted in captions
string
Primary language of the video content
string
Target language for dubbing projects
boolean
Whether transcription is translated to other languages
array
Array of language codes for translation
string
Script format for transcription (“native” or “roman”)
object
Video metadata including duration, resolution, format, etc.
object
Object containing various project URLs and assets
integer
Unix timestamp when the project was created
integer
Unix timestamp when the project was last updated

Example Request

Example Response

Project Configuration

Clipping Projects

For clipping projects, the response includes:
  • topics: AI-identified topics in the video
  • clipDurations: Preferred clip length ranges
  • genre: Video genre for better AI analysis
  • exportOrientation: Output aspect ratio — portrait/square clips are auto-cropped from the source

Caption Projects

For caption projects, the response includes:
  • captionsPreset: Style preset for captions
  • enableEmojis: Whether emojis are added
  • enableHighlights: Whether keywords are highlighted
  • language: Primary language of the content

Reframe Projects

For reframe projects, the response includes:
  • exportOrientation: Target orientation (portrait/square)
  • genre: Video genre for better reframing

Transcription Projects

For transcription projects, the response includes:
  • language: Primary language of the content
  • translateTranscription: Whether transcription is translated
  • translationLanguages: Target translation languages
  • transcriptionScript: Script format (“native” or “roman”)

Dubbing Projects

For dubbing projects, the response includes:
  • language: Source language of the video
  • dubbingLanguage: Target language for dubbing
  • translateTranscription: Whether transcription is translated

URLs Object

The urls object contains presigned URLs for the project’s assets:
string
URL of the processed source video
string
URL of the extracted audio track
string
URL of the word-level transcript JSON (the translated version when translation ran). Useful for auditing a video’s content without playback.
string
SRT subtitle file — transcription projects only
string
WebVTT subtitle file — transcription projects only
string
CSV transcript — transcription projects only
string
Plain-text transcript — transcription projects only
URLs are presigned and expire. Always use the most recent URLs from API responses. The transcription_srt/vtt/csv/txt exports are only generated for transcription projects — other project types include just videoFile, audioFile, and transcription.

Rate Limiting

This endpoint is subject to the standard rate limit of 10 requests per minute.

Common Use Cases

Project Monitoring

Get detailed status and configuration information

Configuration Review

Verify project settings and parameters

Metadata Analysis

Access video metadata and processing details

Asset Management

Retrieve URLs for project assets and files

Next Steps

Based on the project details:

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

projectId
string
required

Unique identifier of the project

Response

200 - application/json

Successful response

id
string
title
string
thumbnail
string
billedDuration
number
status
enum<string>
Available options:
queued,
prepped,
draft,
processing,
finalizing,
completed,
invalid,
expired,
failed,
error
projectType
enum<string>
Available options:
clipping,
captions,
reframe,
dubbing,
transcription
source
enum<string>
Available options:
Upload,
Youtube,
Vimeo,
TwitchVod,
Twitter,
RumbleEmbed,
Generic
genre
enum<string>
default:talking
Available options:
talking,
screenshare,
gaming
topics
string[]
clipDurations
integer[][]
selectedStart
number | null
selectedEnd
number | null
exportResolution
integer
exportOrientation
enum<string>
Available options:
landscape,
portrait,
square
captionsPreset
string | null
enableCaptions
boolean
enableEmojis
boolean
enableHighlights
boolean
language
string | null
dubbingLanguage
string | null
translateTranscription
boolean
translationLanguages
string[]
transcriptionScript
enum<string>
default:native
Available options:
native,
roman
metadata
object
urls
object

Presigned URLs for the project's assets. URLs expire — always use the most recent API response. The transcription_* subtitle/text exports are only present on transcription projects.

createdAt
integer
updatedAt
integer