Sign in

v1

latestOpenAPI 3.1.02026-07-22304756.7 KB
Box

Prompt Box

Queue a natural-language work item for Codex or Claude Code inside the box. Observe progress with GET /boxes/{boxId}/events.

post/boxes/{boxId}/prompt

Path parameters

boxIdstring required

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

Request body

provider'codex' | 'claude-code' | 'claude' required
modelstring nullable

Optional provider model id. Prefer the documented ids; unknown explicit ids are currently forwarded rather than rejected by request validation.

reasoningEffortstring nullable

Optional reasoning effort. Codex supports none, low, medium, high, xhigh for GPT-5.4/5.5/5.4-mini and low, medium, high, xhigh for GPT-5.3 Codex. Claude claude-fable-5 and opus support low, medium, high, max; sonnet supports low, medium, high; haiku has no reasoning control.

promptstring required

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

Example request

{
  "provider": "codex",
  "model": "gpt-5.4",
  "reasoningEffort": "medium",
  "prompt": "Work on the selected repo, run tests, fix failures, commit the result, and report any hosted preview URL."
}

Response

Prompt queued.

okboolean required
type'prompt.queued' required

Stable success envelope discriminator added by v1.

idstring required

Box id.

promptIdstring required
status'queued' required
providerstring required
modelstring nullable
reasoningEffortstring nullable

Example response

{
  "ok": true
}