Skip to main content
POST
Describe video scene
Generate an AI-powered description of a video scene’s visual content.
  • Generates description using AI vision models
  • Can use custom prompts to guide description focus
  • Optional model_config dict accepts model_name (e.g., "pro") and temperature (0.0-1.0) to control the vision model
  • Overwrites existing scene description
  • Requires scene to be part of extracted scene collection
  • Scene IDs start with sc- prefix

Authorizations

x-access-token
string
header
required

API key for authentication (sk-xxx format)

Path Parameters

video_id
string
required
Pattern: ^m-
Example:

"m-12345"

scene_id
string
required
Example:

"scene-123"

Body

application/json
prompt
string
Example:

"Describe what happens in this scene"

model_name
string
Example:

"gpt-4"

Response

200 - application/json

Scene description generated

success
boolean
Example:

true

data
object