{ "name": "ai-agent-workspace", "description": "Give every AI agent its own computer: a persistent workspace with a filesystem, processes, shells, networking, and agent sessions on a lightweight in-process OS.", "skill_url": "/metadata/skills/ai-agent-workspace/SKILL.md", "generated_at": "2026-06-15T20:24:02.496Z", "references": [ { "name": "actors/access-control", "title": "Access Control", "description": "Authorize actions, queue publishes, and event subscriptions with explicit hooks.", "canonical_url": "https://rivet.dev/docs/actors/access-control", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/access-control.md" }, { "name": "actors/actions", "title": "Actions", "description": "Actions are how your backend, frontend, or other actors can communicate with actors.", "canonical_url": "https://rivet.dev/docs/actors/actions", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/actions.md" }, { "name": "general/actor-configuration", "title": "Actor Configuration", "description": "This page documents the configuration options available when defining a RivetKit actor. The actor configuration is passed to the `actor()` function.", "canonical_url": "https://rivet.dev/docs/general/actor-configuration", "reference_url": "/metadata/skills/ai-agent-workspace/reference/general/actor-configuration.md" }, { "name": "actors/keys", "title": "Actor Keys", "description": "Actor keys uniquely identify actor instances within each actor type. Keys are used for addressing which specific actor to communicate with.", "canonical_url": "https://rivet.dev/docs/actors/keys", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/keys.md" }, { "name": "actors/schedule", "title": "Actor Scheduling", "description": "Schedule actor actions in the future with persistent timers that survive restarts and upgrades.", "canonical_url": "https://rivet.dev/docs/actors/schedule", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/schedule.md" }, { "name": "actors/statuses", "title": "Actor Statuses", "description": "Understand the lifecycle statuses of Rivet Actors, what they mean, how they appear in the API, and how to troubleshoot common issues.", "canonical_url": "https://rivet.dev/docs/actors/statuses", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/statuses.md" }, { "name": "agent-os/agent-to-agent", "title": "Agent-to-Agent Communication", "description": "Use host tools to let agents communicate with each other.", "canonical_url": "https://rivet.dev/docs/agent-os/agent-to-agent", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/agent-to-agent.md" }, { "name": "agent-os/versus-sandbox", "title": "agentOS vs Sandbox", "description": "When to use the lightweight agentOS VM, a full sandbox, or both together.", "canonical_url": "https://rivet.dev/docs/agent-os/versus-sandbox", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/versus-sandbox.md" }, { "name": "cookbook/ai-agent", "title": "AI Agent", "description": "Build an AI agent backend with persistent memory: one Rivet Actor per conversation, queued message handling, and streaming LLM responses as realtime events.", "canonical_url": "https://rivet.dev/cookbook/ai-agent", "reference_url": "/metadata/skills/ai-agent-workspace/reference/cookbook/ai-agent.md" }, { "name": "cookbook/ai-agent-workspace", "title": "AI Agent Workspaces", "description": "Give every AI agent its own computer: a persistent workspace with a filesystem, processes, shells, networking, and agent sessions on a lightweight in-process OS.", "canonical_url": "https://rivet.dev/cookbook/ai-agent-workspace", "reference_url": "/metadata/skills/ai-agent-workspace/reference/cookbook/ai-agent-workspace.md" }, { "name": "general/architecture", "title": "Architecture", "description": "- rivetkit is the typescript library used for both local development & to connect your application to rivet - a rivetkit instance is called a \"runner.\" you can run multiple runners to scale rivetkit horiziotnally. read omre about runners below.", "canonical_url": "https://rivet.dev/docs/general/architecture", "reference_url": "/metadata/skills/ai-agent-workspace/reference/general/architecture.md" }, { "name": "actors/authentication", "title": "Authentication", "description": "Secure your actors with authentication and authorization.", "canonical_url": "https://rivet.dev/docs/actors/authentication", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/authentication.md" }, { "name": "agent-os/authentication", "title": "Authentication", "description": "Authenticate connections to agentOS actors using hooks.", "canonical_url": "https://rivet.dev/docs/agent-os/authentication", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/authentication.md" }, { "name": "agent-os/benchmarks", "title": "Benchmarks", "description": "Performance benchmarks comparing agentOS to traditional sandbox providers.", "canonical_url": "https://rivet.dev/docs/agent-os/benchmarks", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/benchmarks.md" }, { "name": "cookbook/chat-room", "title": "Chat Room", "description": "Build a realtime chat room backend with Rivet Actors: one actor per room, SQLite-backed message history, and WebSocket broadcast to every connected client.", "canonical_url": "https://rivet.dev/cookbook/chat-room", "reference_url": "/metadata/skills/ai-agent-workspace/reference/cookbook/chat-room.md" }, { "name": "cli", "title": "CLI", "description": "Reference for the optional rivet CLI: deploy to Rivet Compute and run local dev for serverless platforms.", "canonical_url": "https://rivet.dev/docs/cli", "reference_url": "/metadata/skills/ai-agent-workspace/reference/cli.md" }, { "name": "actors/quickstart/cloudflare", "title": "Cloudflare Workers Quickstart", "description": "Set up a Rivet project locally targeting Cloudflare Workers.", "canonical_url": "https://rivet.dev/docs/actors/quickstart/cloudflare", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/quickstart/cloudflare.md" }, { "name": "cookbook/collaborative-text-editor", "title": "Collaborative Text Editor", "description": "Build a collaborative text editor backend with Yjs CRDTs and Rivet Actors: per-document actors relay sync and awareness updates and persist snapshots.", "canonical_url": "https://rivet.dev/cookbook/collaborative-text-editor", "reference_url": "/metadata/skills/ai-agent-workspace/reference/cookbook/collaborative-text-editor.md" }, { "name": "actors/communicating-between-actors", "title": "Communicating Between Actors", "description": "Learn how actors can call other actors and share data", "canonical_url": "https://rivet.dev/docs/actors/communicating-between-actors", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/communicating-between-actors.md" }, { "name": "agent-os/configuration", "title": "Configuration", "description": "Configure the agentOS VM options, preview settings, and lifecycle hooks.", "canonical_url": "https://rivet.dev/docs/agent-os/configuration", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/configuration.md" }, { "name": "self-hosting/configuration", "title": "Configuration", "description": "Rivet Engine can be configured through environment variables or configuration files.", "canonical_url": "https://rivet.dev/docs/self-hosting/configuration", "reference_url": "/metadata/skills/ai-agent-workspace/reference/self-hosting/configuration.md" }, { "name": "actors/connections", "title": "Connections", "description": "Connections represent client connections to your actor. They provide a way to handle client authentication, manage connection-specific data, and control the connection lifecycle.", "canonical_url": "https://rivet.dev/docs/actors/connections", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/connections.md" }, { "name": "agent-os/core", "title": "Core Package", "description": "Use @rivet-dev/agent-os-core standalone for direct VM control without the Rivet Actor runtime.", "canonical_url": "https://rivet.dev/docs/agent-os/core", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/core.md" }, { "name": "agent-os/crash-course", "title": "Crash Course", "description": "Run coding agents inside isolated VMs with full filesystem, process, and network control.", "canonical_url": "https://rivet.dev/docs/agent-os/crash-course", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/crash-course.md" }, { "name": "agent-os/cron", "title": "Cron Jobs", "description": "Schedule recurring commands and agent sessions in agentOS VMs.", "canonical_url": "https://rivet.dev/docs/agent-os/cron", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/cron.md" }, { "name": "cookbook/cron-jobs", "title": "Cron Jobs and Scheduled Tasks", "description": "Durable cron jobs with Rivet Actors: schedule.after and schedule.at timers survive restarts and crashes, plus re-arming recurring jobs and idempotent handlers.", "canonical_url": "https://rivet.dev/cookbook/cron-jobs", "reference_url": "/metadata/skills/ai-agent-workspace/reference/cookbook/cron-jobs.md" }, { "name": "general/cors", "title": "Cross-Origin Resource Sharing", "description": "Cross-Origin Resource Sharing (CORS) controls which origins (domains) can access your actors. When actors are exposed to the public internet, proper origin validation is critical to prevent security breaches and denial of service attacks.", "canonical_url": "https://rivet.dev/docs/general/cors", "reference_url": "/metadata/skills/ai-agent-workspace/reference/general/cors.md" }, { "name": "actors/inspector-tabs", "title": "Custom Inspector Tabs", "description": "Ship your own UI tabs alongside a Rivet Actor — embedded directly in the dashboard inspector.", "canonical_url": "https://rivet.dev/docs/actors/inspector-tabs", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/inspector-tabs.md" }, { "name": "cookbook/per-tenant-database", "title": "Database per Tenant", "description": "Multi-tenant data isolation with one Rivet Actor per tenant: the actor key is the tenant id, so each tenant gets its own isolated dataset and migrations.", "canonical_url": "https://rivet.dev/cookbook/per-tenant-database", "reference_url": "/metadata/skills/ai-agent-workspace/reference/cookbook/per-tenant-database.md" }, { "name": "actors/debugging", "title": "Debugging", "description": "Inspect and debug running Rivet Actors, runners, and provider configs using management, runner, and actor inspector HTTP APIs.", "canonical_url": "https://rivet.dev/docs/actors/debugging", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/debugging.md" }, { "name": "deploy/aws-lambda", "title": "Deploy To Amazon Web Services Lambda", "description": "_AWS Lambda is coming soon_", "canonical_url": "https://rivet.dev/docs/deploy/aws-lambda", "reference_url": "/metadata/skills/ai-agent-workspace/reference/deploy/aws-lambda.md" }, { "name": "cookbook/vpc-air-gapped", "title": "Deploying Rivet in a VPC or Air-Gapped Network", "description": "Run Rivet entirely inside your own perimeter: single-binary or Docker Compose install, file system storage with no database infrastructure, and no outbound telemetry by default.", "canonical_url": "https://rivet.dev/cookbook/vpc-air-gapped", "reference_url": "/metadata/skills/ai-agent-workspace/reference/cookbook/vpc-air-gapped.md" }, { "name": "deploy/aws-ecs", "title": "Deploying to AWS ECS", "description": "Run your backend on Amazon ECS with Fargate.", "canonical_url": "https://rivet.dev/docs/deploy/aws-ecs", "reference_url": "/metadata/skills/ai-agent-workspace/reference/deploy/aws-ecs.md" }, { "name": "deploy/cloudflare", "title": "Deploying to Cloudflare Workers", "description": "Deploy an existing Rivet project to Cloudflare Workers.", "canonical_url": "https://rivet.dev/docs/deploy/cloudflare", "reference_url": "/metadata/skills/ai-agent-workspace/reference/deploy/cloudflare.md" }, { "name": "deploy/freestyle", "title": "Deploying to Freestyle", "description": "Deploy RivetKit app to Freestyle.sh, a cloud platform for running AI-generated code with built-in security and scalability.", "canonical_url": "https://rivet.dev/docs/deploy/freestyle", "reference_url": "/metadata/skills/ai-agent-workspace/reference/deploy/freestyle.md" }, { "name": "deploy/gcp-cloud-run", "title": "Deploying to Google Cloud Run", "description": "Deploy your RivetKit app to Google Cloud Run.", "canonical_url": "https://rivet.dev/docs/deploy/gcp-cloud-run", "reference_url": "/metadata/skills/ai-agent-workspace/reference/deploy/gcp-cloud-run.md" }, { "name": "deploy/hetzner", "title": "Deploying to Hetzner", "description": "Please see the VM & Bare Metal guide.", "canonical_url": "https://rivet.dev/docs/deploy/hetzner", "reference_url": "/metadata/skills/ai-agent-workspace/reference/deploy/hetzner.md" }, { "name": "deploy/kubernetes", "title": "Deploying to Kubernetes", "description": "Deploy your RivetKit app to any Kubernetes cluster.", "canonical_url": "https://rivet.dev/docs/deploy/kubernetes", "reference_url": "/metadata/skills/ai-agent-workspace/reference/deploy/kubernetes.md" }, { "name": "deploy/railway", "title": "Deploying to Railway", "description": "Deploy your RivetKit app to Railway.", "canonical_url": "https://rivet.dev/docs/deploy/railway", "reference_url": "/metadata/skills/ai-agent-workspace/reference/deploy/railway.md" }, { "name": "deploy/rivet-compute", "title": "Deploying to Rivet Compute", "description": "Run your backend on Rivet Compute.", "canonical_url": "https://rivet.dev/docs/deploy/rivet-compute", "reference_url": "/metadata/skills/ai-agent-workspace/reference/deploy/rivet-compute.md" }, { "name": "deploy/supabase", "title": "Deploying to Supabase Functions", "description": "Deploy an existing Rivet project to Supabase Edge Functions.", "canonical_url": "https://rivet.dev/docs/deploy/supabase", "reference_url": "/metadata/skills/ai-agent-workspace/reference/deploy/supabase.md" }, { "name": "deploy/vercel", "title": "Deploying to Vercel", "description": "Deploy your Next.js Rivet app to Vercel.", "canonical_url": "https://rivet.dev/docs/deploy/vercel", "reference_url": "/metadata/skills/ai-agent-workspace/reference/deploy/vercel.md" }, { "name": "deploy/vm-and-bare-metal", "title": "Deploying to VMs & Bare Metal", "description": "Deploy your RivetKit app to any Linux VM or bare metal host.", "canonical_url": "https://rivet.dev/docs/deploy/vm-and-bare-metal", "reference_url": "/metadata/skills/ai-agent-workspace/reference/deploy/vm-and-bare-metal.md" }, { "name": "agent-os/deployment", "title": "Deployment", "description": "Choose the right deployment option for agentOS.", "canonical_url": "https://rivet.dev/docs/agent-os/deployment", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/deployment.md" }, { "name": "actors/design-patterns", "title": "Design Patterns", "description": "Common patterns and anti-patterns for building scalable actor systems.", "canonical_url": "https://rivet.dev/docs/actors/design-patterns", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/design-patterns.md" }, { "name": "actors/destroy", "title": "Destroying Actors", "description": "Actors can be permanently destroyed. Common use cases include:", "canonical_url": "https://rivet.dev/docs/actors/destroy", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/destroy.md" }, { "name": "self-hosting/docker-compose", "title": "Docker Compose", "description": "Deploy Rivet Engine with docker-compose for multi-container setups.", "canonical_url": "https://rivet.dev/docs/self-hosting/docker-compose", "reference_url": "/metadata/skills/ai-agent-workspace/reference/self-hosting/docker-compose.md" }, { "name": "self-hosting/docker-container", "title": "Docker Container", "description": "Run Rivet Engine in a single Docker container.", "canonical_url": "https://rivet.dev/docs/self-hosting/docker-container", "reference_url": "/metadata/skills/ai-agent-workspace/reference/self-hosting/docker-container.md" }, { "name": "general/docs-for-llms", "title": "Documentation for LLMs & AI", "description": "Rivet provides optimized documentation formats specifically designed for Large Language Models (LLMs) and AI integration tools.", "canonical_url": "https://rivet.dev/docs/general/docs-for-llms", "reference_url": "/metadata/skills/ai-agent-workspace/reference/general/docs-for-llms.md" }, { "name": "general/edge", "title": "Edge Networking", "description": "Actors automatically run near your users on your provider's global network.", "canonical_url": "https://rivet.dev/docs/general/edge", "reference_url": "/metadata/skills/ai-agent-workspace/reference/general/edge.md" }, { "name": "actors/quickstart/effect", "title": "Effect.ts Quickstart (Beta)", "description": "Build a Rivet Actor with the Effect SDK", "canonical_url": "https://rivet.dev/docs/actors/quickstart/effect", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/quickstart/effect.md" }, { "name": "agent-os/llm-gateway", "title": "Embedded LLM Gateway", "description": "Route, meter, and manage LLM API calls from agents.", "canonical_url": "https://rivet.dev/docs/agent-os/llm-gateway", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/llm-gateway.md" }, { "name": "general/endpoints", "title": "Endpoints", "description": "Configure how your backend connects to Rivet and how clients reach your actors.", "canonical_url": "https://rivet.dev/docs/general/endpoints", "reference_url": "/metadata/skills/ai-agent-workspace/reference/general/endpoints.md" }, { "name": "general/environment-variables", "title": "Environment Variables", "description": "This page documents all environment variables that configure RivetKit behavior.", "canonical_url": "https://rivet.dev/docs/general/environment-variables", "reference_url": "/metadata/skills/ai-agent-workspace/reference/general/environment-variables.md" }, { "name": "actors/errors", "title": "Errors", "description": "Rivet provides robust error handling with security built in by default. Errors are handled differently based on whether they should be exposed to clients or kept private.", "canonical_url": "https://rivet.dev/docs/actors/errors", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/errors.md" }, { "name": "agent-os/events", "title": "Events", "description": "Full event catalog with payload shapes for agentOS.", "canonical_url": "https://rivet.dev/docs/agent-os/events", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/events.md" }, { "name": "actors/fetch-and-websocket-handler", "title": "Fetch and WebSocket Handler", "description": "These docs have moved to [Low-Level WebSocket Handler](/docs/actors/websocket-handler) and [Low-Level Request Handler](/docs/actors/request-handler).", "canonical_url": "https://rivet.dev/docs/actors/fetch-and-websocket-handler", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/fetch-and-websocket-handler.md" }, { "name": "self-hosting/filesystem", "title": "File System", "description": "The file system backend stores all data on the local disk. This is suitable for single-node deployments, development, and testing.", "canonical_url": "https://rivet.dev/docs/self-hosting/filesystem", "reference_url": "/metadata/skills/ai-agent-workspace/reference/self-hosting/filesystem.md" }, { "name": "agent-os/filesystem", "title": "Filesystem", "description": "Read, write, mount, and manage files inside agentOS.", "canonical_url": "https://rivet.dev/docs/agent-os/filesystem", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/filesystem.md" }, { "name": "self-hosting/foundationdb", "title": "FoundationDB (Enterprise)", "description": "FoundationDB is the recommended storage backend for scalable production Rivet deployments.", "canonical_url": "https://rivet.dev/docs/self-hosting/foundationdb", "reference_url": "/metadata/skills/ai-agent-workspace/reference/self-hosting/foundationdb.md" }, { "name": "actors/helper-types", "title": "Helper Types", "description": "This page has moved to [Types](/docs/actors/types).", "canonical_url": "https://rivet.dev/docs/actors/helper-types", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/helper-types.md" }, { "name": "general/http-server", "title": "HTTP Server", "description": "Different ways to run your RivetKit HTTP server.", "canonical_url": "https://rivet.dev/docs/general/http-server", "reference_url": "/metadata/skills/ai-agent-workspace/reference/general/http-server.md" }, { "name": "actors/appearance", "title": "Icons & Names", "description": "Customize actors with display names and icons for the Rivet inspector and dashboard.", "canonical_url": "https://rivet.dev/docs/actors/appearance", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/appearance.md" }, { "name": "actors/state", "title": "In-Memory State", "description": "Actors store state in memory for instant reads and writes. State can be persisted automatically or kept ephemeral.", "canonical_url": "https://rivet.dev/docs/actors/state", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/state.md" }, { "name": "actors/input", "title": "Input Parameters", "description": "Pass initialization data to actors when creating instances", "canonical_url": "https://rivet.dev/docs/actors/input", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/input.md" }, { "name": "self-hosting/install", "title": "Installing Rivet Engine", "description": "Install Rivet Engine using Docker, binaries, or a source build.", "canonical_url": "https://rivet.dev/docs/self-hosting/install", "reference_url": "/metadata/skills/ai-agent-workspace/reference/self-hosting/install.md" }, { "name": "self-hosting/kubernetes", "title": "Kubernetes", "description": "Deploy production-ready Rivet Engine to Kubernetes with PostgreSQL storage.", "canonical_url": "https://rivet.dev/docs/self-hosting/kubernetes", "reference_url": "/metadata/skills/ai-agent-workspace/reference/self-hosting/kubernetes.md" }, { "name": "actors/lifecycle", "title": "Lifecycle", "description": "Learn about actor lifecycle hooks for initialization, state management, and cleanup.", "canonical_url": "https://rivet.dev/docs/actors/lifecycle", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/lifecycle.md" }, { "name": "agent-os/limitations", "title": "Limitations", "description": "What the agentOS VM does not support, and how to work around it.", "canonical_url": "https://rivet.dev/docs/agent-os/limitations", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/limitations.md" }, { "name": "actors/limits", "title": "Limits", "description": "Limits and constraints for Rivet Actors.", "canonical_url": "https://rivet.dev/docs/actors/limits", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/limits.md" }, { "name": "cookbook/live-cursors", "title": "Live Cursors and Presence", "description": "Live cursors and multiplayer presence with Rivet Actors: per-connection cursor state, realtime updates over events or raw WebSockets, and throttling.", "canonical_url": "https://rivet.dev/cookbook/live-cursors", "reference_url": "/metadata/skills/ai-agent-workspace/reference/cookbook/live-cursors.md" }, { "name": "agent-os/llm-credentials", "title": "LLM Credentials", "description": "Pass LLM API keys to agent sessions securely.", "canonical_url": "https://rivet.dev/docs/agent-os/llm-credentials", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/llm-credentials.md" }, { "name": "general/logging", "title": "Logging", "description": "Actors provide a built-in way to log complex data to the console.", "canonical_url": "https://rivet.dev/docs/general/logging", "reference_url": "/metadata/skills/ai-agent-workspace/reference/general/logging.md" }, { "name": "actors/request-handler", "title": "Low-Level HTTP Request Handler", "description": "Actors can handle HTTP requests through the `onRequest` handler.", "canonical_url": "https://rivet.dev/docs/actors/request-handler", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/request-handler.md" }, { "name": "actors/kv", "title": "Low-Level KV Storage", "description": "Use the built-in key-value store on ActorContext for durable string and binary data alongside actor state.", "canonical_url": "https://rivet.dev/docs/actors/kv", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/kv.md" }, { "name": "actors/websocket-handler", "title": "Low-Level WebSocket Handler", "description": "Actors can handle WebSocket connections through the `onWebSocket` handler.", "canonical_url": "https://rivet.dev/docs/actors/websocket-handler", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/websocket-handler.md" }, { "name": "actors/metadata", "title": "Metadata", "description": "Metadata provides information about the currently running actor.", "canonical_url": "https://rivet.dev/docs/actors/metadata", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/metadata.md" }, { "name": "self-hosting/multi-region", "title": "Multi-Region", "description": "Rivet Engine supports scaling transparently across multiple regions.", "canonical_url": "https://rivet.dev/docs/self-hosting/multi-region", "reference_url": "/metadata/skills/ai-agent-workspace/reference/self-hosting/multi-region.md" }, { "name": "agent-os/multiplayer", "title": "Multiplayer", "description": "Connect multiple clients to the same agentOS actor for collaborative agent workflows.", "canonical_url": "https://rivet.dev/docs/agent-os/multiplayer", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/multiplayer.md" }, { "name": "cookbook/multiplayer-game", "title": "Multiplayer Game", "description": "Pragmatic patterns for building multiplayer games: matchmaking, tick loops, realtime state, interest management, and validation.", "canonical_url": "https://rivet.dev/cookbook/multiplayer-game", "reference_url": "/metadata/skills/ai-agent-workspace/reference/cookbook/multiplayer-game.md" }, { "name": "agent-os/networking", "title": "Networking & Previews", "description": "Proxy HTTP requests into agentOS VMs and create shareable preview URLs.", "canonical_url": "https://rivet.dev/docs/agent-os/networking", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/networking.md" }, { "name": "actors/quickstart/next-js", "title": "Next.js Quickstart", "description": "Get started with Rivet Actors in Next.js", "canonical_url": "https://rivet.dev/docs/actors/quickstart/next-js", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/quickstart/next-js.md" }, { "name": "clients/javascript", "title": "Node.js & Bun", "description": "Connect JavaScript apps to Rivet Actors.", "canonical_url": "https://rivet.dev/docs/clients/javascript", "reference_url": "/metadata/skills/ai-agent-workspace/reference/clients/javascript.md" }, { "name": "actors/quickstart/backend", "title": "Node.js & Bun Quickstart", "description": "Get started with Rivet Actors in Node.js and Bun", "canonical_url": "https://rivet.dev/docs/actors/quickstart/backend", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/quickstart/backend.md" }, { "name": "agent-os/permissions", "title": "Permissions", "description": "Approve or deny agent tool use with human-in-the-loop or auto-approve patterns.", "canonical_url": "https://rivet.dev/docs/agent-os/permissions", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/permissions.md" }, { "name": "agent-os/persistence", "title": "Persistence & Sleep", "description": "How agentOS persists data and manages sleep/wake cycles.", "canonical_url": "https://rivet.dev/docs/agent-os/persistence", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/persistence.md" }, { "name": "agent-os/agents/pi", "title": "Pi", "description": "Run the Pi coding agent inside a VM with extensions and custom configuration.", "canonical_url": "https://rivet.dev/docs/agent-os/agents/pi", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/agents/pi.md" }, { "name": "general/pool-configuration", "title": "Pool Configuration", "description": "Reference for runner pool configuration, including drain behavior, actor eviction rate limiting, and serverless-specific options.", "canonical_url": "https://rivet.dev/docs/general/pool-configuration", "reference_url": "/metadata/skills/ai-agent-workspace/reference/general/pool-configuration.md" }, { "name": "self-hosting/postgres", "title": "PostgreSQL", "description": "Configure PostgreSQL for self-hosted Rivet deployments.", "canonical_url": "https://rivet.dev/docs/self-hosting/postgres", "reference_url": "/metadata/skills/ai-agent-workspace/reference/self-hosting/postgres.md" }, { "name": "agent-os/processes", "title": "Processes & Shell", "description": "Execute commands, spawn long-running processes, and open interactive shells in agentOS VMs.", "canonical_url": "https://rivet.dev/docs/agent-os/processes", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/processes.md" }, { "name": "general/production-checklist", "title": "Production Checklist", "description": "Checklist for deploying Rivet Actors to production.", "canonical_url": "https://rivet.dev/docs/general/production-checklist", "reference_url": "/metadata/skills/ai-agent-workspace/reference/general/production-checklist.md" }, { "name": "self-hosting/production-checklist", "title": "Production Checklist", "description": "Checklist for deploying a self-hosted Rivet Engine to production.", "canonical_url": "https://rivet.dev/docs/self-hosting/production-checklist", "reference_url": "/metadata/skills/ai-agent-workspace/reference/self-hosting/production-checklist.md" }, { "name": "agent-os/queues", "title": "Queues", "description": "Serialize agent work with durable queues for backpressure and rate limiting.", "canonical_url": "https://rivet.dev/docs/agent-os/queues", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/queues.md" }, { "name": "actors/queues", "title": "Queues & Run Loops", "description": "Use actor-local durable queues for serial run loops and request/response workflows.", "canonical_url": "https://rivet.dev/docs/actors/queues", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/queues.md" }, { "name": "agent-os/quickstart", "title": "Quickstart", "description": "Set up an agentOS actor, create a session, and run your first coding agent.", "canonical_url": "https://rivet.dev/docs/agent-os/quickstart", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/quickstart.md" }, { "name": "self-hosting/railway", "title": "Railway Deployment", "description": "Railway provides a simple platform for deploying Rivet Engine with automatic scaling and managed infrastructure.", "canonical_url": "https://rivet.dev/docs/self-hosting/railway", "reference_url": "/metadata/skills/ai-agent-workspace/reference/self-hosting/railway.md" }, { "name": "clients/react", "title": "React", "description": "Connect React apps to Rivet Actors.", "canonical_url": "https://rivet.dev/docs/clients/react", "reference_url": "/metadata/skills/ai-agent-workspace/reference/clients/react.md" }, { "name": "actors/quickstart/react", "title": "React Quickstart", "description": "Build realtime React applications with Rivet Actors", "canonical_url": "https://rivet.dev/docs/actors/quickstart/react", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/quickstart/react.md" }, { "name": "actors/events", "title": "Realtime", "description": "Events enable realtime communication from actors to clients. While clients use actions to send data to actors, events allow actors to push updates to connected clients instantly.", "canonical_url": "https://rivet.dev/docs/actors/events", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/events.md" }, { "name": "general/registry-configuration", "title": "Registry Configuration", "description": "This page documents the configuration options available when setting up a RivetKit registry. The registry configuration is passed to the `setup()` function.", "canonical_url": "https://rivet.dev/docs/general/registry-configuration", "reference_url": "/metadata/skills/ai-agent-workspace/reference/general/registry-configuration.md" }, { "name": "self-hosting/render", "title": "Render Deployment", "description": "Deploy Rivet Engine to Render with managed PostgreSQL and automatic HTTPS, using the experimental PostgreSQL backend.", "canonical_url": "https://rivet.dev/docs/self-hosting/render", "reference_url": "/metadata/skills/ai-agent-workspace/reference/self-hosting/render.md" }, { "name": "general/runtime-modes", "title": "Runtime Modes", "description": "RivetKit supports two runtime modes for running your actors:", "canonical_url": "https://rivet.dev/docs/general/runtime-modes", "reference_url": "/metadata/skills/ai-agent-workspace/reference/general/runtime-modes.md" }, { "name": "actors/quickstart/rust", "title": "Rust Quickstart (Beta)", "description": "Build a Rivet Actor in Rust", "canonical_url": "https://rivet.dev/docs/actors/quickstart/rust", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/quickstart/rust.md" }, { "name": "agent-os/sandbox", "title": "Sandbox Mounting", "description": "Extend agentOS with full sandboxes for heavy workloads like browsers, desktop automation, and compilation.", "canonical_url": "https://rivet.dev/docs/agent-os/sandbox", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/sandbox.md" }, { "name": "actors/scaling", "title": "Scaling & Concurrency", "description": "This page has moved to [design patterns](/docs/actors/design-patterns).", "canonical_url": "https://rivet.dev/docs/actors/scaling", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/scaling.md" }, { "name": "agent-os/security", "title": "Security & Auth", "description": "Configure resource limits, network control, authentication, and filesystem isolation for agentOS.", "canonical_url": "https://rivet.dev/docs/agent-os/security", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/security.md" }, { "name": "agent-os/security-model", "title": "Security Model", "description": "Trust boundaries, isolation guarantees, and the agentOS threat model.", "canonical_url": "https://rivet.dev/docs/agent-os/security-model", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/security-model.md" }, { "name": "agent-os/sessions", "title": "Sessions", "description": "Create agent sessions, send prompts, stream responses, and replay event history.", "canonical_url": "https://rivet.dev/docs/agent-os/sessions", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/sessions.md" }, { "name": "actors/sharing-and-joining-state", "title": "Sharing and Joining State", "description": "This page has moved to [design patterns](/docs/actors/design-patterns).", "canonical_url": "https://rivet.dev/docs/actors/sharing-and-joining-state", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/sharing-and-joining-state.md" }, { "name": "agent-os/software", "title": "Software", "description": "Install software packages and configure the commands available inside agentOS.", "canonical_url": "https://rivet.dev/docs/agent-os/software", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/software.md" }, { "name": "actors/sqlite", "title": "SQLite", "description": "Use embedded SQLite in Rivet Actors with raw SQL queries.", "canonical_url": "https://rivet.dev/docs/actors/sqlite", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/sqlite.md" }, { "name": "agent-os/sqlite", "title": "SQLite", "description": "Give agents access to a persistent SQLite database via host tools.", "canonical_url": "https://rivet.dev/docs/agent-os/sqlite", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/sqlite.md" }, { "name": "actors/sqlite-drizzle", "title": "SQLite + Drizzle", "description": "Use Drizzle ORM with embedded SQLite in Rivet Actors.", "canonical_url": "https://rivet.dev/docs/actors/sqlite-drizzle", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/sqlite-drizzle.md" }, { "name": "actors/quickstart/supabase", "title": "Supabase Functions Quickstart", "description": "Set up a Rivet project locally targeting Supabase Edge Functions.", "canonical_url": "https://rivet.dev/docs/actors/quickstart/supabase", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/quickstart/supabase.md" }, { "name": "clients/swift", "title": "Swift", "description": "Connect Swift apps to Rivet Actors.", "canonical_url": "https://rivet.dev/docs/clients/swift", "reference_url": "/metadata/skills/ai-agent-workspace/reference/clients/swift.md" }, { "name": "clients/swiftui", "title": "SwiftUI", "description": "Build SwiftUI apps with Rivet Actors.", "canonical_url": "https://rivet.dev/docs/clients/swiftui", "reference_url": "/metadata/skills/ai-agent-workspace/reference/clients/swiftui.md" }, { "name": "agent-os/system-prompt", "title": "System Prompt", "description": "How agentOS injects context into agent sessions.", "canonical_url": "https://rivet.dev/docs/agent-os/system-prompt", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/system-prompt.md" }, { "name": "actors/testing", "title": "Testing", "description": "Rivet provides a straightforward testing framework to build reliable and maintainable applications. This guide covers how to write effective tests for your actor-based services.", "canonical_url": "https://rivet.dev/docs/actors/testing", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/testing.md" }, { "name": "self-hosting/tls", "title": "TLS & Certificates", "description": "How Rivet validates TLS root certificates.", "canonical_url": "https://rivet.dev/docs/self-hosting/tls", "reference_url": "/metadata/skills/ai-agent-workspace/reference/self-hosting/tls.md" }, { "name": "agent-os/tools", "title": "Tools", "description": "Expose custom tools to agents as CLI commands inside the VM.", "canonical_url": "https://rivet.dev/docs/agent-os/tools", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/tools.md" }, { "name": "actors/troubleshooting", "title": "Troubleshooting", "description": "Common issues with Rivet Actors and how to resolve them.", "canonical_url": "https://rivet.dev/docs/actors/troubleshooting", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/troubleshooting.md" }, { "name": "actors/types", "title": "Types", "description": "TypeScript types for working with Rivet Actors. This page covers context types used in lifecycle hooks and actions, as well as helper types for extracting types from actor definitions.", "canonical_url": "https://rivet.dev/docs/actors/types", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/types.md" }, { "name": "actors/http-api", "title": "Vanilla HTTP API", "description": "Use the low-level HTTP handler to send and receive requests from actors.", "canonical_url": "https://rivet.dev/docs/actors/http-api", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/http-api.md" }, { "name": "actors/versions", "title": "Versions & Upgrades", "description": "When you deploy new code, Rivet ensures actors are upgraded seamlessly without downtime.", "canonical_url": "https://rivet.dev/docs/actors/versions", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/versions.md" }, { "name": "general/wasm-vs-native-sdk", "title": "WASM vs Native SDK", "description": "RivetKit runs your actors on a native or a WebAssembly runtime depending on your platform.", "canonical_url": "https://rivet.dev/docs/general/wasm-vs-native-sdk", "reference_url": "/metadata/skills/ai-agent-workspace/reference/general/wasm-vs-native-sdk.md" }, { "name": "agent-os/webhooks", "title": "Webhooks", "description": "Trigger agent workflows from external webhooks using Hono and queues.", "canonical_url": "https://rivet.dev/docs/agent-os/webhooks", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/webhooks.md" }, { "name": "agent-os/workflows", "title": "Workflow Automation", "description": "Orchestrate multi-step agent tasks with durable workflows.", "canonical_url": "https://rivet.dev/docs/agent-os/workflows", "reference_url": "/metadata/skills/ai-agent-workspace/reference/agent-os/workflows.md" }, { "name": "actors/workflows", "title": "Workflows", "description": "Build durable, replayable run loops in Rivet Actors with steps, queue waits, timers, and rollback.", "canonical_url": "https://rivet.dev/docs/actors/workflows", "reference_url": "/metadata/skills/ai-agent-workspace/reference/actors/workflows.md" } ] }