---
title: "Scramble decode · טקסט מתפענח — estimate"
method: POST
path: "/v1/effects/scramble-decode/estimate"
tags: ["Effects · Text animations"]
---

# Scramble decode · טקסט מתפענח — estimate

`POST /v1/effects/scramble-decode/estimate`

## Request

- Base URL: `https://apihub.co.il`
- URL: `https://apihub.co.il/v1/effects/scramble-decode/estimate`
- Auth: HTTP bearer

Price the request without executing it. Same body as `POST /v1/effects/scramble-decode`.

## Request body

- object
  - `at` object: Start at a word (instead of a time)
    - `edge` 'start' | 'end', required: The moment the word starts, or the moment it ends
    - `word` string, required: The word's id (w0001…)
    - `offset_ms` number: Shift in ms, applied after the cuts (default 0)
  - `keep` object[]: Keep only these spans of the video (seconds) — every join between them is a cut a transition plays on
    - `end` number, required
    - `start` number, required
  - `text` string: The words — same as params.text
  - `trim` object: Use only this part of the video (seconds)
    - `end` number
    - `start` number
  - `start` number: seconds on the output — when it starts (default: the effect's own)
  - `words` object[]: Your own timed words (ms) instead of a transcript
    - `id` string
    - `end` number, required
    - `text` string, required
    - `start` number, required
  - `during` object: Start and end with a stretch of words (instead of a time and a duration)
    - `to` string, required: Id of the last word
    - `from` string, required: Id of the first word
    - `pad_end_ms` number: End this much later (default 0)
    - `pad_start_ms` number: Start this much earlier (default 0)
  - `output` object
    - `fit` 'crop' | 'blur' | 'pad': When the aspect ratio changes: crop the edges, blurred copy behind, or solid bars
    - `fps` number
    - `format` 'mp4' | 'webm' | 'mov' | 'gif' | 'mp3' | 'wav' | 'm4a' | 'jpg' | 'png'
    - `quality` 'draft' | 'standard' | 'high': high (default) = best picture; draft renders fastest for previews
    - `background` string: Bar colour for fit=pad
    - `resolution` '480' | '720' | '1080' | 'source': Short side in pixels (1080 = Full HD). `source` keeps the input size, max 1080
    - `aspect_ratio` 'original' | '9:16' | '16:9' | '1:1' | '4:5' | '4:3': 9:16 for Reels/TikTok/Shorts, 1:1 or 4:5 for feed, 16:9 for YouTube
  - `params` object: The effect's own settings (every field has a default)
    - `y` number: Height of the text's centre, % from the top
    - `bold` boolean: Bold
    - `font` string: Font family — GET /v1/studio/fonts
    - `size` number: Letter size, % of the frame height
    - `text` string: The words
    - `color` string: Text colour
    - `order` 'reading' | 'random': The order the letters resolve in
    - `shadow` boolean: A soft shadow under the letters
    - `charset` 'auto' | 'hebrew' | 'latin' | 'digits' | 'symbols' | 'custom': What the letters shuffle through (auto = each letter's own script)
    - `outline` number: An outline round the letters, % of the letter size (0 = none)
    - `step_ms` integer: How often a shuffling letter changes, ms
    - `duration_ms` integer: How long until the last letter resolves, ms
    - `custom_chars` string: custom: the characters to shuffle through
    - `outline_color` string: The outline's colour
    - `unresolved_color` string: The colour of letters still shuffling
  - `duration` number: seconds — how long it lasts
  - `video_url` string, uri: The video to put it on — leave out for the plain canvas
  - `language_code` string: Spoken language for the automatic transcript, e.g. he, en
  - `transcript_id` string: Reuse a transcript (captions effects)

## 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)