Skip to main content
GET
/
automation
/
get-project-details
Get Project Details
curl --request GET \
  --url https://public.reap.video/api/v1/automation/get-project-details \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "title": "<string>",
  "thumbnail": "<string>",
  "billedDuration": 123,
  "status": "queued",
  "projectType": "clipping",
  "source": "Upload",
  "genre": "talking",
  "topics": [
    "<string>"
  ],
  "clipDurations": [
    [
      123
    ]
  ],
  "selectedStart": 123,
  "selectedEnd": 123,
  "reframeClips": true,
  "exportResolution": 123,
  "exportOrientation": "landscape",
  "captionsPreset": "<string>",
  "enableCaptions": true,
  "enableEmojis": true,
  "enableHighlights": true,
  "language": "<string>",
  "dubbingLanguage": "<string>",
  "translateTranscription": true,
  "translationLanguages": [
    "<string>"
  ],
  "transcriptionScript": "native",
  "metadata": {
    "width": 123,
    "height": 123,
    "aspectRatio": "<string>",
    "size": 123,
    "bitrate": 123,
    "fps": 123,
    "duration": 123,
    "rotation": 123,
    "resolution": 123,
    "codec": "<string>",
    "codecFullName": "<string>",
    "codecTag": "<string>",
    "format": "<string>",
    "formatFullName": "<string>"
  },
  "urls": {},
  "createdAt": 123,
  "updatedAt": 123
}

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

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

Example Request

curl -X GET "https://public.reap.video/api/v1/automation/get-project-details?projectId=65f1a2b3c4d5e6f7a8b9c0d1" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

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
  • reframeClips: Whether clips are reframed for different aspect ratios

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
  • reframeClips: Always true for reframe projects

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 may contain various project assets:
sourceVideo
string
URL to the original source video
thumbnail
string
URL to the project thumbnail image
videoFile
string
URL to the processed video file (for caption/reframe projects)
URLs are dynamically generated and may expire. Always use the most recent URLs from API responses.

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
reframeClips
boolean
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
createdAt
integer
updatedAt
integer