Reka AI Documentation

{
  "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
        }
      ]
    }
  ]
}

Get the status and output of a reel generation job.

Authentication

X-Api-Keystring

API key authentication via X-Api-Key header

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 nullOptional

Creation timestamp

updated_atstring or nullOptional

Last update timestamp

generation_configobject or nullOptional

Generation configuration used

rendering_configobject or nullOptional

Rendering configuration used

video_urlslist of stringsOptional

List of input video URLs

promptstring or nullOptional

Prompt used for generation

outputlist of objectsOptional

Generated reel outputs

$	curl https://vision-agent.api.reka.ai/v1/clips/id \
>	-H "X-Api-Key: <apiKey>"