For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DiscordGet API Key
  • Getting Started
    • Overview
    • Quickstart
    • Errors
    • Pricing
  • Chat
    • Overview
    • Chat with Image, Video, and Audio
    • Function Calling
    • Models
  • Vision
    • Overview
    • Rate Limits
    • Pricing
    • MCP Server
    • Video Management
    • Video Group Management
    • Video Search
    • Video QA
    • Clip Generation
    • Metadata Tagging
    • Image Management
    • Image Search
        • POSTCreate Clips
        • GETGet Clip Status
        • DELDelete Clip
  • Research
    • Overview
    • Streaming
    • Reasoning Steps
    • Web Search
    • Structured Output
    • Parallel Thinking
    • Best Practices
    • Errors
    • Examples
  • Speech
    • Overview
    • Audio Transcription
    • Speech Translation
    • Speech-to-Speech Translation
  • Resources
    • FAQs
    • Changelog
    • System Status
LogoLogo
DiscordGet API Key
VisionAPI ReferenceClip Generation

Get Clip Status

GET
https://vision-agent.api.reka.ai/v1/clips/:id
GET
/v1/clips/:id
$curl https://vision-agent.api.reka.ai/v1/clips/id \
>     -H "X-Api-Key: <apiKey>"
200Retrieved
1{
2  "id": "550e8400-e29b-41d4-a716-446655440000",
3  "status": "completed",
4  "created_at": "2024-01-15T10:30:00Z",
5  "updated_at": "2024-01-15T10:35:00Z",
6  "generation_config": {
7    "template": "compilation",
8    "num_generations": 1,
9    "min_duration_seconds": 15,
10    "max_duration_seconds": 60,
11    "source_start_time": 0,
12    "source_end_time": 300,
13    "translated_subtitles_target_language": "es_ES",
14    "translated_subtitles_group_length": 120
15  },
16  "rendering_config": {
17    "show_watermark": false,
18    "subtitles": true,
19    "aspect_ratio": "9:16",
20    "resolution": 240,
21    "caption_style": {
22      "desired_font_size": 120,
23      "text_transform": "uppercase",
24      "text_color": "#FFFFFF",
25      "highlight_color": "#FF7E4F",
26      "stroke_color": "#000000",
27      "position": "middle",
28      "font_family": "BebasNeue"
29    }
30  },
31  "video_urls": [
32    "https://example.com/source-video.mp4"
33  ],
34  "prompt": "Create an engaging short video highlighting the best moments",
35  "output": [
36    {
37      "title": "Epic Sunset Moments",
38      "video_url": "https://cdn.example.com/reels/output-001.mp4",
39      "caption": "Capturing the magic of golden hour",
40      "signed_s3_video_url": "string",
41      "hashtags": [
42        "sunset",
43        "goldenhour",
44        "nature"
45      ],
46      "ai_score": 85
47    }
48  ]
49}
Get the status and output of a reel generation job.
Was this page helpful?
Previous

Delete Clip

Next
Built with

Authentication

X-Api-Keystring

API key authentication via X-Api-Key header

OR
AuthorizationBearer
Bearer token authentication via Authorization header

Path parameters

idstringRequiredformat: "uuid"

Response

Successful Response
idstring
Unique identifier for the generation
statusstring
Current status of the generation
created_atstring or null
Creation timestamp
updated_atstring or null
Last update timestamp
generation_configobject or null
Generation configuration used
rendering_configobject or null
Rendering configuration used
video_urlslist of strings
List of input video URLs
promptstring or null
Prompt used for generation
outputlist of objects
Generated reel outputs