---
title: "Call images.describe"
method: POST
path: "/api/v1/tools/images.describe"
tags: ["images"]
---

# Call images.describe

`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

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

## Headers

- `x-request-id` string

## Request body

- object
  - `generation_id` string, 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.
  - `page` integer, 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.
  - `board` string, uuid, required: The board to act on, by id — one of this workspace's boards (board.tree lists them).
  - `workspace` string: 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 `200`

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.

- union
  - object: The tool ran and answered.
    - `ok` true, required
    - `boardId` string
    - `page` integer
    - `pageSize` integer
    - `totalCount` integer
    - `hasMore` boolean
    - `images` object[]
      - `generationId` string, required
      - `role` string, required
      - `status` string, required
      - `description` string, nullable, required
      - `createdAt` string, required
    - `instruction` string
    - `generationId` string
    - `status` string
    - `description` string, nullable
    - `describedAt` string, nullable
    - `createdAt` string
    - `workspace` string, required: The slug of the workspace this call ran in.
    - `working_in` object, required: Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result.
      - `label` string, required: The chip words — e.g. "working in: Acme Main".
      - `note` string, required: Why this workspace — e.g. "your default", "this call only".
      - `workspace` string, required: The resolved workspace's slug.
      - `source` 'call-override' | 'key-pin' | 'stored-default' | 'sole-reachable', required: Which rung of the R7 precedence resolved the workspace.
  - ToolRefusal: A call that was admitted and dispatched, and did not succeed.
    - `ok` false, required
    - `code` string, required: The typed reason — e.g. `workspace_ambiguous`, `invalid_arguments`, or the tool's own failure code.
    - `message` string, required: A sentence a person can act on.
    - `workspaces` string[]: On a workspace refusal: the slugs this key may pass as `workspace`.
    - `issues` object[]: On `invalid_arguments`: which fields failed, and why.
      - `path` string, required
      - `message` string, required
    - `path` string: On an authoring refusal: where in your call's input it points, e.g. `steps.<key>.params.<field>`.
    - `fix` string: On an authoring refusal: the change to your call that would pass.
    - `instruction` string: On an authoring refusal: what to do next with it.

## Other responses

- `400`: The request could not be used: the body is present but not a JSON object (`tenant_api.malformed_body`); it is a top-level array carrying more messages than this endpoint accepts (`tenant_mcp.batch_too_large`); or the `Idempotency-Key` header is malformed (`tenant_api.idempotency_key_invalid`), disagrees with the body's `idempotency_key` (`tenant_api.idempotency_key_conflict`), or was sent to an action that cannot replay a retry (`tenant_api.idempotency_unsupported`). Nothing ran.
- `401`: No bearer credential, or one that did not resolve. Deliberately ONE undifferentiated answer for absent / unknown / revoked / expired, so the endpoint is never an oracle over the key space.
- `403`: The credential is good but the surface is not open to it — the platform or account API switch is off, or the holder lacks the `api.access` capability. The `code` says which.
- `404`: No such tool. The body names no tool and is identical for every unrecognised name.
- `429`: Over this key's per-minute cap. Carries `Retry-After` and `error.retry_after_seconds`.

---

[API](https://skmtc.dev/goosybear/apis/goosy-bear-api.md) · [All operations](https://skmtc.dev/goosybear/apis/goosy-bear-api/llms.txt) · [OpenAPI document](https://skmtc.dev/goosybear/apis/goosy-bear-api/revisions/0e033701d3f7?raw)