# Replicas Docs

- [Welcome](https://docs.replicas.dev/index.md): Set up Replicas, connect your tools, and send coding agents to work.
- [Quickstart](https://docs.replicas.dev/quickstart.md): Set up Replicas and create your first workspace in 5 minutes.
- [Workspaces](https://docs.replicas.dev/features/workspaces/overview.md): Understand workspace setup, tools, collaboration, and lifecycle.
- [Environments](https://docs.replicas.dev/features/environments.md): Configure variables, files, skills, MCPs, plugins, start hooks, and warm hooks for your workspaces.
- [Repository Config](https://docs.replicas.dev/features/workspaces/repository-configuration.md): Configure environment setup on workspaces.
- [Plan mode](https://docs.replicas.dev/features/workspaces/plan-mode.md): Ask agents to propose a plan before they change code.
- [Fast mode](https://docs.replicas.dev/features/workspaces/fast-mode.md): Speed up agent responses with a faster service tier.
- [Multitask mode](https://docs.replicas.dev/features/workspaces/multitask-mode.md): Delegate work to subagent workspaces that report back to your chat.
- [Canvas](https://docs.replicas.dev/features/workspaces/canvas.md): Files agents drop into the workspace for you to view in the app.
- [Chat forking](https://docs.replicas.dev/features/workspaces/chat-forking.md): Move a chat to another coding agent harness without losing its context.
- [Workspace Identity](https://docs.replicas.dev/features/workspaces/workspace-identity.md): Let agents authenticate to AWS, Google Cloud, MCP servers, and your own APIs with short-lived tokens instead of stored keys.
- [Static Egress IP](https://docs.replicas.dev/features/static-egress-ip.md): Send a workspace's traffic to chosen destinations through one permanent address that your systems can allowlist.
- [Claude Code](https://docs.replicas.dev/features/coding-agents/claude-code.md): Run Claude Code agents in Replicas workspaces.
- [Codex](https://docs.replicas.dev/features/coding-agents/codex.md): Run OpenAI Codex agents in Replicas workspaces.
- [Cursor](https://docs.replicas.dev/features/coding-agents/cursor.md): Run Cursor Composer agents in Replicas workspaces.
- [Muse Code](https://docs.replicas.dev/features/coding-agents/muse-code.md): Run Muse Code with your Muse subscription or API key in Replicas workspaces.
- [Opencode](https://docs.replicas.dev/features/coding-agents/opencode.md): Run Opencode agents in Replicas workspaces with OpenCode Go, Aster, or OpenRouter.
- [Pi](https://docs.replicas.dev/features/coding-agents/pi.md): Run OpenCode Go-, Aster-, or OpenRouter-backed Pi coding agents in Replicas workspaces.
- [GitHub](https://docs.replicas.dev/features/github.md): Trigger tasks from GitHub issues and iterate on pull requests with Replicas.
- [GitLab](https://docs.replicas.dev/features/gitlab.md): Trigger tasks from GitLab issues and iterate on merge requests with Replicas.
- [Linear](https://docs.replicas.dev/features/linear.md): Assign tasks to Replicas directly from Linear.
- [Slack](https://docs.replicas.dev/features/slack.md): Trigger tasks by mentioning @Replicas in Slack channels, or by messaging the bot directly.
- [Sentry](https://docs.replicas.dev/features/sentry.md): Fire automations from Sentry issue alerts and new errors.
- [Infisical](https://docs.replicas.dev/features/infisical.md): Sync Infisical secrets and use the CLI automatically in workspaces.
- [Doppler](https://docs.replicas.dev/features/doppler.md): Sync environment variables from Doppler into workspaces.
- [Automations](https://docs.replicas.dev/features/automations.md): Run agents on a schedule or in response to GitHub, GitLab, Slack, Sentry, or custom webhook events.
- [Learnings](https://docs.replicas.dev/features/learnings.md): Save your team's preferences as learnings that agents load automatically.
- [API guide](https://docs.replicas.dev/features/api.md): Authenticate, create workspaces, and build on the Replicas API.
- [CLI](https://docs.replicas.dev/features/cli.md): Connect to workspaces from your terminal.
- [MCP](https://docs.replicas.dev/features/mcp.md): Use Replicas from Claude Desktop, Poke, and other MCP clients.
- [Plugins](https://docs.replicas.dev/features/plugins.md): Install tools for Replicas agents on an environment.
- [Mobile testing](https://docs.replicas.dev/features/mobile-testing.md): Build and test iOS and Android apps in cloud devices from a workspace.
- [iOS app](https://docs.replicas.dev/features/mobile-app.md): Start, steer, and review cloud coding agents from your iPhone.
- [Desktop app](https://docs.replicas.dev/features/desktop-app.md): Run Replicas in a focused macOS or Linux window.
- [Team](https://docs.replicas.dev/admin/team.md): Invite members and manage roles.
- [Defaults](https://docs.replicas.dev/admin/defaults.md): Org-wide defaults for agents, models, and workspaces.
- [Security policies](https://docs.replicas.dev/admin/security.md): Require user identity and code-host attribution, block agent merges, and manage static egress.
- [Audit Log](https://docs.replicas.dev/admin/audit-log.md): Track configuration changes across your organization.
- [Analytics](https://docs.replicas.dev/admin/analytics.md): See how much work Replicas is shipping for your organization.
- [Credentials](https://docs.replicas.dev/admin/credentials.md): Configure coding agents and integrations.
- [Profile](https://docs.replicas.dev/features/profile.md): Choose the name and photo teammates see in Replicas.
- [Billing](https://docs.replicas.dev/admin/billing.md): Compare plans, manage Full and Flex seats, and understand your monthly invoice.
- [Data Retention](https://docs.replicas.dev/admin/data-retention.md): How Replicas retains workspace data and how admins can turn retention off.
- [Changelog](https://docs.replicas.dev/changelog.md): Weekly product updates and announcements
- [List models for the active inference provider](https://docs.replicas.dev/api-reference/credentials/list-models-for-the-active-inference-provider.md): Uses the workspace selection or harness credential priority. Before workspace creation, pass method and scope to preview a connected inference provider. Returns provider editability and an optional default model; null requires explicit selection.
- [List Organization Conversations](https://docs.replicas.dev/api-reference/replica/list-organization-conversations.md): Returns persisted conversations across every non-deleted workspace in the organization without waking workspaces. Requires an organization API key or an organization-admin session. Deleted chats, conversations not retained under the organization's data-retention settings, and older workspaces whose…
- [List Replicas](https://docs.replicas.dev/api-reference/replica/list-replicas.md): Returns a paginated list of all replicas in your organization. Supports filtering by user, source, and status. For this API endpoint, results are ordered by newest `created_at` first, except `status=archived` results are ordered by most recent interaction (message sends and agent turns, falling back…
- [Create Replica](https://docs.replicas.dev/api-reference/replica/create-replica.md): Creates a new replica in your organization and sends an initial message to the coding agent. User-session JWTs are not accepted for workspace creation; use an API key or workspace engine secret. The workspace and agent are initialized asynchronously. Each organization can have up to 100 metered API…
- [Get Replica](https://docs.replicas.dev/api-reference/replica/get-replica.md): Returns detailed information about a specific replica by its ID. Use the `include` query parameter to request additional data such as environment configuration and diffs. If the workspace is sleeping, it will be woken and the response will indicate this with `waking: true`. Archived workspaces remai…
- [Delete Replica](https://docs.replicas.dev/api-reference/replica/delete-replica.md): Deletes a replica by its ID. This terminates the underlying sandbox and processes any outstanding billing.
- [Send Message](https://docs.replicas.dev/api-reference/replica/send-message.md): Sends a message to an existing replica. Sleeping workspaces wake automatically, and archived workspaces are restored automatically before message delivery. Supports targeting a specific chat, choosing a coding agent and model, attaching images, and enabling plan mode.
- [List Chats](https://docs.replicas.dev/api-reference/replica/list-chats.md): Returns a list of chats for a replica.
- [Create Chat](https://docs.replicas.dev/api-reference/replica/create-chat.md): Creates a new chat session for a replica.
- [Delete Chat](https://docs.replicas.dev/api-reference/replica/delete-chat.md): Deletes a chat session from a replica.
- [List Slash Commands](https://docs.replicas.dev/api-reference/replica/list-slash-commands.md): Returns built-in Replicas slash commands and agent-provided commands for a chat, including Claude, Codex ASP, Cursor, Muse, Opencode, and Pi commands.
- [Read History](https://docs.replicas.dev/api-reference/replica/read-history.md): Reads conversation history from the end. Omit `limit` for the full history. For earlier pages, pass the previous response's opaque `beforeCursor`, which keeps events and Codex turns aligned. Continue until `beforeCursor` is null. Legacy index-based clients can pass `eventsStartIndex` as `beforeEvent…
- [Get Hook Logs](https://docs.replicas.dev/api-reference/replica/get-hook-logs.md): Returns the warm hook and start hook execution logs for a replica.
- [Stream Events](https://docs.replicas.dev/api-reference/replica/stream-events.md): Opens a Server-Sent Events (SSE) stream for real-time events from a replica. The connection remains open and events are pushed as they occur.
- [Get a Media Download URL](https://docs.replicas.dev/api-reference/media/get-a-media-download-url.md): Returns a short-lived object storage URL with attachment disposition for downloading an organization-owned media item.
- [Get a Media Preview URL](https://docs.replicas.dev/api-reference/media/get-a-media-preview-url.md): Returns a short-lived object storage URL with inline disposition for rendering an organization-owned image, video, audio file, or HTML page. Clients must sandbox HTML previews.
- [List Environments](https://docs.replicas.dev/api-reference/environments/list-environments.md): Returns environments visible to the caller, including the singleton Global environment for org scope. Each record includes counts of attached variables, files, skills, and MCPs.
- [Create Environment](https://docs.replicas.dev/api-reference/environments/create-environment.md): Creates a new shared or personal environment. Plain shared environments use the organization's new-environment access default; a non-admin may create one only when that default grants Write. A shared copy requires Write on its shared source and inherits the source access policy. A personal overlay r…
- [Get Environment](https://docs.replicas.dev/api-reference/environments/get-environment.md): Returns a single environment. Pass the literal string `global` for the org's singleton Global environment (auto-created on first access — no need to look up its UUID first).
- [Delete Environment](https://docs.replicas.dev/api-reference/environments/delete-environment.md): Deletes an environment. Any plugins installed on it are uninstalled with it and their provider authorizations revoked. Returns 409 when an automation still references the environment, when personal environments inherit from it, or when called against the Global environment (which cannot be deleted).
- [Update Environment](https://docs.replicas.dev/api-reference/environments/update-environment.md): Updates a non-global environment. Only provided fields are changed. Set `repository_id` and `repository_set_id` to null to clear the repository binding, including while automations reference the environment. `PATCH /v1/environments/global` returns 400 with a pointer to the nested resource endpoints…
- [Get Workspace Identity Configuration](https://docs.replicas.dev/api-reference/environments/get-workspace-identity-configuration.md): Returns the issuer, discovery and JWKS URLs that workspace identity tokens are verified against. Requires a Team or Enterprise plan or an active trial.
- [List Environment Variables](https://docs.replicas.dev/api-reference/environments/list-environment-variables.md): Returns every variable attached to the environment. Values are returned in plaintext (they are encrypted at rest, decrypted on read).
- [Create Environment Variable](https://docs.replicas.dev/api-reference/environments/create-environment-variable.md): Adds a new variable to the environment. Values are encrypted at rest. The `(environment, key)` pair must be unique within the org. Source-backed personal environments can override inherited variable keys only when the inherited variable has `personal_override_allowed: true`.
- [Delete Environment Variable](https://docs.replicas.dev/api-reference/environments/delete-environment-variable.md)
- [Update Environment Variable](https://docs.replicas.dev/api-reference/environments/update-environment-variable.md): Updates a variable. Only provided fields are changed. Source-backed personal environments can override inherited variable keys only when the inherited variable has `personal_override_allowed: true`.
- [List Environment Files](https://docs.replicas.dev/api-reference/environments/list-environment-files.md): Returns every file attached to the environment. Files are dropped into the workspace at the configured `path` when the workspace is provisioned.
- [Create Environment File](https://docs.replicas.dev/api-reference/environments/create-environment-file.md): Adds a new file to the environment. Maximum content size is 64 KB (65,536 bytes). The `path` is validated against allowed locations (typically under `~/`).
- [Delete Environment File](https://docs.replicas.dev/api-reference/environments/delete-environment-file.md)
- [Update Environment File](https://docs.replicas.dev/api-reference/environments/update-environment-file.md)
- [List Environment Skills](https://docs.replicas.dev/api-reference/environments/list-environment-skills.md): Returns every skill enabled on the environment. Skills come from [skills.sh](https://skills.sh) and are installed into workspaces created from the environment.
- [Enable Environment Skill](https://docs.replicas.dev/api-reference/environments/enable-environment-skill.md): Enables a skill on the environment. Use [GET /v1/environment-skills/search](#tag/Environments/operation/searchEnvironmentSkills) to discover skills first, then enable them with this endpoint. Returns 409 if the skill (by `slug` or `source`) is already enabled on the environment.
- [Disable Environment Skill](https://docs.replicas.dev/api-reference/environments/disable-environment-skill.md): Disables a previously enabled skill on the environment.
- [List Skill Registries](https://docs.replicas.dev/api-reference/environments/list-skill-registries.md): Returns every skill registry configured on the environment, along with the discovered skills from each registry repository.
- [Add Skill Registry](https://docs.replicas.dev/api-reference/environments/add-skill-registry.md): Adds a GitHub repository as a skill registry on the environment. Skills discovered in the repository are installed into workspaces at provisioning time.
- [Remove Skill Registry](https://docs.replicas.dev/api-reference/environments/remove-skill-registry.md): Removes a skill registry from the environment.
- [List Skills From Bound Repo](https://docs.replicas.dev/api-reference/environments/list-skills-from-bound-repo.md): Returns skills, agents, commands, prompts, and rule files committed to the repository (or repository set) the environment is bound to. Resolved live from the repo's default branch via GitHub. Read-only: these are sourced from the user's git tree, not from `skills.sh`. When the environment is not bou…
- [List Environment MCPs](https://docs.replicas.dev/api-reference/environments/list-environment-mcps.md): Returns every MCP (Model Context Protocol server) attached to the environment.
- [Create Environment MCP](https://docs.replicas.dev/api-reference/environments/create-environment-mcp.md): Adds a new MCP server to the environment. `name` must match `^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$` and cannot start with reserved prefix `replicas-`. The `config` shape depends on the `transport`: stdio uses `{ command, args, env }`; http and sse use `{ url, headers }`.
- [Delete Environment MCP](https://docs.replicas.dev/api-reference/environments/delete-environment-mcp.md)
- [Update Environment MCP](https://docs.replicas.dev/api-reference/environments/update-environment-mcp.md): Updates an MCP. Only provided fields are changed. When changing `transport`, `config` is required and must match the new transport's shape.
- [Get Warm Hooks State](https://docs.replicas.dev/api-reference/environments/get-warm-hooks-state.md): Returns the environment's own active warm hook (if any), warm pool config and current counts (if any), and up to 20 retained snapshots ordered newest first. For a source-backed personal environment, fetch its `source_environment_id` separately to read the inherited source hook and pool snapshot hist…
- [Save Warm Hook](https://docs.replicas.dev/api-reference/environments/save-warm-hook.md): Persists and activates the supplied script as the warm hook for the environment without running a test. Source-backed personal environments may save an additive personal hook; during pre-warming it runs after the Global and source environment hooks. Use this endpoint when you want to save quickly wi…
- [Save and Test Warm Hook](https://docs.replicas.dev/api-reference/environments/save-and-test-warm-hook.md): Saves the supplied script as the active warm hook for the environment and runs it in an isolated sandbox. For a source-backed personal environment, the test runs the Global hook, inherited source hook, and supplied personal hook in that order. The new version is activated only when the test passes.…
- [Test Warm Hook](https://docs.replicas.dev/api-reference/environments/test-warm-hook.md): Runs the supplied script in an isolated sandbox without persisting it. For a source-backed personal environment, the test runs the Global hook, inherited source hook, and supplied personal hook in that order. Useful for iterating on a warm hook from the API before committing it via `save-test`. Take…
- [Get Start Hook](https://docs.replicas.dev/api-reference/environments/get-start-hook.md): Returns the environment's own active start hook, if any. For a source-backed personal environment, fetch `source_environment_id` separately to read its inherited hook. Start hooks run at workspace boot before repository-level hooks.
- [Save Start Hook](https://docs.replicas.dev/api-reference/environments/save-start-hook.md): Persists and activates the supplied script as the environment's own start hook. Empty content clears it. A source-backed personal environment may save an additive hook that runs after the Global and source hooks. Editing a start hook does not invalidate the warm pool.
- [Test Start Hook](https://docs.replicas.dev/api-reference/environments/test-start-hook.md): Runs the supplied start hook script in an isolated sandbox without persisting it and returns the full result. For a source-backed personal environment, the test runs the Global hook, inherited source hook, then the supplied personal hook. Takes 30–90 seconds to return.
- [Test Start Hook (Streaming)](https://docs.replicas.dev/api-reference/environments/test-start-hook-streaming.md): Provisions an isolated sandbox, runs the supplied start hook script, and streams output as Server-Sent Events. For a source-backed personal environment, the test runs the Global hook, inherited source hook, then the supplied personal hook. Events emitted: `progress`, `output`, `complete`, and `error…
- [Enable or Disable Warm Pool](https://docs.replicas.dev/api-reference/environments/enable-or-disable-warm-pool.md): Enables or disables the warm pool for the environment. The target pool size is fixed by the platform; only `enabled` is configurable from the API.
- [Refresh Warm Pool](https://docs.replicas.dev/api-reference/environments/refresh-warm-pool.md): Invalidates the current warm-pool generation and immediately starts reconciling a fresh pool. Refreshes are limited to one every two minutes per environment. Source-backed personal environments must refresh through their source environment.
- [Restore Warm Pool Snapshot](https://docs.replicas.dev/api-reference/environments/restore-warm-pool-snapshot.md): Creates a new warm-pool generation from a retained snapshot without rerunning the warm hook. Existing workspaces from the selected generation remain the serving fallback until the new generation is ready. This restores the pool filesystem state but does not change the environment's currently saved w…
- [List Warm Pool Workspaces](https://docs.replicas.dev/api-reference/environments/list-warm-pool-workspaces.md): Returns the most recent pre-warmed workspaces for a warm pool config, including their status (warming, snapshotting, ready, assigned, expired, failed). Useful for inspecting why a pool is not delivering ready workspaces. Returns up to 10 entries. To watch warm-hook output live during the `warming` p…
- [Stream Warm Pool Workspace Updates](https://docs.replicas.dev/api-reference/environments/stream-warm-pool-workspace-updates.md): Server-Sent Events stream that delivers live warm-hook stdout/stderr plus status transitions for a single warm pool workspace. The monolith proxies output from the warming sandbox's engine; output is only available while the sandbox is running (i.e. `status` is `warming`). Once the workspace reaches…
- [Search Skill Catalog](https://docs.replicas.dev/api-reference/environments/search-skill-catalog.md): Searches the [skills.sh](https://skills.sh) catalog for skills that can be enabled on an environment via [POST /v1/environments/{environmentId}/skills](#tag/Environments/operation/createEnvironmentSkill).
- [Get Workspace Identity Discovery Document](https://docs.replicas.dev/api-reference/workspace-identity/get-workspace-identity-discovery-document.md): Public OpenID Connect discovery document for workspace identity tokens. Use `jwks_uri` to fetch signing keys and verify tokens offline. No authentication.
- [Get Workspace Identity Signing Keys](https://docs.replicas.dev/api-reference/workspace-identity/get-workspace-identity-signing-keys.md): Public RSA keys currently trusted to verify workspace identity tokens, including staged rotation keys. Match the token `kid` to a key. No authentication.
- [List Repositories](https://docs.replicas.dev/api-reference/repository/list-repositories.md): Returns a list of repositories available to your organization.
- [List Repository Branches](https://docs.replicas.dev/api-reference/repository/list-repository-branches.md): Returns up to 100 branches from a connected GitHub or GitLab repository. Use q to search provider-side without enumerating every branch.
- [List Repository Sets](https://docs.replicas.dev/api-reference/repository/list-repository-sets.md): Returns a list of repository sets available to your organization.
- [List Automations](https://docs.replicas.dev/api-reference/automation/list-automations.md): Returns a paginated list of automations for your organization.
- [Create Automation](https://docs.replicas.dev/api-reference/automation/create-automation.md): Creates a new automation in your organization. The automation uses a single environment, which supplies resolved env vars / MCPs / skills and an optional repository or repository set when it fires.
- [List Executions Across Automations](https://docs.replicas.dev/api-reference/automation/list-executions-across-automations.md): Returns a paginated list of execution history across organization automations and personal automations accessible to the authenticated user.
- [Get Automation](https://docs.replicas.dev/api-reference/automation/get-automation.md): Returns detailed information about a specific automation.
- [Delete Automation](https://docs.replicas.dev/api-reference/automation/delete-automation.md): Deletes an automation by its ID. This also deletes all associated execution history.
- [Update Automation](https://docs.replicas.dev/api-reference/automation/update-automation.md): Updates an existing automation. Only the fields provided in the request body will be updated.
- [Trigger Automation](https://docs.replicas.dev/api-reference/automation/trigger-automation.md): Manually triggers an automation. Automations with a cron trigger can be triggered directly; automations with a GitHub `pull_request.command` trigger can be triggered against a specific pull request by passing `pr`. This creates a new workspace and execution.
- [List Automation Executions](https://docs.replicas.dev/api-reference/automation/list-automation-executions.md): Returns a paginated list of execution history for an automation.
- [Retry Automation Execution](https://docs.replicas.dev/api-reference/automation/retry-automation-execution.md): Retries a failed execution. The failed execution's trigger payload is replayed as a new execution against the automation's current configuration, in a new workspace. The failed execution stays in the history.
- [Attach Slack Thread](https://docs.replicas.dev/api-reference/slack/attach-slack-thread.md): Routes a Slack thread to a workspace. Agent-mode requests can target only their authenticated workspace. A newer workspace can replace an archived destination; other destination changes require user or API-key authentication.

## OpenAPI Specs

- [openapi](/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.