Documentation Index
Fetch the complete documentation index at: https://docs.boxcrew.ai/llms.txt
Use this file to discover all available pages before exploring further.
bx agents
Manage your agents.
List agents
Returns a table of all agents with name, runtime, model, and status.
Create an agent
bx agents create <name> [options]
| Option | Description | Default |
|---|
-r, --runtime <runtime> | Agent runtime | claude-code |
-m, --model <model> | Model override | Runtime default |
-i, --instructions <text> | Agent instructions | None |
claude-code, opencode, openclaw
Examples:
# Create a Claude Code agent
bx agents create my-agent
# Create an OpenCode agent with a specific model
bx agents create research-bot --runtime opencode --model gpt-4o
# Create an agent with instructions
bx agents create code-reviewer --instructions "Review code for security issues"
Delete an agent
Permanently deletes the agent and its VM.
Chat with an agent
bx agents chat <name> <message>
bx agents chat my-agent "What files are in the current directory?"
bx keys
Manage API keys.
List keys
Returns a table of all API keys with name, key prefix, creation date, and last used date.
Create a key
| Option | Description |
|---|
-n, --name <name> | Human-readable name for the key |
-e, --expires <date> | Expiration date (ISO 8601 format) |
# Create a named key
bx keys create --name "CI/CD Pipeline"
# Create a key with expiration
bx keys create --name "Temp Key" --expires "2026-12-31T00:00:00Z"
The full key (starting with bxk_) is shown only once on creation. Store it securely.
Revoke a key
Permanently revokes the key. Use bx keys list to find the key ID.
bx api
Make raw API requests, similar to gh api.
bx api [options] <method> <path>
| Option | Description |
|---|
-d, --data <json> | JSON request body |
-H, --header <header...> | Additional headers (key:value) |
# List agents
bx api GET /agents
# Create an agent
bx api POST /agents -d '{"name":"test-agent","runtime":"claude-code"}'
# Get billing info
bx api GET /billing
# Delete an agent
bx api DELETE /agents/my-agent
# Check install status
bx api GET /agents/my-agent/install-status
