ascii-box-sdk

Box is now Boat. This package is the last release of the box SDK line. It keeps working against the frozen /api/box/v1 endpoints until their sunset (see the Sunset response header), but gets no new features. Migrate to the boat SDK: https://docs.boat.dev/migrating-from-box

Use Box from your application code.

Install

pip install ascii-box-sdk

Flow

Create an API key in the Box dashboard.
Create or resume a Box.
Prompt the Box.
Read events until the work is done.
Open desktop access when you need browser or GUI visibility.
Stop, resume, fork, or delete the Box according to your retention policy.

Notes

Put cleanup in finally: stop/archive or delete Boxes you create for tests.
Treat API key secrets, Box secrets, SSH keys, and desktop stream URLs as sensitive.
updateSecrets / update_secrets replaces the entire secret setup. Read the current setup first and send every env var and secret file that should remain.
rotateApiKey / rotate_api_key rotates the raw secret in place. Store the returned secret immediately; it is shown once.
Repository selection is idempotent. Selecting an already-selected repository updates its base branch.

Example

import os
import time

from ascii_box_sdk import ApiClient, Configuration
from ascii_box_sdk.api.box_api import BoxApi
from ascii_box_sdk.models.create_box_request import CreateBoxRequest
from ascii_box_sdk.models.prompt_request import PromptRequest
from ascii_box_sdk.models.update_box_request import UpdateBoxRequest

config = Configuration(
    host=os.getenv("BOX_BASE_URL", "https://ascii.dev/api/box/v1"),
    access_token=os.environ["BOX_API_KEY"],
)

box_id = None
with ApiClient(config) as client:
    box = BoxApi(client)

    try:
        created = box.create(CreateBoxRequest(ttl_seconds=1800))
        box_id = created.box.id

        box.update(box_id, UpdateBoxRequest(name="sdk-demo"))

        while box.get(box_id).box.state not in {"ready", "idle"}:
            time.sleep(2)

        box.prompt(
            box_id,
            PromptRequest(
                provider="codex",
                prompt="Inspect the repository and summarize the test command.",
            ),
        )

        events = box.events(box_id)
        print(events.events)
    finally:
        if box_id:
            box.stop(box_id)

License

This SDK is MIT licensed. Box, the Box API, the Box CLI, and the Box product are proprietary.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ascii_box_sdk-0.0.37.tar.gz (124.5 kB view details)

Uploaded Sep 16, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

ascii_box_sdk-0.0.37-py3-none-any.whl (267.8 kB view details)

Uploaded Sep 16, 2026 Python 3

File details

Details for the file ascii_box_sdk-0.0.37.tar.gz.

File metadata

Download URL: ascii_box_sdk-0.0.37.tar.gz
Upload date: Sep 16, 2026
Size: 124.5 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ascii_box_sdk-0.0.37.tar.gz
Algorithm	Hash digest
SHA256	`c16d52bca5feb35e411770e8355c81db24bad739bc8cc8c39468c5f294537574`
MD5	`f9535295c2d989bf64747ba056d62a47`
BLAKE2b-256	`3a7254be770b1d6f1b13949b5ee371f749e1263bd9148afd6560beea87b11a6d`

See more details on using hashes here.

Provenance

The following attestation bundles were made for ascii_box_sdk-0.0.37.tar.gz:

Publisher: release-box-sdks.yml on ariana-dot-dev/ariana-ide-private

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: ascii_box_sdk-0.0.37.tar.gz
- Subject digest: c16d52bca5feb35e411770e8355c81db24bad739bc8cc8c39468c5f294537574
- Sigstore transparency entry: 2865806072
- Sigstore integration time: Sep 16, 2026
Source repository:
- Permalink: ariana-dot-dev/ariana-ide-private@70b952f5f6410654838fb4186a490f8025f9a673
- Branch / Tag: refs/tags/box-sdk-v0.0.37
- Owner: https://github.com/ariana-dot-dev
- Access: private
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: self-hosted
- Publication workflow: release-box-sdks.yml@70b952f5f6410654838fb4186a490f8025f9a673
- Trigger Event: push