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

# Get an environment

> Returns a single environment by its ID.



## OpenAPI

````yaml /api-reference/openapi.documented.json get /v1/simulation/environment/{environmentId}
openapi: 3.1.0
info:
  title: Roark Analytics API
  description: >-
    The Roark Analytics API gives you access to the same API that powers the
    award winning Roark Analytics platform.
  version: 1.0.0
servers:
  - description: Production
    url: https://api.roark.ai
security:
  - Bearer: []
tags:
  - name: Health
    x-displayName: Health
  - name: Authentication
    x-displayName: Current credential
  - name: Project API Key
    x-displayName: Project API keys
  - name: Personal API Key
    x-displayName: Personal API keys
  - name: Agent
    x-displayName: Agents
  - name: Agent Endpoint
    x-displayName: Endpoints
  - name: Tool
    x-displayName: Tools
  - name: Agent Setup
    x-displayName: Automatic test setup
  - name: Autoimprove
    x-displayName: Autoimprove
  - name: Customer Flow
    x-displayName: Customer flows
  - name: Customer Flow Folder
    x-displayName: Customer flow folders
  - name: Simulation Persona
    x-displayName: Personas
  - name: Simulation Environment
    x-displayName: Environments
  - name: Simulation Template
    x-displayName: Templates
  - name: Simulation Run Plan
    x-displayName: Plans
  - name: Simulation Run
    x-displayName: Runs
  - name: Simulation Tool Mock
    x-displayName: Tool mocks and fixtures
  - name: Metric
    x-displayName: Definitions
  - name: Metric Variant
    x-displayName: Variants
  - name: Metric Policy
    x-displayName: Policies
  - name: Metric Collection Job
    x-displayName: Collection jobs
  - name: Call
    x-displayName: Calls
  - name: Chat
    x-displayName: Chats
  - name: Customer
    x-displayName: Customers
  - name: Issue
    x-displayName: Issues
  - name: Analytics
    x-displayName: Analytics
  - name: Dashboard
    x-displayName: Dashboards
  - name: Live Report
    x-displayName: Reports
  - name: Agent Connection
    x-displayName: Agent platforms
  - name: Calendar Connection
    x-displayName: Calendars
  - name: MCP Server Connection
    x-displayName: MCP servers
  - name: Knowledge Base
    x-displayName: Knowledge bases
  - name: HTTP Request Definition
    x-displayName: HTTP request definitions
  - name: Webhook
    x-displayName: Webhooks
  - name: Config
    x-displayName: Config as code
  - name: Organization Project
    x-displayName: Projects
  - name: Organization Project Member
    x-displayName: Project members
  - name: Usage
    x-displayName: Usage
  - name: Benchmark
    x-displayName: Benchmarks
