> ## 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 Warm Hooks State > 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 history. ## OpenAPI ````yaml /openapi.json get /v1/environments/{environmentId}/warm-hooks 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. `/v1/replica` endpoints accept API keys and workspace engine-secret authentication; user-session JWTs are not accepted. - 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: Connect Slack identities and route threads to Replicas workspaces - name: Linear description: Connect Linear identities to Replicas accounts - 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: Media description: >- Read workspace media and obtain short-lived download or inline preview URLs - 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/environments/{environmentId}/warm-hooks: get: tags: - Environments summary: Get Warm Hooks State description: >- 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 history. operationId: getEnvironmentWarmHooks parameters: - name: environmentId in: path required: true description: Environment UUID, or the literal string `global`. schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetWarmHooksResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalServerError' components: schemas: GetWarmHooksResponse: type: object properties: warm_hook: oneOf: - $ref: '#/components/schemas/WarmHookRecord' - type: 'null' description: >- The active warm hook for the environment (null if none has ever been saved). warm_pool: oneOf: - $ref: '#/components/schemas/WarmPoolConfigWithStats' - type: 'null' description: >- The warm pool config and current counts (null if no pool has been configured). snapshots: type: array description: Up to 20 retained snapshots ordered newest first. items: $ref: '#/components/schemas/WarmPoolSnapshotRecord' required: - warm_hook - warm_pool - snapshots WarmHookRecord: type: object description: >- A warm hook — the shell script that runs while pre-warming workspaces for an environment. properties: id: type: string format: uuid organization_id: type: string format: uuid environment_id: type: string format: uuid version: type: integer description: Monotonic version (newer scripts have higher versions) content: type: string description: Shell script content is_active: type: boolean description: Whether this version is the active one for the environment created_at: type: string format: date-time required: - id - organization_id - environment_id - version - content - is_active - created_at WarmPoolConfigWithStats: type: object description: Warm pool configuration plus current pool counts. properties: id: type: string format: uuid organization_id: type: string format: uuid environment_id: type: string format: uuid enabled: type: boolean target_size: type: integer description: Target number of pre-warmed workspaces (platform-controlled) generation: type: integer description: >- Monotonic counter bumped on every invalidation. Workspaces and snapshots carry the generation they were built for; anything older is stale by derivation. error_count: type: integer description: >- Consecutive reconcile failures since the last success. Resets to 0 on success; drives exponential backoff via `next_retry_at`. next_retry_at: type: - string - 'null' format: date-time description: >- Earliest time the next reconcile pass may run for this config. Null when not in backoff. last_error_at: type: - string - 'null' format: date-time description: >- When the most recent reconcile error was recorded (null if no current error). last_error_message: type: - string - 'null' description: Most recent reconcile error message (null if no current error). has_base_snapshot: type: boolean description: >- True when a base snapshot is installed for the current generation. For snapshot-capable providers (E2B), distinguishes the initial seed-build phase (false + warming > 0) from the clone-refill phase (true + warming > 0). Always false on providers without live snapshots. updated_at: type: string format: date-time ready_count: type: integer description: >- Number of pre-warmed workspaces at the current generation that are ready to be assigned stale_count: type: integer description: >- Number of ready workspaces at older generations. Still claimable as a fallback; trimmed by reconcile when over target. warming_count: type: integer description: >- Number of workspaces at the current generation that are currently warming (warm hooks running) snapshotting_count: type: integer description: >- Number of seed workspaces currently capturing a base snapshot (E2B only). Always 0 on providers without live snapshots. last_failure_at: type: - string - 'null' format: date-time description: When the most recent warm-up failure occurred (null if never) last_failure_reason: type: - string - 'null' description: Reason for the most recent warm-up failure required: - id - organization_id - environment_id - enabled - target_size - generation - error_count - next_retry_at - last_error_at - last_error_message - has_base_snapshot - updated_at - ready_count - stale_count - warming_count - snapshotting_count - last_failure_at - last_failure_reason WarmPoolSnapshotRecord: type: object description: A retained provider snapshot for one successful warm-pool generation. properties: id: type: string format: uuid description: Snapshot record UUID used by the restore endpoint warm_pool_config_id: type: string format: uuid generation: type: integer description: Warm-pool generation that captured this snapshot is_current: type: boolean description: >- Whether the config is currently installed on this snapshot. Restoring an older version moves this flag back onto that version. is_fallback: type: boolean description: >- Whether this snapshot is serving while the current generation warms or recovers created_at: type: string format: date-time required: - id - warm_pool_config_id - generation - is_current - is_fallback - created_at Error: type: object properties: error: type: string description: Error message details: type: - string - 'null' description: Additional error details required: - error responses: BadRequest: description: Bad request - Missing or invalid parameters content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: Unauthorized - Invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/Error' InternalServerError: description: Internal server error 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. User-session JWTs are not accepted by `/v1/replica` endpoints. ````