Skip to main content
POST

Authorizations

Authorization
string
header
required

Box bearer token in the form box_.... Service API keys authenticate Box operations.

Path Parameters

boxId
string
required

Public Box id returned by create/list/get box calls.

Pattern: ^bx_[23456789abcdefghjkmnpqrstuvwxyz]{8}$

Body

application/json

Work item to queue inside an existing Box. Provider credentials must already be configured in the Box dashboard.

Providers (harnesses): codex, claude-code (alias claude), pi, opencode, prime-agent (alias prime), kimi (Kimi Code CLI, alias kimi-code). Omit provider to use the harness the user selected on the Agents dashboard.

Models & reasoning effort are harness- and model-specific and change over time. Fetch the live catalog (every provider's models and which reasoning-effort levels each accepts) from GET /provider-models. Some models accept no reasoning control. pi, opencode and prime-agent also expose models routed through OpenRouter and llmgateway (ids like openrouter:anthropic/claude-sonnet-4.5).

Conversations: a Box runs many conversations in parallel, each with its own history. Set new: true to start a fresh conversation, or conversationId to continue a specific one; omit both to continue the Box's most-recently-active conversation. The response returns the conversationId this prompt ran in. Conversations run concurrently up to a per-box limit that scales with the Box's memory; beyond it, prompts queue.

provider
enum<string>
required
Available options:
codex,
claude-code,
claude,
pi,
opencode,
prime-agent,
prime,
kimi,
kimi-code
prompt
string
required

Natural-language task for the Box, including repo, preview, or browser-use instructions.

Minimum string length: 1
model
string | null

Optional provider model id from GET /provider-models. Omit to use the model selected for that harness on the Agents dashboard. Unknown explicit ids are currently forwarded rather than rejected by request validation.

Examples:

"gpt-5.6-terra"

"claude-sonnet-5"

"openrouter:anthropic/claude-sonnet-4.5"

reasoningEffort
string | null

Optional reasoning/thinking level (e.g. none, low, medium, high, xhigh, max). Which levels a given model accepts is listed per model in GET /provider-models; some models accept none.

Example:

"high"

new
boolean

Start a NEW conversation on the Box (runs in parallel with any existing ones) instead of continuing the most-recently-active one. Mutually exclusive with conversationId.

Example:

true

conversationId
string<uuid> | null

Continue a specific conversation by id (as returned by a previous prompt). Omit (and omit new) to continue the Box's most-recently-active conversation.

Response

Prompt queued.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

Allowed value: "prompt.queued"
id
string
required

Box id.

promptId
string
required
promptRun
object
required
status
enum<string>
required
Available options:
queued
provider
string
required
conversationId
string | null

The conversation this prompt was queued in. A new one when new was set, the one named by conversationId, or the Box's most-recently-active conversation. See Integrated agents.

model
string | null
reasoningEffort
string | null