@boatdev/sdk 1.0.0

package/docs/PromptEvent.md

@@ -0,0 +1,42 @@
+
+# PromptEvent
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`type` | string
+`timestamp` | number
+`taskId` | string
+`conversationId` | string
+`data` | [PromptEventData](PromptEventData.md)
+
+## Example
+
+```typescript
+import type { PromptEvent } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "type": null,
+  "timestamp": null,
+  "taskId": null,
+  "conversationId": null,
+  "data": null,
+} satisfies PromptEvent
+
+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 PromptEvent
+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)

package/docs/PromptEventData.md

@@ -0,0 +1,36 @@
+
+# PromptEventData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`prompt` | string
+`status` | string
+`isReverted` | boolean
+
+## Example
+
+```typescript
+import type { PromptEventData } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "prompt": null,
+  "status": null,
+  "isReverted": null,
+} satisfies PromptEventData
+
+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 PromptEventData
+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)

package/docs/PromptRequest.md

@@ -0,0 +1,43 @@
+
+# PromptRequest
+
+Work item to queue inside an existing sandbox. 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 sandbox 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 sandbox\'s most-recently-active conversation. The response returns the `conversationId` this prompt ran in. Conversations run concurrently up to a per-sandbox limit that scales with the sandbox\'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 '@boatdev/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)

package/docs/PromptResponse.md

@@ -0,0 +1,50 @@
+
+# PromptResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`id` | string
+`promptId` | string
+`conversationId` | string
+`promptRun` | [PromptRun](PromptRun.md)
+`status` | string
+`provider` | string
+`model` | string
+`reasoningEffort` | string
+
+## Example
+
+```typescript
+import type { PromptResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "id": null,
+  "promptId": null,
+  "conversationId": null,
+  "promptRun": null,
+  "status": null,
+  "provider": null,
+  "model": null,
+  "reasoningEffort": null,
+} satisfies PromptResponse
+
+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 PromptResponse
+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)

package/docs/PromptRun.md

@@ -0,0 +1,48 @@
+
+# PromptRun
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`promptId` | string
+`sandboxId` | string
+`status` | string
+`done` | boolean
+`createdAt` | Date
+`model` | string
+`reasoningEffort` | string
+`conversationId` | string
+
+## Example
+
+```typescript
+import type { PromptRun } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "promptId": null,
+  "sandboxId": null,
+  "status": null,
+  "done": null,
+  "createdAt": null,
+  "model": null,
+  "reasoningEffort": null,
+  "conversationId": null,
+} satisfies PromptRun
+
+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 PromptRun
+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)

package/docs/PromptRunResponse.md

@@ -0,0 +1,38 @@
+
+# PromptRunResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`id` | string
+`promptRun` | [PromptRun](PromptRun.md)
+
+## Example
+
+```typescript
+import type { PromptRunResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "id": null,
+  "promptRun": null,
+} satisfies PromptRunResponse
+
+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 PromptRunResponse
+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)

package/docs/RepoSelectionRequest.md

@@ -0,0 +1,35 @@
+
+# RepoSelectionRequest
+
+Idempotently selects a repository for future sandboxes. If the repository is already selected, the API updates its base branch instead of returning a conflict.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`repositoryId` | string
+`baseBranch` | string
+
+## Example
+
+```typescript
+import type { RepoSelectionRequest } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "repositoryId": null,
+  "baseBranch": null,
+} satisfies RepoSelectionRequest
+
+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 RepoSelectionRequest
+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)

package/docs/RepoSelectionResponse.md

@@ -0,0 +1,40 @@
+
+# RepoSelectionResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`success` | boolean
+`environmentId` | string
+`selectedRepositories` | [Array<SelectedRepository>](SelectedRepository.md)
+
+## Example
+
+```typescript
+import type { RepoSelectionResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "success": null,
+  "environmentId": null,
+  "selectedRepositories": null,
+} satisfies RepoSelectionResponse
+
+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 RepoSelectionResponse
+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)

package/docs/ReposResponse.md

@@ -0,0 +1,42 @@
+
+# ReposResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`installations` | [Array<RepositoryInstallation>](RepositoryInstallation.md)
+`environmentId` | string
+`selectedRepositories` | [Array<SelectedRepository>](SelectedRepository.md)
+`pageInfo` | [PageInfo](PageInfo.md)
+
+## Example
+
+```typescript
+import type { ReposResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "installations": null,
+  "environmentId": null,
+  "selectedRepositories": null,
+  "pageInfo": null,
+} satisfies ReposResponse
+
+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 ReposResponse
+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)

package/docs/Repository.md

@@ -0,0 +1,44 @@
+
+# Repository
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`databaseId` | string
+`name` | string
+`fullName` | string
+`_private` | boolean
+`permissions` | string
+`pushedAt` | Date
+
+## Example
+
+```typescript
+import type { Repository } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "databaseId": null,
+  "name": null,
+  "fullName": null,
+  "_private": null,
+  "permissions": null,
+  "pushedAt": null,
+} satisfies Repository
+
+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 Repository
+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)

package/docs/RepositoryInstallation.md

@@ -0,0 +1,38 @@
+
+# RepositoryInstallation
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`accountLogin` | string
+`accountAvatarUrl` | string
+`repositories` | [Array<Repository>](Repository.md)
+
+## Example
+
+```typescript
+import type { RepositoryInstallation } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "accountLogin": null,
+  "accountAvatarUrl": null,
+  "repositories": null,
+} satisfies RepositoryInstallation
+
+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 RepositoryInstallation
+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)

package/docs/ResponseEvent.md

@@ -0,0 +1,43 @@
+
+# ResponseEvent
+
+Agent response event. Text deltas/finals and tool-call batches are both represented as response events; tool-call batches have `data.tools`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`type` | string
+`timestamp` | number
+`taskId` | string
+`conversationId` | string
+`data` | [ResponseEventData](ResponseEventData.md)
+
+## Example
+
+```typescript
+import type { ResponseEvent } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "type": null,
+  "timestamp": null,
+  "taskId": null,
+  "conversationId": null,
+  "data": null,
+} satisfies ResponseEvent
+
+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 ResponseEvent
+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)

package/docs/ResponseEventData.md

@@ -0,0 +1,38 @@
+
+# ResponseEventData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`content` | string
+`model` | string
+`tools` | Array<{ [key: string]: any; }>
+`isStreaming` | boolean
+
+## Example
+
+```typescript
+import type { ResponseEventData } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "content": null,
+  "model": null,
+  "tools": null,
+  "isStreaming": null,
+} satisfies ResponseEventData
+
+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 ResponseEventData
+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)

package/docs/ResumeRequest.md

@@ -0,0 +1,41 @@
+
+# ResumeRequest
+
+Options for resuming a stopped sandbox.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`env` | { [key: string]: string; }
+`environment` | string
+`noEnv` | boolean
+`ttlSeconds` | number
+
+## Example
+
+```typescript
+import type { ResumeRequest } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "env": null,
+  "environment": null,
+  "noEnv": null,
+  "ttlSeconds": null,
+} satisfies ResumeRequest
+
+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 ResumeRequest
+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)

package/docs/RotateApiKey409Response.md

@@ -0,0 +1,34 @@
+
+# RotateApiKey409Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { RotateApiKey409Response } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": null,
+  "message": null,
+} satisfies RotateApiKey409Response
+
+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 RotateApiKey409Response
+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)