images

Call images.generate

Generate new images onto a board in this workspace — 'make three pictures of our product on a beach', 'generate a hero image for the launch'. It spends credits, so it answers in two calls on every key: without confirmation_id it checks the board, says what would be made and returns 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. Not for changing an image that already exists — that is images.iterate.

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.generate

Request

  • Base URL: https://app.goosybear.ai
  • URL: https://app.goosybear.ai/api/v1/tools/images.generate
  • 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 required

Which board the images land on — a board id in this workspace.

briefstring required

What to generate, in plain words.

countinteger

How many images to make. Each one costs credits.

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

The aspect ratio. Omit for the workspace default.

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 4 revisions of this API.