How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.2.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.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://api.tryreplicas.com
Authentication
HTTP Bearer, HTTP Bearer, API Key
Resource Areas
1

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
createReplica 1 param body → 201400401404409500503
GET
/v1/replica
List Replicas
listReplicas 5 params → 200400401500
GET
/v1/replica/{id}
Get Replica
getReplica 2 params → 200401404500502
DELETE
/v1/replica/{id}
Delete Replica
deleteReplica 1 param → 200401404500
POST
/v1/replica/{id}/messages
Send Message
sendReplicaMessage 1 param body → 200400401404409500502503
GET
/v1/replica/{id}/chats
List Chats
listReplicaChats 1 param → 200401404500
POST
/v1/replica/{id}/chats
Create Chat
createReplicaChat 1 param body → 201400401404500
DELETE
/v1/replica/{id}/chats/{chatId}
Delete Chat
deleteReplicaChat 2 params → 200401404500
GET
/v1/replica/{id}/chats/{chatId}/slash-commands
List Slash Commands
listReplicaSlashCommands 2 params → 200401404409500502
GET
/v1/replica/{id}/chats/{chatId}/queue
Get Chat Queue
getReplicaChatQueue 2 params → 200401404500
DELETE
/v1/replica/{id}/chats/{chatId}/queue
Clear Chat Queue
clearReplicaChatQueue 2 params → 200401404500
DELETE
/v1/replica/{id}/chats/{chatId}/queue/{messageId}
Remove Queued Message
removeReplicaChatQueueMessage 3 params → 200401404500
PATCH
/v1/replica/{id}/chats/{chatId}/queue/reorder
Reorder Chat Queue
reorderReplicaChatQueue 2 params body → 200400401404500
GET
/v1/replica/{id}/history
Read History
readReplicaHistory 4 params → 200400401404500502
GET
/v1/replica/{id}/hooks
Get Hook Logs
getReplicaHooks 1 param → 200401404500502
GET
/v1/replica/{id}/canvas
List Canvas Items
listReplicaCanvasItems 1 param → 200401404500502
GET
/v1/replica/{id}/canvas/{filename}
Get Canvas Item
getReplicaCanvasItem 2 params → 200401404500502
GET
/v1/replica/{id}/events
Stream Events
streamReplicaEvents 1 param → 200401404500502503
GET
/v1/workspaces/{workspaceId}/chats
List Workspace Chats
listWorkspaceChats 1 param → 200401404500
POST
/v1/workspaces/{workspaceId}/chats
Create Workspace Chat
createWorkspaceChat 1 param body → 201400401404409500
POST
/v1/workspaces/{workspaceId}/chats/{chatId}/messages
Send Workspace Chat Message
sendWorkspaceChatMessage 2 params body → 200202400401404409500
POST
/v1/workspaces/{workspaceId}/messages/deferred
Send Deferred Workspace Message
sendDeferredWorkspaceMessage 1 param body → 202400401404409500
POST
/v1/workspaces/{workspaceId}/archive
Archive Workspace
archiveWorkspace 1 param → 200400401404409500
POST
/v1/workspaces/{workspaceId}/sleep
Sleep Workspace
sleepWorkspace 1 param → 200400401404409500

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.

RepositoryStatus
object
Status of a repository within a replica
6 properties 6 required
ReplicaEnvironment
object
Environment configuration and status for a replica
8 properties 8 required
ReplicaWebhookConfig
object
2 properties 1 required
EngineRepoState
object
State of a repository within the engine
8 properties 7 required
EngineRepoDiff
object
Git diff statistics for a repository
3 properties 2 required
ListReplicasResponse
object
5 properties 5 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
ImageContent
object
An image attachment for messages
2 properties 2 required
CanvasItemKind
string
The kind of Canvas item, inferred from its file extension.
RepositoryReference
object
A repository reference in replica list items
3 properties 3 required
SlashCommandsResponse
object
Available slash commands for a chat
1 property 1 required
SlashCommand
object
A slash command available in a chat composer
4 properties 3 required
CanvasItem
object
An entry returned by listReplicaCanvasItems.
3 properties 3 required
SendWorkspaceChatMessageRequest
object
9 properties 1 required
SendWorkspaceChatMessageResponse
object
3 properties 3 required
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
HistoryEvent
object
A conversation history event
3 properties 3 required
CodexEventPayload
Payload of a Codex CLI agent event. Shape depends on the parent event type.
SleepWorkspaceResponse
object
1 property 1 required
ReplicaChat
object
A chat session within a replica
6 properties 6 required
ArchiveWorkspaceResponse
object
1 property 1 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
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
ReorderQueueRequest
object
Request to move a queued message to a new position.
2 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
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
CreateWorkspaceChatResponse
object
1 property 1 required
WorkspaceChatListResponse
object
2 properties 1 required
QueueMutationResponse
object
Result of a queue mutation.
2 properties 2 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
Error
object
2 properties 1 required
WorkspaceChat
object
8 properties 7 required
ClaudeEventPayload
object
Payload of a Claude Code agent event, wrapping the Claude SDK message.
6 properties
GitDiff
object
Git diff statistics
3 properties 3 required
SendDeferredWorkspaceMessageResponse
object
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
ClaudeMessage
object
A Claude SDK message containing an array of content blocks.
1 property
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
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
QueuedMessageInfo
object
A message waiting in a chat queue.
6 properties 3 required
SendDeferredWorkspaceMessageRequest
CodexEventMsgPayload
object
Payload for eventmsg events — high-level user or reasoning messages.
3 properties 1 required
EnginePreviewPort
object
A preview port forwarded from the replica
3 properties 3 required
GetReplicaResponse
object
1 property 1 required
SendReplicaMessageResponse
object
Response after sending a message to a replica
4 properties 4 required
PullRequest
object
A pull request associated with a replica
3 properties 3 required
SendReplicaMessageRequest
object
Request body for sending a message to a replica
11 properties 1 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…
ReplicaListItem
object
A replica item in list responses
8 properties 8 required
CodexResponseItemPayload
object
Payload for responseitem events — structured items from the Codex response stream.
ClaudeContentBlock
object
A single content block within a Claude message. Discriminated by type.
CanvasListResponse
object
List of items the agent has dropped into the Canvas.
1 property 1 required
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…
CreateReplicaRequest
object
Request body for creating a new replica
16 properties 2 required
CreateReplicaResponse
object
1 property 1 required
DeleteReplicaResponse
object
1 property 1 required
HooksResponse
object
Hook execution logs for a replica
2 properties 2 required
CreateChatRequest
object
Request body for creating a new chat
6 properties 1 required
ReplicaDetails
object
Detailed replica information including engine status and environment
ChatQueueResponse
object
Queued messages for a chat.
3 properties 3 required
EngineStatusSnapshot
object
A snapshot of the engine's current status
8 properties 7 required
ReadReplicaHistoryResponse
object
Response containing paginated conversation history
8 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

replicas-replica-api-openapi.yml Raw ↑

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
Where this information came from

This is an independent, third-party profile of Replicas Replica API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.