---
title: "Plan a video's stock B-roll — estimate"
method: POST
path: "/v1/stock/broll-plan/estimate"
tags: ["Stock"]
---

# Plan a video's stock B-roll — estimate

`POST /v1/stock/broll-plan/estimate`

## Request

- Base URL: `https://apihub.co.il`
- URL: `https://apihub.co.il/v1/stock/broll-plan/estimate`
- Auth: HTTP bearer

Price the request without executing it. Same body as `POST /v1/stock/broll-plan`.

## Request body

- object
  - `edit` object: A POST /v1/studio/edit body (e.g. `output.edit` of POST /v1/studio/kinetic): the shots are merged into it and it comes back ready
  - `kind` 'any' | 'video' | 'image': any = video first, a photo where no clip fits
  - `mode` 'auto' | 'full' | 'split': cutaways: auto = portrait shots full frame, landscape ones as a split screen
  - `avoid` object[]: cutaways: spans (seconds) to keep free; the edit's hook, title cards and stickers are kept free anyway
    - `end` number, required
    - `start` number, required
  - `cache` boolean: Copy each chosen file to our storage (24 h) — a render never depends on another host, and Pixabay's terms require it
  - `count` integer: cutaways: how many shots
  - `scrim` boolean: A light dark band behind the words over the footage (cutaways: the shot's half; faceless: the word band) so small words read on busy pictures
  - `style` 'cutaways' | 'faceless': cutaways = 2–4 stock shots over a talking head · faceless = stock footage and photos over the whole video (the voice goes on)
  - `topic` string: One line on what the video is about
  - `voice` object: faceless over a narration: the voice-over file and its length — mixed in as `voiceover`, the render trimmed to it
    - `url` string, uri, required
    - `seconds` number, required
  - `words` object[]: The spoken words on the OUTPUT clock, in SECONDS — `output.words` of POST /v1/studio/kinetic as is
    - `i` integer
    - `end` number, required
    - `text` string, required
    - `start` number, required
  - `sounds` object: A whoosh file: reused 0.25 s before every cutaway (faceless: on every scene change, as room allows)
    - `whoosh` string, uri
  - `verify` boolean: Show the best candidates' thumbnails to Gemini Flash-Lite before choosing (≈ $0.001–0.005)
  - `context` 'general' | 'ad': ad = an advert or a sales video: no stock person (and no brand) is shown, so nobody in the footage seems to endorse the product — with `verify`, every chosen shot's thumbnail was checked for a face or a logo
  - `exclude` string[]: Stock ids not to use (e.g. from an earlier plan)
  - `moments` object[]: Your own moments and searches — then no model picks them (cutaways: each is one shot; faceless: each starts a scene that runs to the next)
    - `alt` string: A second search if the first finds nothing good
    - `mode` 'auto' | 'full' | 'split'
    - `must` string: cutaways: a word the picture's title or description must name — the thing itself ("elephant"); a candidate without it is no candidate
    - `text` string: What is said there (helps the thumbnail check)
    - `query` string, required: English stock search, 2–5 words
    - `short` string: The core subject in 1–2 words ("laptop") — for sources that match exact words
    - `start` number, required: seconds, output clock
    - `duration` number
  - `seconds` number: cutaways: how long each shot stays
  - `duration` number: The output's length in seconds (the kinetic plan's `summary.output_seconds`); default: the last word + 1.5 s
  - `resolution` '720' | '1080': Default: the edit's output, else 1080
  - `split_side` 'top' | 'bottom': split: where the stock shot goes (bottom keeps the face on top, the words over the shot)
  - `attribution` 'not-required' | 'any': Only where the server's licence rule allows more than CC0 (setting stock_auto_license = cc0-and-free): not-required = CC0 / public domain / Pexels / Pixabay; any = CC BY too, with its credit line on screen while it shows (ShareAlike never). Under the default rule every shot is CC0.
  - `aspect_ratio` '9:16' | '16:9' | '1:1' | '4:5': Default: the edit's output, else 9:16
  - `shot_seconds` number: faceless: a new shot about this often
  - `speaker_focus` number: split: which band of the speaker stays (0 top … 1 bottom; a selfie face ≈ 0.35)
  - `transcript_id` string: Or a transcript whose clock is the output's (e.g. of the cut audio) — read here, its words in ms

## Response `200`

Estimate

- Estimate
  - `operation` string
  - `estimated_credits` number
  - `credits_to_reserve` number
  - `estimated_usage` object
  - `note` string, nullable
  - `balance` object
    - `available` number
  - `sufficient` boolean

---

[API](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai.md) · [All operations](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/llms.txt) · [OpenAPI document](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/revisions/a8caa42835ce?raw)
