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

# Call images.batch

`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

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

## Headers

- `x-request-id` string

## Request body

- object
  - `board` string, uuid, required: The board to act on, by id — one of this workspace's boards (board.tree lists them).
  - `brief` string, required: What to generate, in plain words.
  - `count` integer, 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_id` string, 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.
  - `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
    - `state` union, required
      - 'confirmation_required'
      - 'dispatched' | 'accepted': dispatched — the run is under way. accepted — the run is under way but its details could not be read just now: count and aspect_ratio are null; follow it by run_id.
    - `confirmation_id` string, uuid
    - `expires_in_seconds` integer
    - `request_summary` string: What will happen, in one sentence, for a person to approve before confirming.
    - `quote` object: What confirming would run: how many images, at what shape, on which board, and the draw on the workspace's image allowance. Each delivered image is charged when it is made.
      - `count` integer, required
      - `aspect_ratio` string, required
      - `board_id` string, required
      - `budget` string, required: The workspace allowance this batch draws on.
      - `budget_units` integer, required: How much of that allowance the batch draws.
    - `run_id` string: The run now under way — follow it by this.
    - `count` integer, nullable
    - `aspect_ratio` string, nullable
    - `board_id` 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/6d82fb124064?raw)