# 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.
- [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.
- [Static Egress IP](https://docs.replicas.dev/features/static-egress-ip.md): Send a workspace's Internet traffic 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.
- [DeepSeek Harness](https://docs.replicas.dev/features/coding-agents/deepseek.md): Run OpenRouter-backed DeepSeek Harness agents in Replicas workspaces.
- [fx](https://docs.replicas.dev/features/coding-agents/fx.md): Run fx agents through Vercel AI Gateway in Replicas workspaces.
- [Kimi Code](https://docs.replicas.dev/features/coding-agents/kimi-code.md): Run Kimi Code through Vercel AI Gateway in Replicas workspaces.
- [Muse Code](https://docs.replicas.dev/features/coding-agents/muse-code.md): Run Muse Code with your Muse subscription 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.
- [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): Use Replicas from an iPhone through TestFlight.
- [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.
- [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): Understand how Replicas billing works across plans, seats, and minutes.
- [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): Product updates and announcements
- [Submit a YC founder deal claim](https://docs.replicas.dev/api-reference/yc-deal/submit-a-yc-founder-deal-claim.md): Emails a YC deal claim to the Replicas founders. The verification URL must use HTTPS, have no credentials or custom port, and match `ycombinator.com/verify/{code}`. Requests are limited to five per IP address and three per email address or verification link per hour.
- [Get the caller's organization membership](https://docs.replicas.dev/api-reference/organization-roles/get-the-callers-organization-membership.md): Returns the caller's role and the organization-wide scopes their grants add up to.
- [Get the organization access policy](https://docs.replicas.dev/api-reference/organization-roles/get-the-organization-access-policy.md): Returns every grant held by All members and by each custom role. Requires an organization admin.
- [Replace the grants held by a subject](https://docs.replicas.dev/api-reference/organization-roles/replace-the-grants-held-by-a-subject.md): Replaces every grant for All members or one custom role. A member receives the union of the All members grants and every role assigned to them; admins always have full access. Requires an organization admin.
- [List organization roles](https://docs.replicas.dev/api-reference/organization-roles/list-organization-roles.md): Returns the organization's custom roles and their member counts.
- [Create an organization role](https://docs.replicas.dev/api-reference/organization-roles/create-an-organization-role.md): Creates a custom role. Requires an organization admin.
- [Delete an organization role](https://docs.replicas.dev/api-reference/organization-roles/delete-an-organization-role.md): Deletes an unassigned custom role and its environment permissions. Requires an organization admin and returns 409 while members are assigned.
- [Set a member's custom roles](https://docs.replicas.dev/api-reference/organization-roles/set-a-members-custom-roles.md): Replaces a member's custom role assignments. Permissions from multiple roles combine. Admins cannot receive custom roles. Requires an organization admin.
- [Resend an organization invitation](https://docs.replicas.dev/api-reference/organization-invitations/resend-an-organization-invitation.md): Rotates the token for a pending invitation and sends a new email. Requires an organization admin. Resends are limited to one per 60 seconds and five per hour for the same organization and recipient.
- [Get organization preferences](https://docs.replicas.dev/api-reference/preferences/get-organization-preferences.md)
- [Update organization preferences](https://docs.replicas.dev/api-reference/preferences/update-organization-preferences.md): Updates the provided organization preferences. Requires an organization admin.
- [Get personal preferences](https://docs.replicas.dev/api-reference/preferences/get-personal-preferences.md)
- [Update personal preferences](https://docs.replicas.dev/api-reference/preferences/update-personal-preferences.md): Merges the supplied fields into the caller's preferences. Fallback chains merge per harness, so sending one harness leaves the others untouched.
- [List Plugin Connections](https://docs.replicas.dev/api-reference/plugins/list-plugin-connections.md): Returns the plugin catalog together with the Global environment's connections and the authenticated user's legacy personal connections. Use the environment-scoped list to read another environment.
- [Start Organization Plugin Install](https://docs.replicas.dev/api-reference/plugins/start-organization-plugin-install.md): Creates a hosted authorization URL, using a Composio Connect Link or the plugin's native OAuth flow, that installs the plugin for the whole organization. Requires an organization admin. Returns 400 when the plugin uses a Replicas credential form, and 409 when the plugin is already installed for the…
- [Start Personal Plugin Install](https://docs.replicas.dev/api-reference/plugins/start-personal-plugin-install.md): Creates a browser-bound hosted authorization URL, using a Composio Connect Link or the plugin's native OAuth flow, that installs the plugin for the authenticated user only. A personal connection takes precedence over every environment connection inside a workspace, including Global.
- [Connect Organization Credential Plugin](https://docs.replicas.dev/api-reference/plugins/connect-organization-credential-plugin.md): Connects a non-OAuth plugin for the whole organization. Requires an organization admin. Supported for PostHog, ClickHouse, Cloudflare, Vercel, Modal, turbopuffer, Pangram, and E2B. Vanta is environment-only and returns 400 from this endpoint.
- [Connect Personal Credential Plugin](https://docs.replicas.dev/api-reference/plugins/connect-personal-credential-plugin.md): Connects a non-OAuth plugin for the authenticated user. Supported for PostHog, ClickHouse, Cloudflare, Vercel, Modal, turbopuffer, Pangram, and E2B. Vanta is environment-only and returns 400 from this endpoint.
- [Uninstall Organization Plugin](https://docs.replicas.dev/api-reference/plugins/uninstall-organization-plugin.md): Revokes the organization's managed provider authorization when applicable, removes native credentials when used, and deletes the stored connection. Requires an organization admin. Returns 502 when a managed provider authorization could not be revoked, leaving the connection in place so the request c…
- [Uninstall Personal Plugin](https://docs.replicas.dev/api-reference/plugins/uninstall-personal-plugin.md): Revokes the authenticated user's managed provider authorization when applicable, removes native credentials when used, and deletes their personal connection. Returns 502 when a managed provider authorization could not be revoked, leaving the connection in place so the request can be retried.
- [List Environment Plugin Connections](https://docs.replicas.dev/api-reference/plugins/list-environment-plugin-connections.md): Returns the plugin catalog together with the plugin connections installed on this environment and the caller's personal installations. Only installations owned directly by the environment are listed; installations inherited from a parent environment are resolved at workspace runtime, not here.
- [Start Environment Plugin Install](https://docs.replicas.dev/api-reference/plugins/start-environment-plugin-install.md): Creates a hosted authorization URL, using a Composio Connect Link or the plugin's native OAuth flow, that installs the plugin on this environment. Installing on a shared environment requires an organization admin. Returns 400 when the plugin uses a Replicas credential form, and 409 when the plugin i…
- [Connect Environment Credential Plugin](https://docs.replicas.dev/api-reference/plugins/connect-environment-credential-plugin.md): Connects a non-OAuth plugin on this environment. Installing on a shared environment requires an organization admin. Supported for PostHog, ClickHouse, Cloudflare, Vercel, Modal, turbopuffer, Pangram, E2B, and Vanta. Vanta accepts a Manage API client ID and secret authorized for vanta-api.all:read an…
- [Uninstall Environment Plugin](https://docs.replicas.dev/api-reference/plugins/uninstall-environment-plugin.md): Revokes the environment's managed provider authorization when applicable, removes native credentials when used, and deletes the stored connection. Uninstalling from a shared environment requires an organization admin. Returns 502 when a managed provider authorization could not be revoked, leaving th…
- [Get Default Agent](https://docs.replicas.dev/api-reference/replica/get-default-agent.md): Resolves the authenticated user's saved harness and a compatible model after applying organization defaults and credential availability.
- [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 Workspaces](https://docs.replicas.dev/api-reference/replica/list-workspaces.md): Returns paginated workspaces with repository associations and pull request states.
- [Create Dashboard Workspace](https://docs.replicas.dev/api-reference/replica/create-dashboard-workspace.md): Creates a workspace from an environment for the authenticated dashboard user. `repository_branches` can override the starting branch for repositories in that environment; repositories without an override use their configured default branch.
- [Get Workspace](https://docs.replicas.dev/api-reference/replica/get-workspace.md): Returns a workspace visible to the authenticated user. If the workspace belongs to another organization the user belongs to, select the returned organization and retry the request.
- [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 or archived, it will be woken and the response will indicate this with `waking: true`.
- [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. 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, DeepSeek Harness, Muse, Opencode, and Pi commands.
- [Get Chat Queue](https://docs.replicas.dev/api-reference/replica/get-chat-queue.md): Returns queued messages for a chat. The currently processing message is not included.
- [Clear Chat Queue](https://docs.replicas.dev/api-reference/replica/clear-chat-queue.md): Removes all queued messages from a chat. The currently processing message is not interrupted.
- [Remove Queued Message](https://docs.replicas.dev/api-reference/replica/remove-queued-message.md): Removes one queued message from a chat.
- [Edit Queued Message](https://docs.replicas.dev/api-reference/replica/edit-queued-message.md): Updates the text of a message that is still waiting in a chat queue.
- [Reorder Chat Queue](https://docs.replicas.dev/api-reference/replica/reorder-chat-queue.md): Moves a queued message to a new zero-based position.
- [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.
- [List Canvas Items](https://docs.replicas.dev/api-reference/replica/list-canvas-items.md): Lists the items in the replica's Canvas (files agents drop into `~/.replicas/canvas/`), including files in nested folders. Each item has a `kind` (markdown, mermaid, html, text, image, pdf, video, audio, or other) inferred from its extension and a `sizeBytes` measured at list time. Files larger than…
- [Get Canvas Item](https://docs.replicas.dev/api-reference/replica/get-canvas-item.md): Reads a single Canvas item by its Canvas-relative path, including nested paths. Text kinds (`markdown`, `mermaid`, `html`, `text`) return UTF-8 text in `content`. Binary kinds (`image`, `pdf`, `video`, `audio`, `other`) return base64 in `base64`. Items over the 5 MB preview cap return `tooLarge: tru…
- [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.
- [List Workspace Chats](https://docs.replicas.dev/api-reference/replica/list-workspace-chats.md): Lists active, sleeping, and pending chats. Chats created while the workspace is preparing remain visible while startup completes.
- [Create Workspace Chat](https://docs.replicas.dev/api-reference/replica/create-workspace-chat.md): Creates a chat immediately. For preparing or sleeping workspaces, the chat stays visible and is created in the engine after startup completes. Archived and error workspaces return 409.
- [Upload Workspace Canvas Item](https://docs.replicas.dev/api-reference/replica/upload-workspace-canvas-item.md): Uploads a file to the workspace Canvas. Active workspaces return 200 after writing the file. Preparing, sleeping, and archived workspaces return 202 and queue the upload until startup completes; uploading alone does not wake the workspace. Pass the returned uploadId in the related chat message's can…
- [Update Canvas Item](https://docs.replicas.dev/api-reference/replica/update-canvas-item.md): Saves an editable text Canvas item when its revision still matches. If the item changed after it was read, returns its current content and revision without overwriting it.
- [Get Repository File](https://docs.replicas.dev/api-reference/replica/get-repository-file.md): Reads a repository file for preview or editing. Editable text files include a revision to pass as expectedRevision when saving.
- [Update Repository File](https://docs.replicas.dev/api-reference/replica/update-repository-file.md): Saves an editable repository text file when its revision still matches. If the file changed after it was read, returns its current content and revision without overwriting it.
- [Inspect Repository Symbol](https://docs.replicas.dev/api-reference/replica/inspect-repository-symbol.md): Returns hover information, definitions, or references for a symbol in an active workspace. Uses the repository language server when available and falls back to workspace symbol search.
- [Fork Workspace Chat](https://docs.replicas.dev/api-reference/replica/fork-workspace-chat.md): Continues an existing chat on another coding agent harness in the same workspace. The source chat is left unchanged. Returns as soon as the forked chat exists, with `fork.state` set to `preparing`. The sanitized transcript handoff and the first turn run in the background, after which `fork.state` be…
- [Send Workspace Chat Message](https://docs.replicas.dev/api-reference/replica/send-workspace-chat-message.md): Accepts a message immediately. Messages sent while a workspace is preparing, sleeping, or archived are queued server-side and delivered in order after startup completes. Archived workspaces wake automatically; error workspaces return 409.
- [List Workspace Mobile Testing Instances](https://docs.replicas.dev/api-reference/replica/list-workspace-mobile-testing-instances.md): Lists active iOS simulators and Android emulators associated with the workspace. Stream URLs and tokens are short-lived credentials scoped to the authenticated organization and requested workspace.
- [Get Workspace Pull Request Details](https://docs.replicas.dev/api-reference/replica/get-workspace-pull-request-details.md): Returns enriched details for pull requests tracked by a workspace, including CI status, whether the code host will currently accept a merge, whether the requesting user can approve, and nullable GitHub stack metadata. Each entry carries either details or an error explaining why enrichment failed.
- [Merge Workspace Pull Request](https://docs.replicas.dev/api-reference/replica/merge-workspace-pull-request.md): Squash-merges a linked standalone GitHub pull request through the GitHub integration. The pull request must be open and mergeable, and the organization must allow agent pull request merges. This endpoint remains available while the workspace is sleeping and does not wake it.
- [Update Workspace Pull Request](https://docs.replicas.dev/api-reference/replica/update-workspace-pull-request.md): Approves an open GitHub pull request in a workspace repository, or closes or changes the draft state of a linked open pull request. Approval uses the requesting user's connected GitHub account, does not require the stored workspace link to match, and revalidates that the user has write access and di…
- [Send Deferred Workspace Message](https://docs.replicas.dev/api-reference/replica/send-deferred-workspace-message.md): Creates or selects a chat, queues a message, and wakes a preparing, sleeping, or archived workspace. The queued message remains available while startup completes. Error workspaces return 409.
- [Archive Workspace](https://docs.replicas.dev/api-reference/replica/archive-workspace.md): Archives a workspace in the authenticated organization. Archived workspaces stay paused and can be woken later.
- [Sleep Workspace](https://docs.replicas.dev/api-reference/replica/sleep-workspace.md): Forces an active workspace in the authenticated organization to sleep, stopping compute charges. Slept workspaces can be woken later. A no-op for already-sleeping or archived workspaces; returns 409 for preparing or error workspaces.
- [Get Organization Presence](https://docs.replicas.dev/api-reference/presence/get-organization-presence.md): Returns the current presence of members active in your organization. Presence is ephemeral (backed by short-lived keys, not the database): each entry reports a member's `status`, the `location` they are viewing (environment and/or workspace), and the timestamp of their last update. A member is consi…
- [Update Presence](https://docs.replicas.dev/api-reference/presence/update-presence.md): Reports the authenticated user's presence: their `status` (`online` or `typing`) and optionally the `location` they are viewing. The user is always taken from the authenticated session, so callers cannot report presence on behalf of anyone else. Updates only broadcast to other members when the statu…
- [Get organization OpenAI API key status](https://docs.replicas.dev/api-reference/credentials/get-organization-openai-api-key-status.md)
- [Set organization OpenAI API key](https://docs.replicas.dev/api-reference/credentials/set-organization-openai-api-key.md)
- [Delete organization OpenAI API key](https://docs.replicas.dev/api-reference/credentials/delete-organization-openai-api-key.md)
- [Get personal OpenAI API key status](https://docs.replicas.dev/api-reference/credentials/get-personal-openai-api-key-status.md)
- [Set personal OpenAI API key](https://docs.replicas.dev/api-reference/credentials/set-personal-openai-api-key.md)
- [Delete personal OpenAI API key](https://docs.replicas.dev/api-reference/credentials/delete-personal-openai-api-key.md)
- [Get organization OpenAI-compatible credential status](https://docs.replicas.dev/api-reference/credentials/get-organization-openai-compatible-credential-status.md)
- [Set organization OpenAI-compatible credentials](https://docs.replicas.dev/api-reference/credentials/set-organization-openai-compatible-credentials.md)
- [Delete organization OpenAI-compatible credentials](https://docs.replicas.dev/api-reference/credentials/delete-organization-openai-compatible-credentials.md)
- [Get personal OpenAI-compatible credential status](https://docs.replicas.dev/api-reference/credentials/get-personal-openai-compatible-credential-status.md)
- [Set personal OpenAI-compatible credentials](https://docs.replicas.dev/api-reference/credentials/set-personal-openai-compatible-credentials.md)
- [Delete personal OpenAI-compatible credentials](https://docs.replicas.dev/api-reference/credentials/delete-personal-openai-compatible-credentials.md)
- [Get organization OpenCode Go credential status](https://docs.replicas.dev/api-reference/credentials/get-organization-opencode-go-credential-status.md)
- [Set the organization OpenCode Go API key](https://docs.replicas.dev/api-reference/credentials/set-the-organization-opencode-go-api-key.md)
- [Delete the organization OpenCode Go API key](https://docs.replicas.dev/api-reference/credentials/delete-the-organization-opencode-go-api-key.md)
- [Get personal OpenCode Go credential status](https://docs.replicas.dev/api-reference/credentials/get-personal-opencode-go-credential-status.md)
- [Set the authenticated user's OpenCode Go API key](https://docs.replicas.dev/api-reference/credentials/set-the-authenticated-users-opencode-go-api-key.md)
- [Delete the authenticated user's OpenCode Go API key](https://docs.replicas.dev/api-reference/credentials/delete-the-authenticated-users-opencode-go-api-key.md)
- [Get organization Aster credential status](https://docs.replicas.dev/api-reference/credentials/get-organization-aster-credential-status.md)
- [Set the organization Aster API key](https://docs.replicas.dev/api-reference/credentials/set-the-organization-aster-api-key.md)
- [Delete the organization Aster API key](https://docs.replicas.dev/api-reference/credentials/delete-the-organization-aster-api-key.md)
- [Get personal Aster credential status](https://docs.replicas.dev/api-reference/credentials/get-personal-aster-credential-status.md)
- [Set the authenticated user's Aster API key](https://docs.replicas.dev/api-reference/credentials/set-the-authenticated-users-aster-api-key.md)
- [Delete the authenticated user's Aster API key](https://docs.replicas.dev/api-reference/credentials/delete-the-authenticated-users-aster-api-key.md)
- [Connect a GitLab service account](https://docs.replicas.dev/api-reference/credentials/connect-a-gitlab-service-account.md): Validates and stores a GitLab service account personal access token for organization-owned repository operations. Requires an organization admin and a token with the `api` scope.
- [List models available to Codex](https://docs.replicas.dev/api-reference/agents/list-models-available-to-codex.md): Returns the configured OpenAI-compatible model catalog, or Replicas' static Codex catalog when another authentication method is active.
- [Verify an OpenAI-compatible model catalog](https://docs.replicas.dev/api-reference/agents/verify-an-openai-compatible-model-catalog.md): Fetches and validates the models endpoint without saving the supplied credential. The upstream response must contain a data array with an id or model on each available entry; cursor pagination may use has_more and next_cursor.
- [List models available to Pi](https://docs.replicas.dev/api-reference/agents/list-models-available-to-pi.md)
- [List OpenRouter models enabled for the organization](https://docs.replicas.dev/api-reference/agents/list-openrouter-models-enabled-for-the-organization.md): Returns the models an organization admin enabled for DeepSeek Harness, Opencode, and Pi, ordered by weekly popularity. Models outside this list are rejected when requested for a workspace, automation, or message.
- [List Vercel AI Gateway models available to fx and Kimi Code](https://docs.replicas.dev/api-reference/agents/list-vercel-ai-gateway-models-available-to-fx-and-kimi-code.md)
- [Download Replicas for macOS](https://docs.replicas.dev/api-reference/downloads/download-replicas-for-macos.md): Redirects to a short-lived download URL for the latest signed and notarized macOS DMG.
- [Download Replicas for Linux](https://docs.replicas.dev/api-reference/downloads/download-replicas-for-linux.md): Redirects to a short-lived download URL for the latest Linux AppImage or Debian package.
- [Check for a Replicas macOS update](https://docs.replicas.dev/api-reference/downloads/check-for-a-replicas-macos-update.md): Returns the latest signed macOS update when it is newer than the installed version.
- [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.
- [Get Analytics Overview](https://docs.replicas.dev/api-reference/analytics/get-analytics-overview.md): Returns an aggregated overview of organization activity for admins and members holding `analytics:read`: a per-bucket time series of pull requests opened, merged, and closed; compute-minute usage bucketed and broken down by workspace source; workspace counts grouped by source; inference usage ranked…
- [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…
- [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).
- [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.
- [Report Automation GitHub Check](https://docs.replicas.dev/api-reference/automation/report-automation-github-check.md): Reports an automation run's verdict on one of the GitHub check runs it owns. Requires in-workspace credentials (engine secret plus `X-Workspace-Id`): the calling workspace identifies the run that owns the check, so a check run ID is not a capability to write to any check in the organization. Replica…
- [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.
- [Fire a Custom Webhook Automation](https://docs.replicas.dev/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 Personal Slack Connection](https://docs.replicas.dev/api-reference/slack/get-personal-slack-connection.md): Returns the authenticated user's Slack identity connection for the selected organization.
- [Disconnect Personal Slack Account](https://docs.replicas.dev/api-reference/slack/disconnect-personal-slack-account.md): Removes the authenticated user's Slack identity connection from the selected organization.
- [Start Personal Slack OAuth](https://docs.replicas.dev/api-reference/slack/start-personal-slack-oauth.md): Creates a browser-bound Slack authorization URL for the authenticated user.
- [Spawn a workspace from Mothership](https://docs.replicas.dev/api-reference/slack/spawn-a-workspace-from-mothership.md): Creates a dedicated workspace for a triaged Slack thread. Replicas verifies that the required user_id authored message_ts before using that identity for workspace and pull request attribution. Available only to the organization's Mothership agent.
- [Get monitored mothership channels](https://docs.replicas.dev/api-reference/slack/get-monitored-mothership-channels.md): Lists the Slack channels the mothership triages, with each channel's custom instructions. Requires the mothership feature flag.
- [Update monitored mothership channels](https://docs.replicas.dev/api-reference/slack/update-monitored-mothership-channels.md): Replaces the set of Slack channels the mothership triages and their custom instructions. Organization admins only, and requires the mothership feature flag.
- [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; use user or API-key authentication to switch a thread to another workspace.
- [Get Personal Linear Connection](https://docs.replicas.dev/api-reference/linear/get-personal-linear-connection.md): Returns the authenticated user's Linear identity connection for the selected organization.
- [Disconnect Personal Linear Account](https://docs.replicas.dev/api-reference/linear/disconnect-personal-linear-account.md): Removes the authenticated user's Linear identity connection from the selected organization.
- [Start Personal Linear OAuth](https://docs.replicas.dev/api-reference/linear/start-personal-linear-oauth.md): Creates a browser-bound Linear authorization URL for the authenticated user.
- [Delete Preview](https://docs.replicas.dev/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.replicas.dev/api-reference/preview/delete-workspace-preview.md): Unregisters a preview port for a workspace in the authenticated organization.
- [Create Workspace SSH Token](https://docs.replicas.dev/api-reference/tunnels/create-workspace-ssh-token.md): Creates short-lived SSH credentials and transport details for an active workspace. This first-party endpoint requires a logged-in user JWT and the `Replicas-Org-Id` header.
- [List Terminal Sessions](https://docs.replicas.dev/api-reference/terminal/list-terminal-sessions.md): Lists terminal sessions for an active workspace. Older workspaces whose engine predates terminal support return 404.
- [Create Terminal Session](https://docs.replicas.dev/api-reference/terminal/create-terminal-session.md): Creates a terminal session in an active workspace, up to eight simultaneous sessions.
- [Write Terminal Input](https://docs.replicas.dev/api-reference/terminal/write-terminal-input.md): Writes input to a running terminal session.
- [Resize Terminal Session](https://docs.replicas.dev/api-reference/terminal/resize-terminal-session.md): Resizes a running terminal session.
- [Delete Terminal Session](https://docs.replicas.dev/api-reference/terminal/delete-terminal-session.md): Stops and deletes a terminal session.
- [Stream Terminal Output](https://docs.replicas.dev/api-reference/terminal/stream-terminal-output.md): Streams terminal output and replay data as server-sent events.
- [Get User Profile](https://docs.replicas.dev/api-reference/profile/get-user-profile.md): Returns the authenticated user's display name, email, and profile photo.
- [Update User Profile](https://docs.replicas.dev/api-reference/profile/update-user-profile.md): Updates the authenticated user's display name and profile photo. Profile photos are uploaded to the configured S3 object store.
- [Get Account Deletion Request](https://docs.replicas.dev/api-reference/profile/get-account-deletion-request.md): Returns the authenticated user's pending account deletion request, or null when none is pending.
- [Request Account Deletion](https://docs.replicas.dev/api-reference/profile/request-account-deletion.md): Requests permanent deletion of the authenticated user's account and associated personal data. The request is idempotent: when a request is already pending it is returned with status 200 instead of creating a second one.
- [Cancel Account Deletion](https://docs.replicas.dev/api-reference/profile/cancel-account-deletion.md): Cancels the authenticated user's pending account deletion request. The operation is idempotent when no request is pending.
- [List Personal API Keys](https://docs.replicas.dev/api-reference/api-keys/list-personal-api-keys.md): Returns a paginated list of personal API keys for the authenticated user.
- [Create Personal API Key](https://docs.replicas.dev/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.replicas.dev/api-reference/api-keys/delete-personal-api-key.md): Deletes a personal API key owned by the authenticated user.

## OpenAPI Specs

- [openapi](/openapi.json)