> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tryreplicas.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Replica

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



## OpenAPI

````yaml /openapi.json get /v1/replica/{id}
openapi: 3.1.0
info:
  title: Replica API
  version: 2.0.0
  description: >-
    The Replica API allows you to programmatically manage cloud workspaces for
    AI agents. Use this API to manage environments (the org-scoped primitive
    workspaces are created from — including variables, files, skills, MCPs, warm
    hooks, start hooks, and warm pools), create and manage replicas, send
    messages, manage chats, stream events, read connected repositories and
    repository sets, and configure automations.
servers:
  - url: https://api.tryreplicas.com
    description: Production API
security:
  - apiKey: []
tags:
  - name: Environments
    description: >-
      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.
  - name: Repository
    description: >-
      Read repositories and repository sets connected to your organization.
      Repositories are the underlying GitHub-connection layer; bind them to an
      environment to use them in workspaces.
  - name: Replica
    description: Manage replicas (workspaces) for AI agents
  - name: Terminal
    description: Manage interactive terminal sessions in active workspaces
  - name: Preview
    description: Manage public preview URLs for workspace ports
  - name: Profile
    description: Read and update the authenticated user's profile
  - name: Credentials
    description: >-
      Manage coding-agent credentials for an organization or the authenticated
      user
  - name: Google Search Console
    description: >-
      Read Search Console properties, performance, sitemaps, and URL inspection
      results through a connected Google account
  - name: Slack
    description: Route Slack threads to Replicas workspaces
  - name: Automation
    description: >-
      Create and manage automations that trigger replicas on a schedule or in
      response to events
  - name: Downloads
    description: Download Replicas applications
  - name: Analytics
    description: >-
      Read aggregated activity and usage metrics for your organization: compute
      minutes, workspaces created by source, and pull request throughput over a
      time range.
  - name: Presence
    description: >-
      Read and report ephemeral member presence: who is online, where they are
      (environment or workspace), and whether they are typing. Presence is
      backed by short-lived keys rather than the database and broadcast to other
      members over the events stream.
