# Replicas Docs

## Docs

- [Audit Log](https://docs.tryreplicas.com/admin/audit-log.md): Track configuration changes across your organization.
- [Billing](https://docs.tryreplicas.com/admin/billing.md): Understand how Replicas billing works across plans, seats, and API usage.
- [Workspace History](https://docs.tryreplicas.com/admin/chat-transcripts.md): How chat and Canvas history is stored and how to turn it off.
- [Credentials](https://docs.tryreplicas.com/admin/credentials.md): Configure coding agents and integrations.
- [Defaults](https://docs.tryreplicas.com/admin/defaults.md): Org-wide defaults for agents, models, and workspaces.
- [Team](https://docs.tryreplicas.com/admin/team.md): Invite members and manage roles.
- [Create Personal API Key](https://docs.tryreplicas.com/api-reference/api-keys/create-personal-api-key.md): Creates a personal API key scoped to the authenticated user. Requires JWT authentication.
- [Delete Personal API Key](https://docs.tryreplicas.com/api-reference/api-keys/delete-personal-api-key.md): Deletes a personal API key owned by the authenticated user.
- [List Personal API Keys](https://docs.tryreplicas.com/api-reference/api-keys/list-personal-api-keys.md): Returns a paginated list of personal API keys for the authenticated user.
- [Create Automation](https://docs.tryreplicas.com/api-reference/automation/create-automation.md): Creates a new automation in your organization. The automation is bound to a single environment, which determines the repository (or repository set) and resolved env vars / MCPs / skills used when the automation fires.
- [Delete Automation](https://docs.tryreplicas.com/api-reference/automation/delete-automation.md): Deletes an automation by its ID. This also deletes all associated execution history.
- [Fire a Custom Webhook Automation](https://docs.tryreplicas.com/api-reference/automation/fire-a-custom-webhook-automation.md): Fires an automation that has a `custom` webhook trigger. The token in the URL is the secret: any caller that knows the URL can fire the automation, so this endpoint is unauthenticated by design (no API key). The request body is parsed as JSON and embedded into the automation's prompt under `## Trigg…
- [Get Automation](https://docs.tryreplicas.com/api-reference/automation/get-automation.md): Returns detailed information about a specific automation.
- [List Automation Executions](https://docs.tryreplicas.com/api-reference/automation/list-automation-executions.md): Returns a paginated list of execution history for an automation.
- [List Automations](https://docs.tryreplicas.com/api-reference/automation/list-automations.md): Returns a paginated list of automations for your organization.
- [Trigger Automation](https://docs.tryreplicas.com/api-reference/automation/trigger-automation.md): Manually triggers an automation. Only automations with a cron trigger can be manually triggered. This creates a new workspace and execution.
- [Update Automation](https://docs.tryreplicas.com/api-reference/automation/update-automation.md): Updates an existing automation. Only the fields provided in the request body will be updated.
- [Add Skill Registry](https://docs.tryreplicas.com/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.
- [Create Environment](https://docs.tryreplicas.com/api-reference/environments/create-environment.md): Creates a new environment. `repository_id` and `repository_set_id` are mutually exclusive; both may be omitted for an unbound environment that can back repo-less workspaces.
- [Create Environment File](https://docs.tryreplicas.com/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 `~/`).
- [Create Environment MCP](https://docs.tryreplicas.com/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 }`.
- [Create Environment Variable](https://docs.tryreplicas.com/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.
- [Delete Environment](https://docs.tryreplicas.com/api-reference/environments/delete-environment.md): Deletes an environment. Returns 409 when an automation still references the environment, or when called against the Global environment (which cannot be deleted).
- [Delete Environment File](https://docs.tryreplicas.com/api-reference/environments/delete-environment-file.md)
- [Delete Environment MCP](https://docs.tryreplicas.com/api-reference/environments/delete-environment-mcp.md)
- [Delete Environment Variable](https://docs.tryreplicas.com/api-reference/environments/delete-environment-variable.md)
- [Disable Environment Skill](https://docs.tryreplicas.com/api-reference/environments/disable-environment-skill.md): Disables a previously enabled skill on the environment.
- [Enable Environment Skill](https://docs.tryreplicas.com/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.
- [Enable or Disable Warm Pool](https://docs.tryreplicas.com/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.
- [Get Environment](https://docs.tryreplicas.com/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).
- [Get Start Hook](https://docs.tryreplicas.com/api-reference/environments/get-start-hook.md): Returns the active start hook (if any) for the environment. Start hooks run at workspace boot, after the warm sandbox is claimed; the env-level hook runs before any repository-level start hooks defined in `replicas.json` / `replicas.yaml`.
- [Get Warm Hooks State](https://docs.tryreplicas.com/api-reference/environments/get-warm-hooks-state.md): Returns the active warm hook (if any) and warm pool config (if any) for the environment, along with current pool counts.
- [List Environment Files](https://docs.tryreplicas.com/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.
- [List Environment MCPs](https://docs.tryreplicas.com/api-reference/environments/list-environment-mcps.md): Returns every MCP (Model Context Protocol server) attached to the environment.
- [List Environment Skills](https://docs.tryreplicas.com/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.
- [List Environment Variables](https://docs.tryreplicas.com/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).
- [List Environments](https://docs.tryreplicas.com/api-reference/environments/list-environments.md): Returns every environment in your organization, including the singleton Global environment. Each record includes counts of attached variables, files, skills, and MCPs.
- [List Skill Registries](https://docs.tryreplicas.com/api-reference/environments/list-skill-registries.md): Returns every skill registry configured on the environment, along with the discovered skills from each registry repository.
- [List Skills From Bound Repo](https://docs.tryreplicas.com/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 Warm Pool Workspaces](https://docs.tryreplicas.com/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…
- [Remove Skill Registry](https://docs.tryreplicas.com/api-reference/environments/remove-skill-registry.md): Removes a skill registry from the environment.
- [Save and Test Warm Hook](https://docs.tryreplicas.com/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. Always persists the new version; the response includes the test result so callers can decide whether to roll back. The endpoint takes 30–90 seconds to return because it spins up a real sandbox.
- [Save Start Hook](https://docs.tryreplicas.com/api-reference/environments/save-start-hook.md): Persists and activates the supplied script as the start hook for the environment. Editing a start hook does not invalidate the warm pool — the new content is picked up automatically on the next claim, since start hooks run at workspace boot rather than during warming.
- [Save Warm Hook](https://docs.tryreplicas.com/api-reference/environments/save-warm-hook.md): Persists and activates the supplied script as the warm hook for the environment without running a test. Use this when you want to save quickly without waiting for a sandbox to spin up.
- [Search Skill Catalog](https://docs.tryreplicas.com/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).
- [Stream Warm Pool Workspace Updates](https://docs.tryreplicas.com/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…
- [Test Start Hook](https://docs.tryreplicas.com/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 once the hook finishes. Useful for short-lived clients (CLI, scripts) that prefer a single response over an SSE stream. Takes 30–90 seconds to return.
- [Test Start Hook (Streaming)](https://docs.tryreplicas.com/api-reference/environments/test-start-hook-streaming.md): Provisions an isolated sandbox, runs the supplied start hook script, and streams output back as Server-Sent Events. Use this instead of a synchronous test endpoint to avoid gateway timeouts on long-running hooks. Events emitted: `progress` (status messages), `output` (captured stdout/stderr), `compl…
- [Test Warm Hook](https://docs.tryreplicas.com/api-reference/environments/test-warm-hook.md): Runs the supplied script in an isolated sandbox without persisting it. Useful for iterating on a warm hook from the API before committing it via `save-test`. Takes 30–90 seconds to return.
- [Update Environment](https://docs.tryreplicas.com/api-reference/environments/update-environment.md): Updates a non-global environment. Only provided fields are changed. `PATCH /v1/environments/global` returns 400 with a pointer to the nested resource endpoints (variables, files, skills, MCPs, warm hooks) — the Global env's metadata cannot be edited directly. Returns 409 when an automation still ref…
- [Update Environment File](https://docs.tryreplicas.com/api-reference/environments/update-environment-file.md)
- [Update Environment MCP](https://docs.tryreplicas.com/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.
- [Update Environment Variable](https://docs.tryreplicas.com/api-reference/environments/update-environment-variable.md): Updates a variable. Only provided fields are changed.
- [Delete Preview](https://docs.tryreplicas.com/api-reference/preview/delete-preview.md): Unregisters a preview port for the authenticated workspace. This endpoint is intended for agent mode and requires the workspace ID header plus the workspace engine secret as a bearer token.
- [Delete Workspace Preview](https://docs.tryreplicas.com/api-reference/preview/delete-workspace-preview.md): Unregisters a preview port for a workspace in the authenticated organization.
- [Clear Chat Queue](https://docs.tryreplicas.com/api-reference/replica/clear-chat-queue.md): Removes all queued messages from a chat. The currently processing message is not interrupted.
- [Create Chat](https://docs.tryreplicas.com/api-reference/replica/create-chat.md): Creates a new chat session for a replica.
- [Create Replica](https://docs.tryreplicas.com/api-reference/replica/create-replica.md): Creates a new replica in your organization and sends an initial message to the coding agent. The workspace and agent are initialized asynchronously.
- [Delete Chat](https://docs.tryreplicas.com/api-reference/replica/delete-chat.md): Deletes a chat session from a replica.
- [Delete Replica](https://docs.tryreplicas.com/api-reference/replica/delete-replica.md): Deletes a replica by its ID. This terminates the underlying sandbox and processes any outstanding billing.
- [Get Canvas Item](https://docs.tryreplicas.com/api-reference/replica/get-canvas-item.md): Reads a single Canvas item by filename. Text kinds (`markdown`, `html`) return UTF-8 text in `content`. Binary kinds (`image`, `video`, `audio`, `other`) return base64 in `base64`. Items over the 5 MB per-file cap return `tooLarge: true` with neither payload; callers should reach for `replicas media…
- [Get Chat Queue](https://docs.tryreplicas.com/api-reference/replica/get-chat-queue.md): Returns queued messages for a chat. The currently processing message is not included.
- [Get Hook Logs](https://docs.tryreplicas.com/api-reference/replica/get-hook-logs.md): Returns the warm hook and start hook execution logs for a replica.
- [Get Replica](https://docs.tryreplicas.com/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`.
- [List Canvas Items](https://docs.tryreplicas.com/api-reference/replica/list-canvas-items.md): Lists the items in the replica's Canvas (files agents drop into `~/.replicas/canvas/`). Each item has a `kind` (markdown, html, image, video, audio, or other) inferred from its extension and a `sizeBytes` measured at list time. Files larger than 5 MB are still listed; the `getReplicaCanvasItem` endp…
- [List Chats](https://docs.tryreplicas.com/api-reference/replica/list-chats.md): Returns a list of chats for a replica.
- [List Replicas](https://docs.tryreplicas.com/api-reference/replica/list-replicas.md): Returns a paginated list of all replicas in your organization. Supports filtering by user, source, and status.
- [Read History](https://docs.tryreplicas.com/api-reference/replica/read-history.md): Reads the conversation history for a replica with pagination from the end (bottom-up). Optionally filter by chat ID. If the workspace is sleeping, it will be woken and the response will indicate this with `waking: true`. Retry in 30-90 seconds when waking.
- [Remove Queued Message](https://docs.tryreplicas.com/api-reference/replica/remove-queued-message.md): Removes one queued message from a chat.
- [Reorder Chat Queue](https://docs.tryreplicas.com/api-reference/replica/reorder-chat-queue.md): Moves a queued message to a new zero-based position.
- [Send Message](https://docs.tryreplicas.com/api-reference/replica/send-message.md): Sends a message to an existing replica. Supports targeting a specific chat, choosing a coding agent and model, attaching images, and enabling plan mode.
- [Stream Events](https://docs.tryreplicas.com/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.
- [List Repositories](https://docs.tryreplicas.com/api-reference/repository/list-repositories.md): Returns a list of repositories available to your organization.
- [List Repository Sets](https://docs.tryreplicas.com/api-reference/repository/list-repository-sets.md): Returns a list of repository sets available to your organization.
- [Changelog](https://docs.tryreplicas.com/changelog.md): Product updates and announcements
- [Replica API](https://docs.tryreplicas.com/features/api.md): Programmatically create and manage replicas.
- [Automations](https://docs.tryreplicas.com/features/automations.md): Run agents on a schedule or in response to GitHub, Slack, Sentry, or custom webhook events.
- [CLI](https://docs.tryreplicas.com/features/cli.md): Connect to workspaces from your terminal.
- [Cursor](https://docs.tryreplicas.com/features/coding-agents/cursor.md): Run Cursor Composer agents in Replicas workspaces.
- [Opencode](https://docs.tryreplicas.com/features/coding-agents/opencode.md): Run OpenRouter-backed Opencode agents in Replicas workspaces.
- [Doppler](https://docs.tryreplicas.com/features/doppler.md): Sync environment variables from Doppler into workspaces.
- [Environments](https://docs.tryreplicas.com/features/environments.md): Configure variables, files, skills, MCPs, start hooks, and warm hooks for your workspaces.
- [Google Workspace](https://docs.tryreplicas.com/features/gdrive.md): Let Replicas create and edit Google Docs, Sheets, and Forms on your org's behalf.
- [GitHub](https://docs.tryreplicas.com/features/github.md): Trigger tasks from GitHub issues and iterate on pull requests with Replicas.
- [GitLab](https://docs.tryreplicas.com/features/gitlab.md): Trigger tasks from GitLab issues and iterate on merge requests with Replicas.
- [Infisical](https://docs.tryreplicas.com/features/infisical.md): Sync environment variables from Infisical into workspaces.
- [Linear](https://docs.tryreplicas.com/features/linear.md): Assign tasks to Replicas directly from Linear.
- [MCP](https://docs.tryreplicas.com/features/mcp.md): Use Replicas from Claude Desktop, Poke, and other MCP clients.
- [Sentry](https://docs.tryreplicas.com/features/sentry.md): Fire automations from Sentry issue alerts and new errors.
- [Slack](https://docs.tryreplicas.com/features/slack.md): Trigger tasks by mentioning @Replicas in Slack channels, or by messaging the bot directly.
- [Canvas](https://docs.tryreplicas.com/features/workspaces/canvas.md): Files agents drop into the workspace for you to view in the dashboard.
- [Fast Mode](https://docs.tryreplicas.com/features/workspaces/fast-mode.md): Speed up agent responses with a faster service tier.
- [Overview](https://docs.tryreplicas.com/features/workspaces/overview.md): How workspaces run and manage themselves.
- [Plan Mode](https://docs.tryreplicas.com/features/workspaces/plan-mode.md): Ask agents to propose a plan before they change code.
- [Repository Config](https://docs.tryreplicas.com/features/workspaces/repository-configuration.md): Configure environment setup on workspaces.
- [Welcome](https://docs.tryreplicas.com/index.md)
- [Quickstart](https://docs.tryreplicas.com/quickstart.md): Set up Replicas and create your first workspace in 5 minutes.

## OpenAPI Specs

- [openapi](https://docs.tryreplicas.com/openapi.json)