# PromptRequest

Work item to queue inside an existing Boat. Provider credentials must already be configured in the Boat 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. 

## Properties

Name | Type
------------ | -------------
`provider` | string
`model` | string
`reasoningEffort` | string
`_new` | boolean
`conversationId` | string
`prompt` | string

## Example

```typescript
import type { PromptRequest } from '@asciidev/box-sdk'

// TODO: Update the object below with actual values
const example = {
  "provider": null,
  "model": null,
  "reasoningEffort": null,
  "_new": null,
  "conversationId": null,
  "prompt": null,
} satisfies PromptRequest

console.log(example)

// Convert the instance to a JSON string
const exampleJSON: string = JSON.stringify(example)
console.log(exampleJSON)

// Parse the JSON string back to an object
const exampleParsed = JSON.parse(exampleJSON) as PromptRequest
console.log(exampleParsed)
```

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)