---
seo:
  description: >-
    The Ibby AI platform's public API. Every call is authenticated with a lane's
    API key. JSON bodies, except file content.
sidebar:
  label: Overview
title: Ibby API
---
The Ibby AI platform's public API. Every call is authenticated with a lane's API key. JSON bodies, except file content.

Version 0.5.4

Base URL: `https://api.ibby.ai`

## Sandboxes

Isolated places to run code.

- [`DELETE /v1/sandboxes`](/api/sandboxes/remove-sandbox-by-name) — Remove a sandbox by name.
- [`POST /v1/sandboxes`](/api/sandboxes/create-sandbox) — Create a sandbox.
- [`DELETE /v1/sandboxes/{id}`](/api/sandboxes/remove-sandbox) — Stop and remove a sandbox.
- [`GET /v1/sandboxes/{id}`](/api/sandboxes/get-sandbox) — Get a sandbox's status.
- [`POST /v1/sandboxes/{id}/directories`](/api/sandboxes/make-directories) — Make directories.
- [`POST /v1/sandboxes/{id}/exec`](/api/sandboxes/exec-in-sandbox) — Run a command.
- [`GET /v1/sandboxes/{id}/files`](/api/sandboxes/read-file) — Read a file.
- [`PUT /v1/sandboxes/{id}/files`](/api/sandboxes/write-files) — Write files.
- [`GET /v1/sandboxes/{id}/files/list`](/api/sandboxes/list-files) — List a directory.

## Images

What a sandbox runs on: a recipe of a pinned base and hashed packages, built as a job.

- [`POST /v1/images`](/api/images/build-image) — Build an image.
- [`GET /v1/images/{id}`](/api/images/get-image) — Get an image.

## Jobs

Long work, started by another call and polled here.

- [`GET /v1/jobs/{id}`](/api/jobs/get-job) — Get a job's status and result.
- [`POST /v1/jobs/{id}/cancel`](/api/jobs/cancel-job) — Cancel a job.

## Usage

This lane's runs and their estimated cost.

- [`GET /v1/usage`](/api/usage/get-usage) — List this lane's runs and their estimated cost.