images

Call images.batch

'give me ten options for the launch hero', 'make a batch of product shots on this board' — make a batch of new images from one brief onto a board in this workspace, named by id. It spends: it answers in two calls on every key. Without confirmation_id it checks the board, returns the quote (how many images, at what shape, and the draw on the workspace's image allowance) with a confirmation_id, and makes and charges nothing; the same call again with that confirmation_id, on a member's own API key, starts the run and answers its run_id. Each delivered image is charged when it is made. Not for a single image — that is images.generate.

Every result names the workspace it ran in. Say which workspace the answer is about. When the account has more than one workspace and none is selected, this tool refuses with workspace_ambiguous and lists the choices — offer them, never pick one.

post/api/v1/tools/images.batch

Request

  • Base URL: https://app.goosybear.ai
  • URL: https://app.goosybear.ai/api/v1/tools/images.batch
  • Auth: HTTP bearer

Headers

x-request-idstring

Your own id for this request, echoed back and recorded on the audit trail. 1–128 characters from A–Z a–z 0–9 . _ : -, starting with a letter or digit; anything else is replaced by a generated id.

Request body

boardstring uuid required

The board to act on, by id — one of this workspace's boards (board.tree lists them).

briefstring required

What to generate, in plain words.

countinteger required

How many images the batch makes, 1-10. Each delivered image draws on the workspace's image allowance.

shape'1:1' | '3:4' | '4:3' | '9:16' | '16:9'

The aspect ratio. Omit for square (1:1).

confirmation_idstring uuid

Omit to propose: the first call says what would happen, returns a confirmation_id and changes nothing. To go ahead, send the same arguments again with that confirmation_id, on a member's own API key; a service account's key can propose but never confirm.

workspacestring

Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

Response

The call was admitted and dispatched. ok says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

OR

Changes

No recorded changes to this operation across all 6 revisions of this API.