whiteboards

designIllustrationInWhiteboard

Create or refine a standalone ILLUSTRATION INSIDE an existing whiteboard by conversing with the AI design agent. This is the illustration sibling of designDeckInWhiteboard: same conversation, same follow-up flow, but it makes ONE on-brand illustration placed on the board (not a slide deck). Send a brief for a NEW illustration, a change to an existing one, or an answer to the agent's question. The agent generates the illustration, places it on the board, and if the brief is ambiguous it asks ONE clarifying question (answer with the same sessionId). Returns immediately; poll getDeckReplyInWhiteboard for the result. Use it when the user wants a picture they can talk about and refine turn by turn (e.g. 'draw a friendly robot onboarding a new team', then 'make it warmer', 'add a second robot'). For a quick one-shot illustration with no follow-up, use generateIllustrationInWhiteboard instead. WHITEBOARD IS REQUIRED: an illustration always lives inside a whiteboard, so documentId (the whiteboard's id) is required. If you do NOT already have a whiteboard id, ASK THE USER which whiteboard they want the illustration designed in — do NOT create a whiteboard automatically. Only call createWhiteboard first if the user explicitly asks for a brand-new board; otherwise use the id of the whiteboard they name. FIRST vs FOLLOW-UP: the first call (from nothing) builds; a follow-up call (an answer, a change, or a new instruction) passes the sessionId (or the deckId) plus the new message. COST + APPROVAL: a build costs 50 credits per 30 slides (1 to 30 slides is 50, 31 to 60 is 100, and so on, with the second and later blocks charged once the deck is built and never charged twice for the same block), an edit costs a flat 50, and a clarifying question is FREE. Call FIRST without confirm: it returns the exact cost, the workspace balance and a single-use quoteToken, and charges nothing. Show the cost to the user, and only if they agree call again with the same arguments plus confirm:true and that quoteToken (it works once, for 10 minutes; a changed request gets a fresh quote and nothing is charged). The fee is auto-refunded if a turn produces no change or fails. Returns sessionId (the conversation), deckId (the illustration's id), status, turnType, started, awaitingUser, needsConfirmation, insufficientCredits, on a quote also quote (cost and balance), quoteToken and howToConfirm, and assistantMessage.

post/tools/designIllustrationInWhiteboard

Request

  • Base URL: https://api.stablebaseline.io/functions/v1/cloud-serve/api/v1
  • URL: https://api.stablebaseline.io/functions/v1/cloud-serve/api/v1/tools/designIllustrationInWhiteboard
  • Auth: HTTP bearer

Request body

documentIdstring required

The whiteboard the illustration lives in. REQUIRED: an illustration cannot exist without a whiteboard, and this is that whiteboard's id. If you do not already have a whiteboard id, ASK THE USER which whiteboard to design the illustration in — never create one automatically. Only call createWhiteboard first if the user explicitly wants a new board.

messagestring required

This turn's message in plain language: the illustration brief on the first turn, a change instruction later, or the user's ANSWER to a clarifying question the agent asked. On a follow-up turn, pass this together with the sessionId (or deckId) from the earlier call.

sessionIdstring

The design conversation to continue, as returned by an earlier designIllustrationInWhiteboard call. Pass it together with message to answer a question, make a change, or send a follow-up. Omit on the very first call to start a new conversation.

deckIdstring

Optional. An existing illustration to continue refining (usually you pass sessionId instead; when both are given the session's illustration wins). The id is called deckId because illustrations and decks share the same conversation spine.

titlestring

Optional title. If omitted, a clear one is derived from the brief.

brandKitIdstring

Optional brand kit id (from listBrandKits) to colour-condition the illustration. If omitted, the organisation's effective brand is used.

confirmboolean

Set true ONLY after the user has approved the quoted cost, and send quoteToken with it. Leave unset/false on the first call of a turn to receive the quote: the cost, the balance and a quoteToken. A clarifying question turn is never charged.

quoteTokenstring

The quoteToken returned by this turn's call without confirm. Required with confirm: true. It works once, within 10 minutes, and only for the exact turn it quoted; a changed turn gets a fresh quote and nothing is charged.

Response

Tool result (shape varies per tool — refer to the tool's docs for the exact return value).

object required

Changes

No recorded changes to this operation across all 1 revision of this API.