> For the complete documentation index, see [llms.txt](https://docs.kickbot.com/dashboard/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kickbot.com/dashboard/api/reference/imagine.md). # AI images (Imagine) KickBot API and MCP reference for AI images (Imagine). The !imagine AI image command and its on-stream widget. The !imagine AI image command and its on-stream widget. MCP area name: `imagine`. | Tool | REST | Access | | ----------------------------------------------------- | ------------------------- | ------ | | [`get_imagine_settings`](#get-imagine-settings) | `GET /imagine/settings` | Read | | [`update_imagine_settings`](#update-imagine-settings) | `PATCH /imagine/settings` | Write | | [`test_imagine`](#test-imagine) | `POST /imagine/test` | Write | | [`get_imagine_queue`](#get-imagine-queue) | `GET /imagine/queue` | Read | ## get\_imagine\_settings **Get the AI image (Imagine) settings.** Read the !imagine settings: on/off, who can use it, the on-stream widget options, the widget URL (add it as a browser source in OBS), and images used in the last 30 days against the plan limit. `GET /api/v1/imagine/settings` No input fields. ## update\_imagine\_settings **Update the AI image (Imagine) settings.** Change some !imagine settings. Only the fields you send change. Requires a verified account. `PATCH /api/v1/imagine/settings` Needs a read and write key or connection. | Field | Type | Required | Description | | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `enabled` | boolean | No | Turn the !imagine chat command on or off. | | `everyone_only` | boolean | No | Everyone in chat can use it. | | `subscriber_only` | boolean | No | Subscribers can use it (when everyone\_only is false). | | `vip_only` | boolean | No | VIPs can use it (when everyone\_only is false). | | `mod_only` | boolean | No | Moderators can use it (when everyone\_only is false). | | `show_command` | boolean | No | Show the viewer name and prompt under the image on the widget. Default true. | | `url_response` | boolean | No | Reply in chat with a link to the image. Default true. | | `on_screen_time` | integer | No | Seconds each image stays on the widget, 5-300. Default 60. | | `slide_direction` | string | No | How images appear on the widget: none, fade, left, right, bottom, top. Default bottom. | | `style` | `"none"` or `"anime"` or `"film"` or `"cartoon"` or `"bricks"` or `"animated_3d"` or `"clay"` or `"pixel"` or `"comic"` or `"photo"` or `"watercolor"` or `"oil"` or `"neon"` | No | Image style guideline added to every prompt: none, anime, film, cartoon, bricks, animated\_3d, clay, pixel, comic, photo, watercolor, oil, neon. "none" uses the prompt as written. Premium only (Free channels always use none). Default none. | ## test\_imagine **Show a test image on the Imagine widget.** Show a sample image on the Imagine widget so the streamer can check the overlay in OBS. It appears on the live stream if the widget is in the scene. Test images do not count against the limit. `POST /api/v1/imagine/test` Needs a read and write key or connection. This has an effect outside your settings (for example on your live stream). Rate limit: 20 per minute. No input fields. ## get\_imagine\_queue **Get recent AI images.** List the images made in the last few minutes, oldest first. With the default of 1 minute this is what the widget is showing or about to show. `GET /api/v1/imagine/queue` | Field | Type | Required | Description | | ----------------- | ------- | -------- | -------------------------------------------------- | | `minutes` (query) | integer | No | How many minutes back to look (1-1440, default 1). | ## Need help? Email or ask in the `#support` channel on [Discord](https://discord.gg/MAg3gBbc89). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.kickbot.com/dashboard/api/reference/imagine.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.