estimate_cost
Price one or more generations exactly, without submitting anything, and compare with the user's balance. Pass media and items for generate_image / generate_video, or tool and input to price an editing tool (relight_image, relight_video, upscale_image, upscale_video, reframe_video, extend_video, edit_video, create_depth_map) with the same arguments you would call it with. For an editing tool the answer carries max_coins (the most the job can cost) and the confirmation and affordability checks use it; nothing is submitted or charged. Pricing an editing tool inspects the media exactly as that tool does, needs the same permission to generate, and is limited like the tool. Generating through an AI assistant is charged in VerseIn coins. Unlimited-plan allowances do not apply here.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tool | No | an editing tool to price instead of generations (with input) | |
| input | No | the arguments that tool takes, exactly as for calling it (request_id and confirmation_token are ignored) | |
| items | No | 1 to 12 generations to price (with media) | |
| media | No | image or video (with items; not with tool) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | present only when the call failed | |
| items | No | ||
| balance | Yes | ||
| invalid | No | ||
| max_coins | No | editing tools only: the most the job can cost (a job may switch to a backup model); equals total_cost_coins when the price is final. requires_confirmation and affordable are judged on it | |
| affordable | Yes | ||
| billing_note | Yes | ||
| price_verified | No | editing tools only: false when the price is checked again at submit and some settings may be refused then | |
| total_cost_coins | Yes | ||
| requires_confirmation | Yes | true when generating needs a confirmation_token (the generate call returns one with needs_confirmation) | |
| confirmation_threshold_coins | Yes |