# Rosebud Docs

> Host browser games for free and make game assets with the Rosebud CLI, from a terminal or a coding agent. Add .md to any docs URL for its Markdown.

## Get started

Host games and make assets

- [Rosebud for developers](/docs/get-started.md): Host browser games for free and make game assets with your Rosebud credits, from a terminal or a coding agent.
- [Quickstart](/docs/get-started/quickstart.md): Install the Rosebud CLI and publish your first game.
- [Use a coding agent](/docs/get-started/coding-agents.md): Let Claude Code, Codex, Cursor or Gemini CLI publish your game and make its assets.
- [Sign-in and access](/docs/get-started/access.md): Claim links, game connections and agent logins, and what each one allows.

## Chat apps

Use Rosebud from Claude and ChatGPT

- [Rosebud in Claude and ChatGPT](/docs/connector.md): Connect your Rosebud account to Claude, ChatGPT, Claude Code or Codex to host the games you make in chat. In ChatGPT and Codex it can also generate their art and sound.
- [Connector tools](/docs/connector/tools.md): Every tool the Rosebud connector gives an assistant, what each one reads or changes, its limits and its error codes.

## Guides

Step-by-step tasks

### Hosting

- [Publish a game](/docs/guides/publish-a-game.md): Put a browser game online for free and get a link anyone can play.
- [Claim your game](/docs/guides/claim-your-game.md): Keep a game you published without an account, before its one-hour deadline.
- [Publish updates](/docs/guides/publish-updates.md): Connect a game once, then ship new builds to the same link.
- [Edit a game made in Rosebud](/docs/guides/edit-a-rosebud-game.md): Bring a game made in the Rosebud editor into a folder, change it locally and publish it back.

### Assets

- [Make assets](/docs/guides/make-assets.md): Make sprites, 2D art, skyboxes, 3D models, video and sound with your Rosebud credits.
- [Asset formats and tips](/docs/guides/asset-results.md): Sizes, formats and quirks of each kind of asset, and how to use them in a game.

### Help

- [Troubleshooting](/docs/guides/troubleshooting.md): Common errors, what to do about each, and how to recover from interrupted commands.
- [Network requirements](/docs/guides/network-requirements.md): The addresses a school or office network must allow for Rosebud, and why games load from rosebud.run.
- [Get help](/docs/guides/get-help.md): Report a bug, ask a question or report a security problem.

## CLI

Every command and flag

- [CLI overview](/docs/cli.md): Install the Rosebud CLI, and how its output, exit codes, state and credentials work.

### Hosting

- [rosebud publish](/docs/cli/publish.md): Create a new game from a build folder or ZIP and get a play link.
- [rosebud connect](/docs/cli/connect.md): Ask the game's owner to approve updates from this CLI.
- [rosebud status](/docs/cli/status.md): Check whether this CLI can update the game, and which version is live.
- [rosebud update](/docs/cli/update.md): Publish a new build of a connected game to the same link.
- [rosebud pull](/docs/cli/pull.md): Bring a game's current files, including edits made in Rosebud, into a folder.
- [rosebud disconnect](/docs/cli/disconnect.md): Revoke this CLI's access to the game.

### Agent login

- [rosebud login](/docs/cli/login.md): Approve this CLI or agent to make assets with your credits.
- [rosebud whoami](/docs/cli/whoami.md): Show whether the login is active, and your credit balance.
- [rosebud logout](/docs/cli/logout.md): Revoke the login and remove it from this computer.

### Assets

- [rosebud assets models](/docs/cli/assets/models.md): List the asset models, with their inputs, prices and licenses.
- [rosebud assets quote](/docs/cli/assets/quote.md): Check an asset's inputs and price without paying.
- [rosebud assets create](/docs/cli/assets/create.md): Make an asset with your credits, wait for it and save the file.
- [rosebud assets status](/docs/cli/assets/status.md): Check a job's progress and, when it's done, its asset.
- [rosebud assets list](/docs/cli/assets/list.md): Search your assets, newest first.
- [rosebud assets download](/docs/cli/assets/download.md): Save an existing asset's file into the project.

### More

- [Changelog](/docs/cli/changelog.md): Changes in each release of @rosebudai/cli, newest first.

## HTTP API

Endpoints the CLI calls

- [HTTP API overview](/docs/api.md): Base URL, authentication and conventions for the endpoints the Rosebud CLI calls.
- [Errors](/docs/api/errors.md): Error shapes and codes for the hosting and asset endpoints.

### Hosting