paths:
  /v1/simulation/environment/{environmentId}:
    get:
      tags:
        - Simulation Environment
      summary: Get an environment
      description: Returns a single environment by its ID.
      operationId: getV1SimulationEnvironmentByEnvironmentId
      parameters:
        - in: path
          name: environmentId
          schema:
            type: string
            format: uuid
          required: true
      responses:
        '200':
          description: The requested environment
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/EnvironmentResponse'
                required:
                  - data
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Permission error
              example:
                type: forbidden
                code: permission_denied
                message: You do not have permission to access this resource
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Not found error
              example:
                type: not_found
                code: resource_not_found
                message: The requested resource could not be found
          description: Not Found
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Rate limit error
              example:
                type: rate_limit
                code: too_many_requests
                message: Rate limit exceeded
          description: Too Many Requests
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Server error
              example:
                type: internal
                code: internal_error
                message: Internal server error
          description: Internal Server Error
      x-codeSamples:
        - lang: JavaScript
          source: >-
            import Roark from '@roarkanalytics/sdk';


            const client = new Roark({
              bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
            });


            const response = await
            client.simulationEnvironment.getByID('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');


            console.log(response.data);
        - lang: Python
          source: |-
            import os
            from roark_analytics import Roark

            client = Roark(
                bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"),  # This is the default and can be omitted
            )
            response = client.simulation_environment.get_by_id(
                "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            )
            print(response.data)
components:
  schemas:
    EnvironmentResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          minLength: 1
        description:
          type:
            - string
            - 'null'
        backgroundNoise:
          type: string
          enum:
            - NONE
            - AIRPORT
            - CHILDREN_PLAYING
            - CITY
            - COFFEE_SHOP
            - CONSTRUCTION
            - CRYING_BABY
            - DRIVING
            - LIBRARY
            - OFFICE
            - THUNDERSTORM
            - TRAIN
          default: NONE
        backgroundNoiseVolume:
          type: number
          minimum: 0
          maximum: 1
          default: 0.1
        lineQuality:
          type: string
          enum:
            - CLEAR
            - MINOR_LOSS
            - CELL_EDGE
            - POOR_CONNECTION
            - ONE_WAY_DEGRADED
            - CUSTOM
          description: >-
            The phone line the simulated caller is on: packet loss applied to
            its 20 ms audio packets, per direction. The loss pattern is seeded
            per call, so a redial loses the same packets. CLEAR: No loss.
            MINOR_LOSS: 1% random, both ways. CELL_EDGE: 5% in 80 ms gaps, both
            ways. POOR_CONNECTION: 10% in 120 ms gaps, both ways.
            ONE_WAY_DEGRADED: 8% in 80 ms gaps, toward the agent only. CUSTOM:
            the per-direction loss in `lineCustom`, up to 20% in 0.5 steps, with
            a mean burst of up to 10 packets (omit it for random loss).
        lineCustom:
          oneOf:
            - $ref: '#/components/schemas/LineCustom'
            - type: 'null'
          description: The loss of a CUSTOM line; null on every other.
        createdAt:
          type: string
          description: Creation timestamp in ISO 8601 format
        updatedAt:
          type: string
          description: Last update timestamp in ISO 8601 format
      required:
        - id
        - name
        - backgroundNoise
        - backgroundNoiseVolume
        - lineQuality
        - lineCustom
        - createdAt
        - updatedAt
      description: >-
        A simulation environment: the ambient conditions a customer flow variant
        runs under. The list includes both your own and the ones Roark curates
        for every project.
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          enum:
            - validation
            - authentication
            - forbidden
            - not_found
            - conflict
            - payment_required
            - rate_limit
            - internal
          description: The error type category
          examples:
            - validation
            - authentication
        code:
          type: string
          description: Machine-readable error code identifier
          examples:
            - invalid_parameter
            - missing_required_field
            - unauthorized
        message:
          type: string
          description: Human-readable error message
          examples:
            - The request was invalid
            - Authentication required
        param:
          type: string
          description: The parameter that caused the error (if applicable)
          examples:
            - email
            - user_id
        details:
          description: Additional error context information
      required:
        - type
        - code
        - message
    LineCustom:
      type: object
      properties:
        toAgent:
          $ref: '#/components/schemas/LineImpairment'
          description: >-
            The caller's audio on its way to the agent: what the agent hears.
            Omit for no loss.
        fromAgent:
          $ref: '#/components/schemas/LineImpairment'
          description: >-
            The agent's audio on its way to the caller: what the caller hears.
            Omit for no loss.
      description: The per-direction loss of a CUSTOM line.
    LineImpairment:
      type: object
      properties:
        packetLossPercent:
          type: number
          multipleOf: 0.5
          minimum: 0
          maximum: 20
          description: Share of packets lost, 0 to 20 in steps of 0.5.
          example: 3
        meanBurstPackets:
          type: integer
          minimum: 2
          maximum: 10
          description: >-
            Mean length of a loss gap in 20 ms packets, 2 to 10. Omit for random
            loss.
          example: 3
      required:
        - packetLossPercent
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.