Replicas Replica API
Manage replicas (workspaces) for AI agents
Replicas Replica API is one of 13 APIs that Replicas publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Replica. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 24 operations across 19 paths, and defines 63 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.
24 operations
19 paths
63 schemas
4 DELETE11 GET1 PATCH8 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Replicas Replica 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 24
Across 19 paths, the API surfaces 24 operations — 4 DELETE, 11 GET, 1 PATCH, 8 POST. Each is listed below with its method, path, parameters, and response codes.
Replica 24
Manage replicas (workspaces) for AI agents
POST
/v1/replica
Create Replica
GET
/v1/replica
List Replicas
GET
/v1/replica/{id}
Get Replica
DELETE
/v1/replica/{id}
Delete Replica
POST
/v1/replica/{id}/messages
Send Message
GET
/v1/replica/{id}/chats
List Chats
POST
/v1/replica/{id}/chats
Create Chat
DELETE
/v1/replica/{id}/chats/{chatId}
Delete Chat
GET
/v1/replica/{id}/chats/{chatId}/slash-commands
List Slash Commands
GET
/v1/replica/{id}/chats/{chatId}/queue
Get Chat Queue
DELETE
/v1/replica/{id}/chats/{chatId}/queue
Clear Chat Queue
DELETE
/v1/replica/{id}/chats/{chatId}/queue/{messageId}
Remove Queued Message
PATCH
/v1/replica/{id}/chats/{chatId}/queue/reorder
Reorder Chat Queue
GET
/v1/replica/{id}/history
Read History
GET
/v1/replica/{id}/hooks
Get Hook Logs
GET
/v1/replica/{id}/canvas
List Canvas Items
GET
/v1/replica/{id}/canvas/{filename}
Get Canvas Item
GET
/v1/replica/{id}/events
Stream Events
GET
/v1/workspaces/{workspaceId}/chats
List Workspace Chats
POST
/v1/workspaces/{workspaceId}/chats
Create Workspace Chat
POST
/v1/workspaces/{workspaceId}/chats/{chatId}/messages
Send Workspace Chat Message
POST
/v1/workspaces/{workspaceId}/messages/deferred
Send Deferred Workspace Message
POST
/v1/workspaces/{workspaceId}/archive
Archive Workspace
POST
/v1/workspaces/{workspaceId}/sleep
Sleep Workspace
Schemas 63
The contract defines 63 schemas that model the data the API accepts and returns. The most detailed are CreateReplicaRequest (16 properties), SendReplicaMessageRequest (11 properties), StartHookLogEntry (10 properties), WarmHookLogEntry (9 properties). Each schema is shown below with its type and property counts.
HooksResponse
object
Hook execution logs for a replica
2 properties
2 required
CanvasItemKind
string
The kind of Canvas item, inferred from its file extension.
ClaudeAgentEvent
object
A streaming event from the Claude Code agent. The type field is prefixed with claude- followed by the SDK message type.
3 properties
3 required
EngineChatSummary
object
Summary of a chat session as reported by the engine
9 properties
7 required
WorkspaceConfig
object
Workspace behavior configuration. Missing capabilities and preferences default to disabled.
3 properties
EngineRepoDiff
object
Git diff statistics for a repository
3 properties
2 required
QueuedMessageInfo
object
A message waiting in a chat queue.
6 properties
3 required
CanvasListResponse
object
List of items the agent has dropped into the Canvas.
1 property
1 required
ImageContent
object
An image attachment for messages
2 properties
2 required
Error
object
2 properties
1 required
CodexAgentEvent
object
A streaming event from the Codex CLI agent. Uses either eventmsg for high-level messages or responseitem for structured response items.
3 properties
3 required
CreateReplicaRequest
object
Request body for creating a new replica
16 properties
2 required
OpencodeAgentEvent
object
A streaming event from the Opencode agent. Opencode events are normalized with an opencode- prefixed type and an open provider payload.
3 properties
3 required
ClaudeMessage
object
A Claude SDK message containing an array of content blocks.
1 property
ListReplicasResponse
object
5 properties
5 required
ReplicaListItem
object
A replica item in list responses
8 properties
8 required
CursorAgentEvent
object
A streaming event from the Cursor agent. Cursor events are normalized with a cursor- prefixed type and a provider payload.
3 properties
3 required
CodexEventPayload
Payload of a Codex CLI agent event. Shape depends on the parent event type.
ClaudeEventPayload
object
Payload of a Claude Code agent event, wrapping the Claude SDK message.
6 properties
EngineEvent
object
A real-time event from the replica engine. All events share a common envelope with id, ts, type, and payload fields. The type field discriminates between event…
PullRequest
object
A pull request associated with a replica
3 properties
3 required
RepositoryReference
object
A repository reference in replica list items
3 properties
3 required
SleepWorkspaceResponse
object
1 property
1 required
WorkspaceChatListResponse
object
2 properties
1 required
CreateChatRequest
object
Request body for creating a new chat
6 properties
1 required
CreateReplicaResponse
object
1 property
1 required
ChatMessageSender
object
Records who sent a user message in a chat. Server-recorded from the authenticated user at send time.
3 properties
3 required
GitDiff
object
Git diff statistics
3 properties
3 required
CodexResponseItemPayload
object
Payload for responseitem events — structured items from the Codex response stream.
RepositoryStatus
object
Status of a repository within a replica
6 properties
6 required
SendReplicaMessageResponse
object
Response after sending a message to a replica
4 properties
4 required
CanvasContentResponse
object
A single Canvas item's content. Text kinds populate content; binary kinds populate base64. Items over the 5 MB per-file cap return tooLarge: true with neither…
7 properties
4 required
GetReplicaResponse
object
1 property
1 required
SendReplicaMessageRequest
object
Request body for sending a message to a replica
11 properties
1 required
SendDeferredWorkspaceMessageResponse
object
3 properties
3 required
SendDeferredWorkspaceMessageRequest
ChatQueueResponse
object
Queued messages for a chat.
3 properties
3 required
WarmHookLogEntry
object
A warm hook execution log entry. Note: fields use camelCase as they are passed through from the engine.
9 properties
9 required
SendWorkspaceChatMessageResponse
object
3 properties
3 required
ReplicaWebhookConfig
object
2 properties
1 required
ReplicaDetails
object
Detailed replica information including engine status and environment
EnginePreviewPort
object
A preview port forwarded from the replica
3 properties
3 required
ReadReplicaHistoryResponse
object
Response containing paginated conversation history
8 properties
4 required
EngineRepoState
object
State of a repository within the engine
8 properties
7 required
SendWorkspaceChatMessageRequest
object
9 properties
1 required
CanvasItem
object
An entry returned by listReplicaCanvasItems.
3 properties
3 required
StartHookLogEntry
object
A start hook execution log entry. Note: fields use camelCase as they are passed through from the engine.
10 properties
10 required
WorkspaceChat
object
8 properties
7 required
SlashCommand
object
A slash command available in a chat composer
4 properties
3 required
ReplicaEnvironment
object
Environment configuration and status for a replica
8 properties
8 required
CreateWorkspaceChatResponse
object
1 property
1 required
PiAgentEvent
object
A streaming event from the Pi coding agent. Pi events expose session lifecycle, text and reasoning updates, tool execution, and errors.
3 properties
3 required
ReorderQueueRequest
object
Request to move a queued message to a new position.
2 properties
2 required
CodexEventMsgPayload
object
Payload for eventmsg events — high-level user or reasoning messages.
3 properties
1 required
EngineStatusSnapshot
object
A snapshot of the engine's current status
8 properties
7 required
ClaudeContentBlock
object
A single content block within a Claude message. Discriminated by type.
ArchiveWorkspaceResponse
object
1 property
1 required
HistoryEvent
object
A conversation history event
3 properties
3 required
ReplicaChat
object
A chat session within a replica
6 properties
6 required
AgentEvent
A raw event from the coding agent, streamed as part of chat.turn.delta events. The shape depends on the coding agent provider. Use the type field to discrimina…
QueueMutationResponse
object
Result of a queue mutation.
2 properties
2 required
SlashCommandsResponse
object
Available slash commands for a chat
1 property
1 required
DeleteReplicaResponse
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 Environments API
Replicas Google Search Console API
Replicas Preview API
Replicas Profile API
Replicas Repository API
Replicas Slack API
Replicas Terminal API
#Replica