local-sandbox

Get local sandbox details

Changed on

Retrieves details about a local sandbox environment, including its status and all running servers.

get/local-sandbox/{local_sandbox_id}

Request

  • Base URL
    https://api.klavis.ai
  • Auth
    HTTP bearer

Path parameters

local_sandbox_idstring required

The ID of the local sandbox to retrieve

Response

Successful Response

local_sandbox_idstring required

Unique identifier for the local sandbox environment

created_atstring required

Timestamp when the sandbox was created

status'idle' | 'occupied' | 'error'

Status of a sandbox instance - matches database enum

benchmarkstring nullable

Benchmark environment configuration for the local sandbox

Changes

    • breaking

      response property servers/items/tags list-of-types was widened by adding types array to media type application/json of response 200

    • breaking

      the /// response's property type changed from object to array for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status