- [Import a game](/docs/api/hosting/import.md): POST /api/developer/projects/import/ — upload a build and get a play link.
- [Upload media in a session](/docs/api/hosting/uploads.md): POST /api/developer/uploads/ — declare a game's media, upload each file, then import or release with the session.
- [Request a connection](/docs/api/hosting/connect.md): POST /api/developer/projects/{project_id}/connect/ — ask the owner to approve updates.
- [Check or revoke a connection](/docs/api/hosting/connection.md): GET and DELETE /api/developer/projects/{project_id}/connection/
- [Read a game's files](/docs/api/hosting/files.md): GET /api/developer/projects/{project_id}/files/ — the game's current text files and media, including edits made in Rosebud.
- [Publish a release](/docs/api/hosting/releases.md): POST /api/developer/projects/{project_id}/releases/ — replace a connected game's files.

### Assets

- [Agent logins](/docs/api/assets/agent-logins.md): Start a login, check it and end it. The login token pays for assets with the person's credits.
- [Models](/docs/api/assets/models.md): GET /api/v1/asset-models/ — list the asset models with inputs, prices and licenses.
- [Quotes](/docs/api/assets/quotes.md): POST /api/v1/asset-quotes/ — check inputs and lock a price, free.
- [Jobs](/docs/api/assets/jobs.md): Pay for a quote and start a job, then poll it until the asset is ready.
- [Assets](/docs/api/assets/assets.md): GET /api/v1/assets/ — search the person's assets and read one.

### Website only

- [Website-only endpoints](/docs/api/website-only.md): Endpoints the rosebud.ai website calls from a signed-in browser. Agents don't call these.

## Models

Asset models and prices

- [All models](/docs/models.md): Every model you can make assets with, its price in credits, inputs and license.

### 2D image

- [Rosebud Image](/docs/models/rosebud-image.md): 2D game art: sprites, icons, UI pieces, backgrounds and textures, with real transparent backgrounds.
- [Nano Banana 2.1](/docs/models/nano-banana-2-1.md): Detailed 2D game art that follows long prompts closely.
- [GPT Image 2.5](/docs/models/gpt-image-2-5.md): OpenAI's image model: precise text and layouts, transparent backgrounds, and edits from a reference image.
- [Nano Banana Pro](/docs/models/nano-banana-pro.md): Google's most capable image model, for detailed scenes and edits from a reference image.
- [Seedream 5 Pro](/docs/models/seedream-5-pro.md): ByteDance's image model: strong illustration styles and edits from a reference image.
- [Recraft 4.1](/docs/models/recraft-4-1.md): Clean, design-led images: UI art, icons and illustrations.
- [Recraft 4.1 SVG](/docs/models/recraft-4-1-svg.md): Vector art as an SVG that scales to any size: icons, logos, UI.
- [Ideogram 3 Transparent](/docs/models/ideogram-3-transparent.md): Images with a transparent background, good at lettering: logos, title text, stickers.
- [Ideogram 4 Tiling](/docs/models/ideogram-tiling.md): A seamless texture that tiles in both directions, or only one.
- [Qwen Multiple Angles](/docs/models/qwen-multiple-angles.md): The same subject seen from another angle: side, back, above.
- [Remove background](/docs/models/remove-background.md): Cuts the subject out of an image onto a transparent background.
- [Crisp upscale](/docs/models/crisp-upscale.md): Enlarges a PNG while keeping edges sharp.
- [Vectorize](/docs/models/vectorize.md): Traces an image (PNG, JPEG or WebP under 5 MB) into an SVG.

### Skybox

- [Rosebud Skybox](/docs/models/rosebud-skybox.md): A 2:1 equirectangular sky panorama for 3D scenes.

### 3D model

- [Rosie 3D](/docs/models/rosie-3d.md): A textured GLB model from a text prompt. Supported humanoids come rigged and animated at no extra charge.
- [Meshy 7.1](/docs/models/meshy-7-1.md): A textured GLB from a prompt or one image, with clean topology options including low-poly.
- [Tripo P2](/docs/models/tripo-p2.md): A textured, PBR-ready GLB from a prompt or one image.
- [Rodin 2.5](/docs/models/rodin-2-5.md): The lowest-cost 3D model here: a 20k-triangle PBR GLB from a prompt or image.
- [Meshy Rigging](/docs/models/meshy-rigging.md): Adds a humanoid skeleton to a character GLB so it can be animated.

### Sound effect

- [Sound effect](/docs/models/sound-effect.md): A short game sound effect.

### Music

- [Background music](/docs/models/background-music.md): A background music track for a game scene.

### Video

- [Kling 4](/docs/models/kling-4.md): Smooth, cinematic clips from a prompt or a first frame.
- [Seedance 2.5](/docs/models/seedance-2-5.md): Clips with matching sound and lip-synced speech, from a prompt or a first frame.
- [Seedance 2.5 References](/docs/models/seedance-2-5-references.md): Clips that keep the characters, props and places from your reference images, with matching sound and lip-synced speech.
- [Veo 3.1 Fast](/docs/models/veo-3-1-fast.md): Google's fast video model, with generated sound.
- [MiniMax H3 Max Turbo](/docs/models/minimax-h3-max-turbo.md): The lowest-cost video model here: quick clips from a prompt, optionally from a first frame.
- [MiniMax H3 Max Turbo References](/docs/models/minimax-h3-max-turbo-references.md): Quick, low-cost clips with sound that keep the characters, props and places from your reference images.

### Speech

- [Eleven v4 speech](/docs/models/eleven-v4-speech.md): Spoken lines for characters and narration. Audio tags such as [whispering] set the delivery.
