Skip to main content
    Ivy Biosciences logo
    Ivy Biosciences.bloom* docs
    login.bloom*
    Ivy Biosciences Docs/Call the platform/API/Reference/Reference/Sandbox/GET /v1/sandbox/{chatId}/status

    GET /v1/sandbox/{chatId}/status

    Get sandbox status — Returns the current state of your chat's sandbox. status is none when the chat has no sandbox.

    Open in Claude(opens in a new tab)Open in ChatGPT(opens in a new tab)1 min read
    Auth: required. Send an ivy_ API key (Authorization: Bearer ivy_… or X-Ivy-Api-Key), a Clerk session JWT (Authorization: Bearer …) or the Clerk __session cookie (browser sessions). See Authentication.

    Returns the current state of your chat's sandbox. status is none when the chat has no sandbox. While provisioning, phase and etaSeconds describe launch progress; poll about once per second or two.

    Request

    Path parameters

    chatIdstring

    ID of the chat that owns the sandbox

    Responses

    200 OK

    Current sandbox state

    Response shape:

    statusenum ("none" | "provisioning" | "active" | "failed")

    none when the chat has no sandbox, provisioning while starting, active when usable, failed otherwise

    phaseenum ("compute" | "mount" | "ready" | "failed")

    Launch phase of the sandbox

    etaSecondsinteger

    Estimated seconds until ready, when known

    errorMessagestring

    Failure reason; present only when status is failed

    createdAtstring (date-time)

    401 Unauthorized

    Authentication required

    Response shape: object

    403 Forbidden

    You do not own this chat, or your key's project scope excludes it

    Response shape: object

    429 Too Many Requests

    Rate limit exceeded

    Response shape: object

    curl -X GET 'https://ivybiosciences.com/api/v1/sandbox/{chatId}/status' \
  -H "Authorization: Bearer $IVY_API_KEY"

    Was this page helpful?

    GET /v1/sandbox/{chatId}/manifest

    Get the sandbox file manifest — Lists the files registered for your chat's sandbox: uploads, job outputs, tool outputs and sandbox exports, oldest first.

    POST /v1/sandbox/create

    Create a sandbox for a chat — Starts your chat's isolated code sandbox. You must own the chat, and campaignId must be that chat's campaign.

    Loading...