# Rigbox API

## Docs

- [Create Binding](https://docs.rigbox.dev/api-reference/access-control/create-binding.md): Grant a role to a principal on a specific resource.
- [Delete Binding](https://docs.rigbox.dev/api-reference/access-control/delete-binding.md): Revoke a role binding.
- [Get Tags](https://docs.rigbox.dev/api-reference/access-control/get-tags.md): Get tags assigned to a resource for policy evaluation.
- [Get Throttle Binding](https://docs.rigbox.dev/api-reference/access-control/get-throttle-binding.md): Get the throttle profile bound to a resource.
- [List Bindings](https://docs.rigbox.dev/api-reference/access-control/list-bindings.md): List all role bindings (who has what access to which resources).
- [List Role Presets](https://docs.rigbox.dev/api-reference/access-control/list-role-presets.md): List available role presets and their permissions.
- [List Throttle Presets](https://docs.rigbox.dev/api-reference/access-control/list-throttle-presets.md): List available throttle presets (rate limit profiles).
- [Update Tags](https://docs.rigbox.dev/api-reference/access-control/put-tags.md): Update tags on a resource.
- [Update Throttle Binding](https://docs.rigbox.dev/api-reference/access-control/put-throttle-binding.md): Assign a throttle profile to a resource for rate limiting.
- [Search Principals](https://docs.rigbox.dev/api-reference/access-control/search-principals.md): Search for users and service accounts that can be assigned roles.
- [Simulate Access](https://docs.rigbox.dev/api-reference/access-control/simulate.md): Test whether an action would be allowed for a given principal and resource.
- [Update Binding](https://docs.rigbox.dev/api-reference/access-control/update-binding.md): Update an existing role binding.
- [Get AI Credits](https://docs.rigbox.dev/api-reference/ai/get-credits.md): Get the authenticated user's AI credit balance and mode (managed or BYOK).
- [Get AI Defaults](https://docs.rigbox.dev/api-reference/ai/get-defaults.md): Get default AI provider settings applied to new workspaces.
- [Get User Limits](https://docs.rigbox.dev/api-reference/ai/get-limits.md): Get account plan limits including workspace, app, and resource caps.
- [Get AI Usage](https://docs.rigbox.dev/api-reference/ai/get-usage.md): Get AI usage history broken down by day and workspace.
- [Get Workspace AI Config](https://docs.rigbox.dev/api-reference/ai/get-workspace-ai-config.md): Get the AI provider configuration for a specific workspace.
- [Update AI Defaults](https://docs.rigbox.dev/api-reference/ai/update-defaults.md): Update default AI provider, model, and mode for new workspaces.
- [Update AI Mode](https://docs.rigbox.dev/api-reference/ai/update-mode.md): Switch between managed and BYOK AI mode.
- [Update Workspace AI Config](https://docs.rigbox.dev/api-reference/ai/update-workspace-ai-config.md): Update AI provider settings for a workspace.
- [Create API Key](https://docs.rigbox.dev/api-reference/api-keys/create.md): Generate a new API key. The full key is only returned once.
- [Delete API Key](https://docs.rigbox.dev/api-reference/api-keys/delete.md): Permanently revoke an API key. Requests using it will immediately fail.
- [List API Keys](https://docs.rigbox.dev/api-reference/api-keys/list.md): List all API keys for the authenticated user. Full keys are never shown.
- [Install App](https://docs.rigbox.dev/api-reference/app-catalog/install.md): Install a catalog app into a workspace.
- [Get Job Status](https://docs.rigbox.dev/api-reference/app-catalog/job-status.md): Check the status of an app installation job.
- [List App Catalog](https://docs.rigbox.dev/api-reference/app-catalog/list.md): Browse the catalog of installable apps and services.
- [Create Log Source](https://docs.rigbox.dev/api-reference/app-logs/create-source.md): Register a new log source for an app.
- [Delete Log Source](https://docs.rigbox.dev/api-reference/app-logs/delete-source.md): Remove a log source from an app.
- [Get App Logs](https://docs.rigbox.dev/api-reference/app-logs/get-logs.md): Fetch historical logs for an app with pagination support.
- [List Log Sources](https://docs.rigbox.dev/api-reference/app-logs/list-sources.md): List available log sources for an app (stdout, stderr, custom).
- [Stream App Logs](https://docs.rigbox.dev/api-reference/app-logs/stream-logs.md): Stream app logs in real-time via Server-Sent Events.
- [Update Log Source](https://docs.rigbox.dev/api-reference/app-logs/update-source.md): Update a log source's configuration.
- [Create App](https://docs.rigbox.dev/api-reference/apps/create.md): Create a new app by mapping a workspace port to a public subdomain.
- [Delete App](https://docs.rigbox.dev/api-reference/apps/delete.md): Delete an app and remove its public route.
- [Expose Port](https://docs.rigbox.dev/api-reference/apps/expose-port.md): Expose a port from a workspace as a new app with a public URL.
- [Get App](https://docs.rigbox.dev/api-reference/apps/get.md): Get details for a specific app including status, URL, and visibility.
- [Get App Parameters](https://docs.rigbox.dev/api-reference/apps/get-params.md): Get the configurable parameters for an app.
- [Check App Health](https://docs.rigbox.dev/api-reference/apps/health-check.md): Check if an app is live and its port is reachable.
- [List Apps](https://docs.rigbox.dev/api-reference/apps/list.md): List all apps across your workspaces, or filter by workspace_id.
- [Get Listening Ports](https://docs.rigbox.dev/api-reference/apps/listening-ports.md): List ports currently listening inside a workspace.
- [Reconcile Apps](https://docs.rigbox.dev/api-reference/apps/reconcile.md): Ensure all expected template apps exist for a workspace.
- [Restart App Service](https://docs.rigbox.dev/api-reference/apps/restart.md): Restart an app's backing service. Useful after config changes.
- [Start App Service](https://docs.rigbox.dev/api-reference/apps/start.md): Start an app's backing service inside the workspace.
- [Stop App Service](https://docs.rigbox.dev/api-reference/apps/stop.md): Stop an app's backing service without deleting the app.
- [Update App](https://docs.rigbox.dev/api-reference/apps/update.md): Update an app's name, port mapping, or other configuration.
- [Update App Parameters](https://docs.rigbox.dev/api-reference/apps/update-params.md): Update an app's configurable parameters.
- [Update App Status](https://docs.rigbox.dev/api-reference/apps/update-status.md): Manually update an app's reported status.
- [Update App Visibility](https://docs.rigbox.dev/api-reference/apps/update-visibility.md): Set an app to public, private, or privileged access.
- [Verify Custom Domain](https://docs.rigbox.dev/api-reference/apps/verify-domain.md): Re-check DNS for the app's custom domain and update the verification status.
- [Server Capacity](https://docs.rigbox.dev/api-reference/other/capacity.md): Check platform capacity and availability. No authentication required.
- [Get Roadmap Votes](https://docs.rigbox.dev/api-reference/roadmap/get-votes.md): Get the list of roadmap features and your votes.
- [Toggle Vote](https://docs.rigbox.dev/api-reference/roadmap/toggle-vote.md): Vote or unvote on a roadmap feature.
- [Create Service Spec](https://docs.rigbox.dev/api-reference/service-specs/create.md): Create a service spec defining how an app should run inside a workspace.
- [Delete Service Spec](https://docs.rigbox.dev/api-reference/service-specs/delete.md): Delete a service spec.
- [Get Service Spec](https://docs.rigbox.dev/api-reference/service-specs/get.md): Get a service spec by ID.
- [List Service Specs](https://docs.rigbox.dev/api-reference/service-specs/list.md): List all service specs for the authenticated user.
- [Update Service Spec](https://docs.rigbox.dev/api-reference/service-specs/update.md): Update a service spec's configuration.
- [Create Setup Script](https://docs.rigbox.dev/api-reference/setup-scripts/create.md): Create a reusable setup script for workspace initialization.
- [Delete Setup Script](https://docs.rigbox.dev/api-reference/setup-scripts/delete.md): Delete a setup script.
- [Get Setup Script](https://docs.rigbox.dev/api-reference/setup-scripts/get.md): Get a setup script by ID.
- [List Setup Scripts](https://docs.rigbox.dev/api-reference/setup-scripts/list.md): List all setup scripts for the authenticated user.
- [Update Setup Script](https://docs.rigbox.dev/api-reference/setup-scripts/update.md): Update a setup script's content or metadata.
- [Create Snapshot](https://docs.rigbox.dev/api-reference/snapshots/create.md): Capture the current state of a workspace as a snapshot.
- [Delete Workspace Snapshot](https://docs.rigbox.dev/api-reference/snapshots/delete.md): Delete a snapshot from a specific workspace.
- [Delete Snapshot](https://docs.rigbox.dev/api-reference/snapshots/delete-by-id.md): Delete a snapshot by its ID, regardless of which workspace it belongs to.
- [List Workspace Snapshots](https://docs.rigbox.dev/api-reference/snapshots/list.md): List snapshots for a specific workspace.
- [List All Snapshots](https://docs.rigbox.dev/api-reference/snapshots/list-all.md): List all snapshots across all workspaces for the authenticated user.
- [Restore Workspace Snapshot](https://docs.rigbox.dev/api-reference/snapshots/restore.md): Restore a workspace to a previous snapshot state.
- [Restore Snapshot](https://docs.rigbox.dev/api-reference/snapshots/restore-by-id.md): Restore a snapshot by ID to its original workspace.
- [Add SSH Key](https://docs.rigbox.dev/api-reference/ssh-keys/add.md): Register a new SSH public key for workspace access.
- [Delete SSH Key](https://docs.rigbox.dev/api-reference/ssh-keys/delete.md): Remove an SSH key from your account.
- [List SSH Keys](https://docs.rigbox.dev/api-reference/ssh-keys/list.md): List all SSH keys registered to your account.
- [List Workspace SSH Keys](https://docs.rigbox.dev/api-reference/ssh-keys/list-workspace.md): List SSH keys currently deployed to a specific workspace.
- [Sync Workspace SSH Keys](https://docs.rigbox.dev/api-reference/ssh-keys/sync-workspace.md): Sync your account SSH keys into a workspace's authorized_keys.
- [Get Feature Flags](https://docs.rigbox.dev/api-reference/system/feature-flags.md): Get feature flags enabled for the authenticated user.
- [List Templates](https://docs.rigbox.dev/api-reference/templates/list.md): List available workspace templates. This endpoint is public -- no auth required.
- [Quick Deploy](https://docs.rigbox.dev/api-reference/templates/quick-deploy.md): Create a workspace from a template in one call.
- [Install Tool](https://docs.rigbox.dev/api-reference/tools/install.md): Install a tool into a workspace. Returns a job ID for tracking progress.
- [Get Install Status](https://docs.rigbox.dev/api-reference/tools/install-status.md): Check the installation progress of a tool.
- [Launch Tool](https://docs.rigbox.dev/api-reference/tools/launch.md): Launch a tool that is installed in the workspace.
- [List Tools](https://docs.rigbox.dev/api-reference/tools/list.md): List available tools and their install status for a workspace.
- [Get Tool Status](https://docs.rigbox.dev/api-reference/tools/status.md): Get the current status of a specific tool in a workspace.
- [Stop Tool](https://docs.rigbox.dev/api-reference/tools/stop.md): Stop a running tool in the workspace.
- [Get User Settings](https://docs.rigbox.dev/api-reference/users/get-settings.md): Retrieve the authenticated user's settings and preferences.
- [List Regions](https://docs.rigbox.dev/api-reference/users/list-regions.md): List available deployment regions.
- [Update User Settings](https://docs.rigbox.dev/api-reference/users/update-settings.md): Update user settings such as default region or editor preferences.
- [Get Workspace Service](https://docs.rigbox.dev/api-reference/workspace-services/get.md): Get a single workspace service by name, including its health status and port.
- [List Workspace Services](https://docs.rigbox.dev/api-reference/workspace-services/list.md): List all backing services (databases, caches, brokers) for a workspace with their health status.
- [Create Workspace](https://docs.rigbox.dev/api-reference/workspaces/create.md): Provision a new micro-VM workspace with custom resources.
- [Delete Workspace](https://docs.rigbox.dev/api-reference/workspaces/delete.md): Permanently delete a workspace and all associated data.
- [Get Workspace](https://docs.rigbox.dev/api-reference/workspaces/get.md): Fetch details for a single workspace including status, resources, and metadata.
- [Get Workspace Logs](https://docs.rigbox.dev/api-reference/workspaces/get-logs.md): Retrieve workspace-level logs with pagination.
- [Get Workspace Metrics](https://docs.rigbox.dev/api-reference/workspaces/get-metrics.md): Get live CPU, memory, and disk usage metrics for a running workspace.
- [List Workspaces](https://docs.rigbox.dev/api-reference/workspaces/list.md): Retrieve all workspaces owned by the authenticated user.
- [Start Workspace](https://docs.rigbox.dev/api-reference/workspaces/start.md): Boot a provisioned or stopped workspace.
- [Stop Workspace](https://docs.rigbox.dev/api-reference/workspaces/stop.md): Gracefully shut down a running workspace. State is preserved on disk.
- [Stream Workspace Logs](https://docs.rigbox.dev/api-reference/workspaces/stream-logs.md): Stream workspace logs in real-time via Server-Sent Events.
- [Get Workspace Tasks](https://docs.rigbox.dev/api-reference/workspaces/tasks.md): List tasks synced from the workspace's task manager.
- [Update Environment Variables](https://docs.rigbox.dev/api-reference/workspaces/update-env.md): Set or update environment variables inside the workspace.
- [Update Workspace Resources](https://docs.rigbox.dev/api-reference/workspaces/update-resources.md): Resize a workspace's RAM, disk, or vCPU allocation.
- [Authentication](https://docs.rigbox.dev/authentication.md): How to authenticate with the Rigbox API using API keys or session tokens.
- [Clawd API Surface](https://docs.rigbox.dev/clawd-api-surface.md): Which APIs power clawd.rigbox.dev and how to reuse them in your own app
- [Clawd Runtime Services](https://docs.rigbox.dev/clawd-runtime-services.md): How Clawd uses Rigbox's AI proxy, credits, and configuration APIs.
- [Architecture](https://docs.rigbox.dev/concepts/architecture.md): How Rigbox isolates workspaces, routes traffic, and manages AI provider access.
- [Resource Limits & Quotas](https://docs.rigbox.dev/concepts/limits.md): Plan tiers, workspace limits, AI credits, and rate limits.
- [Security & Isolation](https://docs.rigbox.dev/concepts/security.md): How Rigbox isolates workspaces, protects credentials, and controls access.
- [AI Coding Tools](https://docs.rigbox.dev/guides/ai-coding-tools.md): Use Rigbox credits to power Claude Code, Codex CLI, OpenCode, Kilocode, and other AI coding agents.
- [Architecture Explorer](https://docs.rigbox.dev/guides/architecture-explorer.md): Visualize code structure, module dependencies, and handler call graphs.
- [Build a Hosting Platform](https://docs.rigbox.dev/guides/build-hosting-platform.md): Use the Rigbox API to build your own app hosting service, like Clawd.
- [Bring Your Own Keys](https://docs.rigbox.dev/guides/byok.md): Use your own AI provider API keys instead of Rigbox-managed credits.
- [Catalog Apps](https://docs.rigbox.dev/guides/catalog.md): Install pre-packaged apps like VS Code, Jupyter, and Streamlit in one call.
- [The Rigbox CLI](https://docs.rigbox.dev/guides/cli.md): Deploy apps, manage workspaces, and script the Rigbox API from the terminal.
- [Custom Domains](https://docs.rigbox.dev/guides/custom-domains.md): Point your own domain at a Rigbox app with automatic TLS.
- [Expose Ports & Route Apps](https://docs.rigbox.dev/guides/expose-and-route.md): Map ports from inside your workspace to public URLs on rigbox.dev.
- [Firecrawl](https://docs.rigbox.dev/guides/firecrawl.md): Deploy a self-hosted Firecrawl web scraping API with one click.
- [Images & Templates](https://docs.rigbox.dev/guides/images-and-templates.md): Choose the right base image and template for your workspace.
- [Managed AI Proxy](https://docs.rigbox.dev/guides/managed-proxy.md): Use Rigbox-provided AI credits without managing your own API keys.
- [Service Specs](https://docs.rigbox.dev/guides/service-specs.md): Define long-running background services that start automatically in your workspaces.
- [Setup Scripts](https://docs.rigbox.dev/guides/setup-scripts.md): Automate workspace initialization with reusable bash scripts.
- [Sidecar Dashboard](https://docs.rigbox.dev/guides/sidecar-dashboard.md): Monitor tasks, git status, files, agent sessions, and Rigbox workspace state from a terminal TUI.
- [Snapshots](https://docs.rigbox.dev/guides/snapshots.md): Save and restore full workspace state for checkpointing, branching, and recovery.
- [SSH Access](https://docs.rigbox.dev/guides/ssh-access.md): Connect to your workspaces via SSH for terminal access, file transfer, and management.
- [Task Management with td](https://docs.rigbox.dev/guides/td-task-manager.md): Track issues, enforce handoffs, and sync task state across AI agent sessions using the td CLI.
- [Virtual Browser](https://docs.rigbox.dev/guides/virtual-browser.md): Run a remote Chromium or Firefox browser accessible from your own browser.
- [App Visibility](https://docs.rigbox.dev/guides/visibility.md): Control who can access your apps with public, private, and privileged modes.
- [Workspace Services](https://docs.rigbox.dev/guides/workspace-services.md): Monitor and manage backing infrastructure like databases, caches, and message brokers.
- [Workspaces](https://docs.rigbox.dev/guides/workspaces.md): Create, manage, and monitor isolated micro-VM workspaces.
- [Introduction](https://docs.rigbox.dev/introduction.md): Rigbox is an API-first platform for running code in isolated micro-VMs with built-in app routing, AI credits, and developer tooling.
- [Quickstart](https://docs.rigbox.dev/quickstart.md): Launch your first workspace and app with production-safe API steps
- [Sandbox API Surface](https://docs.rigbox.dev/sandbox-api-surface.md): Which APIs power sandbox.rigbox.dev and how to reuse them in your own app

## OpenAPI Specs

- [rigbox-api](https://docs.rigbox.dev/openapi/rigbox-api.json)
- [auth-api](https://docs.rigbox.dev/openapi/auth-api.json)
- [openapi](https://docs.rigbox.dev/api-reference/openapi.json)