images

Call images.describe

'what images are on this board', 'tell me more about this image' — without generation_id, list one board's images, newest first: each image's id, stored caption and status; with generation_id, read that one image's stored description in full. The board is named by id and must be this workspace's. A listing is one page: totalCount is the board's real size, hasMore means older images sit on later pages, and page is a direct index, so the oldest images are on page ceil(totalCount / pageSize). It changes nothing. Not for the workspace's saved photos, logo and product shots — that is images.brand_elements.

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

Request

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

generation_idstring nullable

The id of ONE image to describe in detail. OMIT to list this board's images (ids + prompts + captions) — call it that way FIRST whenever you need an image id for images.iterate / images.add_to_board.

pageinteger nullable

Listing page, a DIRECT INDEX (newest first, 8 per page) — page 1 is the newest and the OLDEST images are on page ceil(totalCount / pageSize), so jump straight to the page you want rather than walking one page at a time. The listing result says totalCount and hasMore. Ignored when generation_id is set.

boardstring uuid required

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

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.