Skip to main content

Usage

const { data, error } = await vj.extractMedia({
  mediaUrl: "https://cdn.example.com/video.mp4",
  frames: "auto",
  audio: true,
});

Parameters

FieldTypeRequiredDescription
mediaUrlstringYesURL of the video to extract from
framesstringNoFrame indices ([0, 75, 150]), "auto" for 3 evenly spaced, or "last" for the final frame
audiobooleanNoExtract audio track as WAV
metadatabooleanNoReturn video metadata. Defaults to true

Response

{
  "frames": [
    { "index": 0, "url": "https://cdn.vidjutsu.ai/..." },
    { "index": 75, "url": "https://cdn.vidjutsu.ai/..." },
    { "index": 150, "url": "https://cdn.vidjutsu.ai/..." }
  ],
  "audio": {
    "url": "https://cdn.vidjutsu.ai/...",
    "duration": 10.2
  },
  "metadata": {
    "width": 1080,
    "height": 1920,
    "fps": 30,
    "duration": 10.0
  }
}

Credits

5 credits per call.