> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.reka.ai/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.reka.ai/_mcp/server. # Get Clip Status GET https://vision-agent.api.reka.ai/v1/clips/{id} Get the status and output of a reel generation job. Reference: https://docs.reka.ai/vision/api-reference/clip-generation/get-reel-v-1-clips-id-get ## Authentication - `X-Api-Key` header (required) — API key authentication via X-Api-Key header - `Authorization` header (bearer token, required) — Bearer token authentication via Authorization header ## Request ### Path parameters - `id` (string, required) ## Response ### 200 Successful Response - `id` (string, required) — Unique identifier for the generation - `status` (string, required) — Current status of the generation - `created_at` (string, optional, nullable) — Creation timestamp - `updated_at` (string, optional, nullable) — Last update timestamp - `generation_config` (ClipGenerationConfigResult, optional, nullable) — Generation configuration used - `rendering_config` (ClipRenderingConfig, optional, nullable) — Rendering configuration used - `video_urls` (list of string, optional) — List of input video URLs - `prompt` (string, optional, nullable) — Prompt used for generation - `output` (list of ClipOutput, optional) — Generated reel outputs ## Types ### ClipGenerationConfigResult Response-side view of the generation config. Request input caps ``num_generations`` at 1-3, but the auto pipeline resolves it from video duration up to 12 (and transiently 0 before resolution completes). Widening the bound here keeps the response OpenAPI schema honest so strict clients don't reject a valid 0-12 value. - `template` (enum, optional) — Template type for generation - Allowed values: `compilation`, `moments`, `voiceover`, `trailer`, `caption_only` - `num_generations` (integer, optional, nullable) — Resolved number of clips. 1-12 once auto-resolution completes; 0 while an auto request is still pending resolution. - `min_duration_seconds` (integer, optional, default: 0) — Minimum duration in seconds - `max_duration_seconds` (integer, optional, default: 90) — Maximum duration in seconds - `source_start_time` (integer, optional, nullable) — Start time in seconds for source video download. - `source_end_time` (integer, optional, nullable) — End time in seconds for source video download. - `translated_subtitles_target_language` (enum, optional, nullable) — Optional locale to auto-generate translated subtitles after generation completes. - Allowed values: `bg_BG`, `cs_CZ`, `da_DK`, `de_DE`, `el_GR`, `en_GB`, `en_US`, `es_ES`, `es_MX`, `fi_FI`, `fil_PH`, `fr_CA`, `fr_FR`, `hi_IN`, `hu_HU`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `lt_LT`, `ms_MY`, `nl_NL`, `no_NO`, `pl_PL`, `pt_BR`, `pt_PT`, `ro_RO`, `ru_RU`, `hr_HR`, `sk_SK`, `sl_SI`, `sr_Cyrl_RS`, `sr_Latn_RS`, `sv_SE`, `ta_IN`, `th_TH`, `tr_TR`, `uk_UA`, `vi_VN`, `zh_CN`, `zh_TW` - `translated_subtitles_group_length` (integer, optional, nullable) — Max character length of a translated subtitle group before splitting on word boundaries. ### ClipRenderingConfig Rendering settings for the Clip API - `show_watermark` (boolean, optional, default: false) — Whether to display reka watermark - `subtitles` (boolean, optional, default: true) — Whether to enable subtitles - `aspect_ratio` (enum, optional) — Aspect ratio for the video - Allowed values: `9:16`, `9:16-split`, `16:9`, `4:5`, `1:1` - `resolution` (enum, optional) — Target resolution for the video - Allowed values: `240`, `360`, `480`, `720`, `1080` - `caption_style` (CaptionFontConfig, optional, nullable) — Caption styling overrides - `layout` (enum, optional) — How to fit the source video into the target aspect_ratio. 'ai' (default) reframes the source to fill the target, keeping the most relevant content in view. 'fill' center-crops the source to fill the target canvas (no AI reframing, no split screens). 'fit' preserves the entire source frame inside the target, adding bars on the unfilled sides. - Allowed values: `ai`, `ai2`, `fill`, `fit` ### ClipOutput Individual reel output model for Clip API - `title` (string, required) — Title of the generated reel - `video_url` (string, required, nullable) — URL of the generated video - `caption` (string, required) — Caption for the reel - `signed_s3_video_url` (string, optional, nullable) — Presigned S3 URL for the generated video (for Lambda rendering) - `hashtags` (list of string, optional) — List of hashtags - `ai_score` (integer, optional, default: 60) — AI rating score (0-100) - `source_segments` (list of ClipSourceSegment, optional) — Source-video timestamp ranges used to create this clip. Empty when the ranges are unavailable, including legacy, incomplete, and multi-input or ID-only generations. ### CaptionFontConfig - `desired_font_size` (double, optional, nullable) - `text_transform` (enum, optional, nullable) - Allowed values: `initial`, `uppercase`, `lowercase` - `text_color` (string, optional, nullable) - `highlight_color` (string, optional, nullable) - `stroke_color` (string, optional, nullable) - `position` (enum, optional, nullable) - Allowed values: `top`, `bottom`, `middle` - `font_family` (enum, optional, nullable) - Allowed values: `BebasNeue`, `Bangers`, `RobotoCondensed`, `Lato`, `CaptionFont` ### ClipSourceSegment Timestamp range from the original source video, in seconds. - `source_start` (double, required) — Start time in the original source video, in seconds - `source_end` (double, required) — End time in the original source video, in seconds ## Examples **Response** ```json { "id": "550e8400-e29b-41d4-a716-446655440000", "status": "completed", "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T10:35:00Z", "generation_config": { "template": "compilation", "num_generations": 1, "min_duration_seconds": 15, "max_duration_seconds": 60, "source_start_time": 0, "source_end_time": 300, "translated_subtitles_target_language": "es_ES", "translated_subtitles_group_length": 120 }, "rendering_config": { "show_watermark": false, "subtitles": true, "aspect_ratio": "9:16", "resolution": 240, "caption_style": { "desired_font_size": 120, "text_transform": "uppercase", "text_color": "#FFFFFF", "highlight_color": "#FF7E4F", "stroke_color": "#000000", "position": "middle", "font_family": "BebasNeue" }, "layout": "ai" }, "video_urls": [ "https://example.com/source-video.mp4" ], "prompt": "Create an engaging short video highlighting the best moments", "output": [ { "title": "Epic Sunset Moments", "video_url": "https://cdn.example.com/reels/output-001.mp4", "caption": "Capturing the magic of golden hour", "signed_s3_video_url": "string", "hashtags": [ "sunset", "goldenhour", "nature" ], "ai_score": 85, "source_segments": [ { "source_start": 92, "source_end": 98 } ] } ] } ``` **SDK Code** ```python import requests url = "https://vision-agent.api.reka.ai/v1/clips/id" headers = {"X-Api-Key": ""} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://vision-agent.api.reka.ai/v1/clips/id'; const options = {method: 'GET', headers: {'X-Api-Key': ''}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://vision-agent.api.reka.ai/v1/clips/id" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-Api-Key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://vision-agent.api.reka.ai/v1/clips/id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["X-Api-Key"] = '' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://vision-agent.api.reka.ai/v1/clips/id") .header("X-Api-Key", "") .asString(); ``` ```php request('GET', 'https://vision-agent.api.reka.ai/v1/clips/id', [ 'headers' => [ 'X-Api-Key' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://vision-agent.api.reka.ai/v1/clips/id"); var request = new RestRequest(Method.GET); request.AddHeader("X-Api-Key", ""); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["X-Api-Key": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://vision-agent.api.reka.ai/v1/clips/id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```