HTTP API overview
Base URL, authentication and conventions for the endpoints the Rosebud CLI calls.
The CLI is the supported client
These endpoints may still change. Use the CLI unless you need your own client.
Base URL
https://api.rosebud.aiapi.rosebud.ai serves only the endpoints on these pages. Every other path returns HTTP 404. HTTPS is required for credentials outside local development.
Authentication
| Credential | Comes from | Send it as | Used by |
|---|---|---|---|
| None | Importing a game anonymously, listing models, starting a login. | ||
Connection token (agent_token) | POST .../connect/ | Authorization: Bearer <agent_token> | One game's connection, status, files, upload sessions and releases. |
Login token (rbk_...) | POST /api/v1/agent-logins/ | Authorization: Bearer rbk_... | Quotes, jobs, assets, and importing into the account (with its upload session). |
Neither token is a Rosebud account session. Each one only works after the person approves its link. No endpoint accepts credentials in URL query strings.
Conventions
- Request and response bodies are JSON, except uploads, which are
multipart/form-data. - Times are ISO 8601 in UTC.
- Connection, mutation and asset responses are sent with
Cache-Control: no-store. - Lists are paginated 25 at a time with
count,next,previousandresults. Follownextuntil it's null. - Paid and write requests are rate limited per account: quotes and job starts share a limit of 30 per minute. A throttled request returns HTTP 429 with
Retry-After; wait that long and send it again. - When Rosebud is too busy to start a request, it returns HTTP 503
busywithRetry-Afterand changes nothing. Send the same request again after that many seconds.
Endpoints
| Method | Path | Page |
|---|---|---|
POST | /api/developer/projects/import/ | Import a game |
POST | /api/developer/uploads/ | Upload media in a session |
POST | /api/developer/projects/{project_id}/connect/ | Request a connection |
GET, DELETE | /api/developer/projects/{project_id}/connection/ | Check or revoke a connection |
GET | /api/developer/projects/{project_id}/files/ | Read a game's files |
POST | /api/developer/projects/{project_id}/releases/ | Publish a release |
POST | /api/v1/agent-logins/ | Agent logins |
GET, DELETE | /api/v1/agent-logins/current/ | Agent logins |
GET | /api/v1/asset-models/ | Models |
POST | /api/v1/asset-quotes/ | Quotes |
POST, GET | /api/v1/asset-jobs/ | Jobs |
GET | /api/v1/assets/ | Assets |