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

# Test Warm Hook

> Runs the supplied script in an isolated sandbox without persisting it. Useful for iterating on a warm hook from the API before committing it via `save-test`. Takes 30–90 seconds to return.



## OpenAPI

````yaml /openapi.json post /v1/environments/{environmentId}/warm-hooks/test
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: Preview
    description: Manage public preview URLs for workspace ports
  - name: Automation
    description: >-
      Create and manage automations that trigger replicas on a schedule or in
      response to events
paths:
  /v1/environments/{environmentId}/warm-hooks/test:
    post:
      tags:
        - Environments
      summary: Test Warm Hook
      description: >-
        Runs the supplied script in an isolated sandbox without persisting it.
        Useful for iterating on a warm hook from the API before committing it
        via `save-test`. Takes 30–90 seconds to return.
      operationId: testEnvironmentWarmHook
      parameters:
        - name: environmentId
          in: path
          required: true
          description: Environment UUID, or the literal string `global`.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestWarmHookRequest'
      responses:
        '200':
          description: Test executed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestWarmHookResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    TestWarmHookRequest:
      type: object
      properties:
        content:
          type: string
          description: Shell script to execute (not persisted)
      required:
        - content
    TestWarmHookResponse:
      type: object
      properties:
        test:
          $ref: '#/components/schemas/WarmHookTestResult'
      required:
        - test
    WarmHookTestResult:
      type: object
      description: Result of running a warm hook script in an isolated sandbox.
      properties:
        exit_code:
          type: integer
          description: Process exit code (0 = success)
        output:
          type: string
          description: Captured stdout + stderr
        timed_out:
          type: boolean
          description: Whether execution was killed for taking too long
      required:
        - exit_code
        - output
        - timed_out
    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 Settings > API Keys.

````