paths:
  /v1/replica/{id}:
    get:
      tags:
        - Replica
      summary: Get Replica
      description: >-
        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`.
      operationId: getReplica
      parameters:
        - name: id
          in: path
          description: The unique identifier of the replica
          required: true
          schema:
            type: string
            format: uuid
        - name: include
          in: query
          description: Comma-separated list of additional fields to include in the response
          required: false
          schema:
            type: string
            example: environment,diffs
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetReplicaResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '502':
          $ref: '#/components/responses/BadGateway'
components:
  schemas:
    GetReplicaResponse:
      type: object
      properties:
        replica:
          $ref: '#/components/schemas/ReplicaDetails'
      required:
        - replica
    ReplicaDetails:
      type: object
      description: Detailed replica information including engine status and environment
      allOf:
        - $ref: '#/components/schemas/ReplicaListItem'
        - type: object
          properties:
            coding_agent:
              type:
                - string
                - 'null'
              description: Currently active coding agent
              enum:
                - claude
                - codex
                - cursor
                - opencode
                - pi
                - null
            repository_statuses:
              type: array
              items:
                $ref: '#/components/schemas/RepositoryStatus'
              description: Status of each repository in the replica
            waking:
              type:
                - boolean
                - 'null'
              description: >-
                Whether the workspace was just woken from a sleeping or archived
                state. Retry in 30-90 seconds for full details.
            chats:
              type: array
              items:
                $ref: '#/components/schemas/ReplicaChat'
              description: Chat sessions in this replica
            environment:
              oneOf:
                - $ref: '#/components/schemas/ReplicaEnvironment'
                - type: 'null'
              description: >-
                Environment configuration. Only included when requested via
                include=environment.
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
        details:
          type:
            - string
            - 'null'
          description: Additional error details
      required:
        - error
    ReplicaListItem:
      type: object
      description: A replica item in list responses
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the replica
        name:
          type: string
          description: Human-readable name for the replica. Must not contain whitespace.
          pattern: ^\S+$
        status:
          type: string
          description: Current status of the replica
          enum:
            - active
            - sleeping
            - archived
            - preparing
            - error
        source:
          type: string
          description: How the replica was created
          enum:
            - api
            - dashboard
            - slack
            - linear
            - github
            - gitlab
            - automation
        created_at:
          type: string
          format: date-time
          description: Timestamp when the replica was created
        last_activity_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Timestamp of the last activity on the replica
        repositories:
          type: array
          items:
            $ref: '#/components/schemas/RepositoryReference'
          description: Repositories associated with the replica
        pull_requests:
          type: array
          items:
            $ref: '#/components/schemas/PullRequest'
          description: Associated pull requests
      required:
        - id
        - name
        - status
        - source
        - created_at
        - last_activity_at
        - repositories
        - pull_requests
    RepositoryStatus:
      type: object
      description: Status of a repository within a replica
      properties:
        repository:
          type: string
          description: Repository name
        branch:
          type: string
          description: Current git branch
        default_branch:
          type: string
          description: Default branch of the repository
        pr_urls:
          type: array
          items:
            type: string
            format: uri
          description: All pull request URLs the workspace has opened in this repository.
        start_hooks_completed:
          type: boolean
          description: Whether start hooks have finished executing
        git_diff:
          oneOf:
            - $ref: '#/components/schemas/GitDiff'
            - type: 'null'
          description: Git diff statistics, if available
      required:
        - repository
        - branch
        - default_branch
        - pr_urls
        - start_hooks_completed
        - git_diff
    ReplicaChat:
      type: object
      description: A chat session within a replica
      properties:
        id:
          type: string
          description: Unique identifier for the chat
        provider:
          type: string
          description: Coding agent provider for this chat
          enum:
            - claude
            - codex
            - cursor
            - opencode
            - pi
        title:
          type: string
          description: Chat title
        created_at:
          type: string
          format: date-time
          description: When the chat was created
        updated_at:
          type: string
          format: date-time
          description: When the chat was last updated
        processing:
          type: boolean
          description: >-
            Whether the chat is currently doing work — either processing a
            foreground message or running background/spawned-agent tasks
      required:
        - id
        - provider
        - title
        - created_at
        - updated_at
        - processing
    ReplicaEnvironment:
      type: object
      description: Environment configuration and status for a replica
      properties:
        engine_version:
          type: string
          description: Version of the replica engine
        files_uploaded:
          type: array
          items:
            type: string
          description: List of uploaded file names
        env_vars_set:
          type: array
          items:
            type: string
          description: List of environment variable names that are set
        skills_installed:
          type: array
          items:
            type: string
          description: List of installed skill names
        integrations:
          type: object
          properties:
            github:
              type: boolean
            gitlab:
              type: boolean
            linear:
              type: boolean
            slack:
              type: boolean
            google:
              type: boolean
          required:
            - github
            - gitlab
            - linear
            - slack
            - google
          description: Integration connection statuses
        coding_agents:
          type: object
          properties:
            claude:
              type: object
              properties:
                available:
                  type: boolean
                auth_method:
                  type: string
              required:
                - available
                - auth_method
            codex:
              type: object
              properties:
                available:
                  type: boolean
                auth_method:
                  type: string
              required:
                - available
                - auth_method
            opencode:
              type: object
              properties:
                available:
                  type: boolean
                auth_method:
                  type: string
              required:
                - available
                - auth_method
            pi:
              type: object
              properties:
                available:
                  type: boolean
                auth_method:
                  type: string
              required:
                - available
                - auth_method
            cursor:
              type: object
              properties:
                available:
                  type: boolean
                auth_method:
                  type: string
              required:
                - available
                - auth_method
          required:
            - claude
            - codex
            - cursor
            - opencode
            - pi
          description: Available coding agents and their authentication methods
        hooks:
          type: object
          properties:
            global_warm_hook:
              type: object
              properties:
                status:
                  type: string
                details:
                  type:
                    - string
                    - 'null'
              required:
                - status
                - details
            repositories:
              type: array
              items:
                type: object
                properties:
                  repository_name:
                    type: string
                  warm_hook:
                    type: string
                  start_hook:
                    type: string
                required:
                  - repository_name
                  - warm_hook
                  - start_hook
          required:
            - global_warm_hook
            - repositories
          description: Hook configuration and status
        last_updated_at:
          type: string
          format: date-time
          description: When the environment was last updated
      required:
        - engine_version
        - files_uploaded
        - env_vars_set
        - skills_installed
        - integrations
        - coding_agents
        - hooks
        - last_updated_at
    RepositoryReference:
      type: object
      description: A repository reference in replica list items
      properties:
        id:
          type: string
          format: uuid
          description: Repository ID
        name:
          type: string
          description: Repository name
        url:
          type: string
          format: uri
          description: Repository URL
      required:
        - id
        - name
        - url
    PullRequest:
      type: object
      description: A pull request associated with a replica
      properties:
        repository:
          type: string
          description: Repository name
        number:
          type: integer
          description: Pull request number
        url:
          type: string
          format: uri
          description: URL to the pull request
      required:
        - repository
        - number
        - url
    GitDiff:
      type: object
      description: Git diff statistics
      properties:
        added:
          type: integer
          description: Number of lines added
        removed:
          type: integer
          description: Number of lines removed
        full_diff:
          type: string
          description: Full diff content
      required:
        - added
        - removed
        - full_diff
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadGateway:
      description: >-
        Bad gateway - The workspace is unreachable or returned an invalid
        response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        API key authentication. Obtain your API key from the Replicas dashboard
        under Organization → Settings → API Keys.

````