Replicas Environments API
Manage environments — the primitive that workspaces are created from. Variables, files, skills, MCPs, warm-hooks, and warm-pools are all scoped to an environment. Every organization has a singleton Global environment whose values apply to every workspace. Personal environments are scoped to the authenticated user and can be standalone or source-backed by a team environment.
Replicas Environments API is one of 13 APIs that Replicas publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Environments. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 36 operations across 25 paths, and defines 59 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.
Requests are made against a single base URL, https://api.tryreplicas.com.
36 operations
25 paths
59 schemas
6 DELETE13 GET4 PATCH12 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Replicas Environments API declares
3 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (apiKey).
It accepts HTTP bearer tokens (engineSecret).
An API key is passed in the header as X-Workspace-Id (workspaceId).
By default, every request must be authenticated.
apiKey— API key authentication. Obtain your API key from the Replicas dashboard under Organization → Settings → API Keys.engineSecret— Workspace engine secret used by agent-mode workspace requests.workspaceId— Workspace ID used with the engine secret for agent-mode workspace requests.
Paths & Operations 36
Across 25 paths, the API surfaces 36 operations — 6 DELETE, 13 GET, 4 PATCH, 12 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Environments 36
Manage environments — the primitive that workspaces are created from. Variables, files, skills, MCPs, warm-hooks, and warm-pools are all scoped to an environment. Every organizati…
GET
/v1/environments
List Environments
POST
/v1/environments
Create Environment
GET
/v1/environments/{id}
Get Environment
PATCH
/v1/environments/{id}
Update Environment
DELETE
/v1/environments/{id}
Delete Environment
GET
/v1/environments/{environmentId}/variables
List Environment Variables
POST
/v1/environments/{environmentId}/variables
Create Environment Variable
PATCH
/v1/environments/{environmentId}/variables/{id}
Update Environment Variable
DELETE
/v1/environments/{environmentId}/variables/{id}
Delete Environment Variable
GET
/v1/environments/{environmentId}/files
List Environment Files
POST
/v1/environments/{environmentId}/files
Create Environment File
PATCH
/v1/environments/{environmentId}/files/{id}
Update Environment File
DELETE
/v1/environments/{environmentId}/files/{id}
Delete Environment File
GET
/v1/environments/{environmentId}/skills
List Environment Skills
POST
/v1/environments/{environmentId}/skills
Enable Environment Skill
DELETE
/v1/environments/{environmentId}/skills/{id}
Disable Environment Skill
GET
/v1/environments/{environmentId}/skills-registries
List Skill Registries
POST
/v1/environments/{environmentId}/skills-registries
Add Skill Registry
DELETE
/v1/environments/{environmentId}/skills-registries/{skillsRegistryId}
Remove Skill Registry
GET
/v1/environments/{environmentId}/repo-skills
List Skills From Bound Repo
GET
/v1/environments/{environmentId}/mcps
List Environment MCPs
POST
/v1/environments/{environmentId}/mcps
Create Environment MCP
PATCH
/v1/environments/{environmentId}/mcps/{id}
Update Environment MCP
DELETE
/v1/environments/{environmentId}/mcps/{id}
Delete Environment MCP
GET
/v1/environments/{environmentId}/warm-hooks
Get Warm Hooks State
POST
/v1/environments/{environmentId}/warm-hooks/save
Save Warm Hook
POST
/v1/environments/{environmentId}/warm-hooks/save-test
Save and Test Warm Hook
POST
/v1/environments/{environmentId}/warm-hooks/test
Test Warm Hook
GET
/v1/environments/{environmentId}/start-hooks
Get Start Hook
POST
/v1/environments/{environmentId}/start-hooks/save
Save Start Hook
POST
/v1/environments/{environmentId}/start-hooks/test
Test Start Hook
POST
/v1/environments/{environmentId}/start-hooks/test/stream
Test Start Hook (Streaming)
PUT
/v1/environments/{environmentId}/warm-pools
Enable or Disable Warm Pool
GET
/v1/warm-pools/{configId}/workspaces
List Warm Pool Workspaces
GET
/v1/warm-pool-workspaces/{workspaceId}/stream
Stream Warm Pool Workspace Updates
GET
/v1/environment-skills/search
Search Skill Catalog
Schemas 59
The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are WarmPoolConfigWithStats (18 properties), Environment (18 properties), RepoSkill (10 properties), EnvironmentSkillsRegistry (9 properties). Each schema is shown below with its type and property counts.
UpdateEnvironmentFileRequest
object
Request body for updating an environment file. Only provided fields are changed.
3 properties
ListEnvironmentVariablesResponse
object
1 property
1 required
EnvironmentSkillResponse
object
1 property
1 required
CreateEnvironmentFileRequest
object
Request body for creating an environment file. Maximum content size is 64 KB (65,536 bytes).
3 properties
3 required
TestStartHookResponse
object
1 property
1 required
ListEnvironmentsResponse
object
1 property
1 required
CreateEnvironmentVariableRequest
object
Request body for creating an environment variable.
3 properties
2 required
WarmHookTestResult
object
Result of running a warm hook script in an isolated sandbox.
3 properties
3 required
EnvironmentSkillsRegistry
object
A GitHub repository registered as a skill registry on an environment.
9 properties
9 required
EnvironmentMcpHttpConfig
object
Configuration for an MCP reached over HTTP or SSE (transport: http or transport: sse).
2 properties
2 required
Error
object
2 properties
1 required
ListWarmPoolWorkspacesResponse
object
1 property
1 required
ListRepoSkillsResponse
object
2 properties
2 required
EnvironmentFileResponse
object
1 property
1 required
SaveAndTestWarmHookRequest
object
1 property
1 required
EnvironmentSkill
object
A skill enabled on an environment. The membership row, not the catalog entry.
8 properties
8 required
UpsertWarmPoolConfigRequest
object
1 property
1 required
CreateEnvironmentSkillsRegistryResponse
object
3 properties
3 required
GetWarmHooksResponse
object
2 properties
2 required
TestWarmHookResponse
object
1 property
1 required
ListEnvironmentMcpsResponse
object
1 property
1 required
UpdateEnvironmentMcpRequest
object
Request body for updating an MCP. Only provided fields are changed. When transport is changed, config is required and must match the new transport's shape.
3 properties
SaveAndTestWarmHookResponse
object
2 properties
2 required
UpsertWarmPoolConfigResponse
object
1 property
1 required
RepoSkillFramework
string
Which AI tool owns the discovered file's on-disk convention.
SaveStartHookRequest
object
1 property
1 required
ListEnvironmentFilesResponse
object
1 property
1 required
SearchEnvironmentSkillsResponse
object
1 property
1 required
EnvironmentFile
object
A file dropped into the workspace at the configured path when the workspace is provisioned.
8 properties
8 required
StartHookTestResult
object
Result of running a start hook script in an isolated sandbox.
3 properties
3 required
StartHookRecord
object
A start hook — the shell script that runs at workspace boot (after the warm sandbox is claimed) for an environment.
7 properties
7 required
ListEnvironmentSkillsRegistriesResponse
object
1 property
1 required
RepoSkill
object
A skill/agent/command/prompt file discovered inside the environment's bound repo. Distinct from EnvironmentSkill: these are inferred live from the repo's git t…
10 properties
10 required
SaveStartHookResponse
object
1 property
1 required
EnvironmentResponse
object
1 property
1 required
TestWarmHookRequest
object
1 property
1 required
SearchSkill
object
A skill catalog search result.
4 properties
4 required
WarmHookRecord
object
A warm hook — the shell script that runs while pre-warming workspaces for an environment.
7 properties
7 required
WarmPoolConfigWithStats
object
Warm pool configuration plus current pool counts.
18 properties
18 required
WarmPoolWorkspaceRecord
object
A single pre-warmed workspace within a warm pool.
8 properties
8 required
UpdateEnvironmentVariableRequest
object
Request body for updating an environment variable. Only provided fields are changed.
3 properties
ListEnvironmentSkillsResponse
object
1 property
1 required
SuccessResponse
object
Generic success response.
1 property
1 required
TestStartHookRequest
object
1 property
1 required
EnvironmentMcpStdioConfig
object
Configuration for an MCP that runs a local subprocess (transport: stdio).
3 properties
3 required
CreateEnvironmentMcpRequest
object
Request body for creating an MCP. The config shape must match the chosen transport.
3 properties
3 required
EnvironmentVariableResponse
object
1 property
1 required
Environment
object
An environment — the config bundle workspaces are created from. Holds an optional repository binding plus the runtime variables, files, skills, MCPs, and warm…
18 properties
14 required
EnvironmentSkillsRegistryWithContents
object
A skill registry with its discovered skills.
EnvironmentMcpConfig
MCP transport-specific configuration. Discriminate by the parent transport field.
UpdateEnvironmentRequest
object
Request body for updating an environment. Only provided fields are changed. repositoryid and repositorysetid remain mutually exclusive when both are supplied.
7 properties
GetStartHooksResponse
object
1 property
1 required
SaveWarmHookRequest
object
1 property
1 required
EnvironmentMcp
object
An MCP (Model Context Protocol) server attached to an environment.
8 properties
8 required
CreateEnvironmentRequest
object
Request body for creating a new environment.
8 properties
1 required
EnvironmentMcpResponse
object
1 property
1 required
EnvironmentVariable
object
An environment variable. Values are encrypted at rest and decrypted on read.
8 properties
8 required
CreateEnvironmentSkillRequest
object
Request body for enabling a skill on an environment.
3 properties
3 required
SaveWarmHookResponse
object
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Replicas 12
Other APIs Replicas publishes across the network.
Replicas Analytics API
Replicas API Keys API
Replicas Automation API
Replicas Credentials API
Replicas Downloads API
Replicas Google Search Console API
Replicas Preview API
Replicas Profile API
Replicas Replica API
Replicas Repository API
Replicas Slack API
Replicas Terminal API
#Environments