@boatdev/sdk 1.0.0

package/dist/esm/models/NamedSnapshotSavingResponse.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Boat Public API v1
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products.  The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { NamedSnapshot } from './NamedSnapshot';
+/**
+ *
+ * @export
+ * @interface NamedSnapshotSavingResponse
+ */
+export interface NamedSnapshotSavingResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof NamedSnapshotSavingResponse
+     */
+    ok: boolean;
+    /**
+     *
+     * @type {NamedSnapshotSavingResponseTypeEnum}
+     * @memberof NamedSnapshotSavingResponse
+     */
+    type: NamedSnapshotSavingResponseTypeEnum;
+    /**
+     *
+     * @type {NamedSnapshotSavingResponseStatusEnum}
+     * @memberof NamedSnapshotSavingResponse
+     */
+    status: NamedSnapshotSavingResponseStatusEnum;
+    /**
+     *
+     * @type {NamedSnapshot}
+     * @memberof NamedSnapshotSavingResponse
+     */
+    snapshot: NamedSnapshot;
+}
+/**
+ * @export
+ */
+export declare const NamedSnapshotSavingResponseTypeEnum: {
+    readonly SnapshotNamedSaving: 'snapshot.named.saving';
+};
+export type NamedSnapshotSavingResponseTypeEnum = typeof NamedSnapshotSavingResponseTypeEnum[keyof typeof NamedSnapshotSavingResponseTypeEnum];
+/**
+ * @export
+ */
+export declare const NamedSnapshotSavingResponseStatusEnum: {
+    readonly Saving: 'saving';
+};
+export type NamedSnapshotSavingResponseStatusEnum = typeof NamedSnapshotSavingResponseStatusEnum[keyof typeof NamedSnapshotSavingResponseStatusEnum];
+/**
+ * Check if a given object implements the NamedSnapshotSavingResponse interface.
+ */
+export declare function instanceOfNamedSnapshotSavingResponse(value: object): value is NamedSnapshotSavingResponse;
+export declare function NamedSnapshotSavingResponseFromJSON(json: any): NamedSnapshotSavingResponse;
+export declare function NamedSnapshotSavingResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): NamedSnapshotSavingResponse;
+export declare function NamedSnapshotSavingResponseToJSON(json: any): NamedSnapshotSavingResponse;
+export declare function NamedSnapshotSavingResponseToJSONTyped(value?: NamedSnapshotSavingResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/NamedSnapshotSavingResponse.js

@@ -0,0 +1,68 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Boat Public API v1
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products.  The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { NamedSnapshotFromJSON, NamedSnapshotToJSON, } from './NamedSnapshot';
+/**
+ * @export
+ */
+export const NamedSnapshotSavingResponseTypeEnum = {
+    SnapshotNamedSaving: 'snapshot.named.saving'
+};
+/**
+ * @export
+ */
+export const NamedSnapshotSavingResponseStatusEnum = {
+    Saving: 'saving'
+};
+/**
+ * Check if a given object implements the NamedSnapshotSavingResponse interface.
+ */
+export function instanceOfNamedSnapshotSavingResponse(value) {
+    if (!('ok' in value) || value['ok'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('snapshot' in value) || value['snapshot'] === undefined)
+        return false;
+    return true;
+}
+export function NamedSnapshotSavingResponseFromJSON(json) {
+    return NamedSnapshotSavingResponseFromJSONTyped(json, false);
+}
+export function NamedSnapshotSavingResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'status': json['status'],
+        'snapshot': NamedSnapshotFromJSON(json['snapshot']),
+    };
+}
+export function NamedSnapshotSavingResponseToJSON(json) {
+    return NamedSnapshotSavingResponseToJSONTyped(json, false);
+}
+export function NamedSnapshotSavingResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'status': value['status'],
+        'snapshot': NamedSnapshotToJSON(value['snapshot']),
+    };
+}

package/dist/esm/models/PageInfo.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Boat Public API v1
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products.  The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface PageInfo
+ */
+export interface PageInfo {
+    /**
+     *
+     * @type {string}
+     * @memberof PageInfo
+     */
+    nextCursor: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PageInfo
+     */
+    hasMore: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof PageInfo
+     */
+    limit: number;
+}
+/**
+ * Check if a given object implements the PageInfo interface.
+ */
+export declare function instanceOfPageInfo(value: object): value is PageInfo;
+export declare function PageInfoFromJSON(json: any): PageInfo;
+export declare function PageInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): PageInfo;
+export declare function PageInfoToJSON(json: any): PageInfo;
+export declare function PageInfoToJSONTyped(value?: PageInfo | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PageInfo.js

@@ -0,0 +1,51 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Boat Public API v1
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products.  The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the PageInfo interface.
+ */
+export function instanceOfPageInfo(value) {
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined)
+        return false;
+    if (!('hasMore' in value) || value['hasMore'] === undefined)
+        return false;
+    if (!('limit' in value) || value['limit'] === undefined)
+        return false;
+    return true;
+}
+export function PageInfoFromJSON(json) {
+    return PageInfoFromJSONTyped(json, false);
+}
+export function PageInfoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'nextCursor': json['nextCursor'],
+        'hasMore': json['hasMore'],
+        'limit': json['limit'],
+    };
+}
+export function PageInfoToJSON(json) {
+    return PageInfoToJSONTyped(json, false);
+}
+export function PageInfoToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'nextCursor': value['nextCursor'],
+        'hasMore': value['hasMore'],
+        'limit': value['limit'],
+    };
+}

package/dist/esm/models/PromptEvent.d.ts

@@ -0,0 +1,70 @@
+/**
+ * Boat Public API v1
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products.  The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { PromptEventData } from './PromptEventData';
+/**
+ *
+ * @export
+ * @interface PromptEvent
+ */
+export interface PromptEvent {
+    /**
+     *
+     * @type {string}
+     * @memberof PromptEvent
+     */
+    id: string;
+    /**
+     *
+     * @type {PromptEventTypeEnum}
+     * @memberof PromptEvent
+     */
+    type: PromptEventTypeEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof PromptEvent
+     */
+    timestamp: number;
+    /**
+     *
+     * @type {string}
+     * @memberof PromptEvent
+     */
+    taskId?: string | null;
+    /**
+     * The conversation this prompt belongs to.
+     * @type {string}
+     * @memberof PromptEvent
+     */
+    conversationId?: string | null;
+    /**
+     *
+     * @type {PromptEventData}
+     * @memberof PromptEvent
+     */
+    data: PromptEventData;
+}
+/**
+ * @export
+ */
+export declare const PromptEventTypeEnum: {
+    readonly Prompt: 'prompt';
+};
+export type PromptEventTypeEnum = typeof PromptEventTypeEnum[keyof typeof PromptEventTypeEnum];
+/**
+ * Check if a given object implements the PromptEvent interface.
+ */
+export declare function instanceOfPromptEvent(value: object): value is PromptEvent;
+export declare function PromptEventFromJSON(json: any): PromptEvent;
+export declare function PromptEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): PromptEvent;
+export declare function PromptEventToJSON(json: any): PromptEvent;
+export declare function PromptEventToJSONTyped(value?: PromptEvent | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PromptEvent.js

@@ -0,0 +1,66 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Boat Public API v1
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products.  The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { PromptEventDataFromJSON, PromptEventDataToJSON, } from './PromptEventData';
+/**
+ * @export
+ */
+export const PromptEventTypeEnum = {
+    Prompt: 'prompt'
+};
+/**
+ * Check if a given object implements the PromptEvent interface.
+ */
+export function instanceOfPromptEvent(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('timestamp' in value) || value['timestamp'] === undefined)
+        return false;
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    return true;
+}
+export function PromptEventFromJSON(json) {
+    return PromptEventFromJSONTyped(json, false);
+}
+export function PromptEventFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'type': json['type'],
+        'timestamp': json['timestamp'],
+        'taskId': json['taskId'] == null ? undefined : json['taskId'],
+        'conversationId': json['conversationId'] == null ? undefined : json['conversationId'],
+        'data': PromptEventDataFromJSON(json['data']),
+    };
+}
+export function PromptEventToJSON(json) {
+    return PromptEventToJSONTyped(json, false);
+}
+export function PromptEventToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'type': value['type'],
+        'timestamp': value['timestamp'],
+        'taskId': value['taskId'],
+        'conversationId': value['conversationId'],
+        'data': PromptEventDataToJSON(value['data']),
+    };
+}

package/dist/esm/models/PromptEventData.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Boat Public API v1
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products.  The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface PromptEventData
+ */
+export interface PromptEventData {
+    /**
+     *
+     * @type {string}
+     * @memberof PromptEventData
+     */
+    prompt: string;
+    /**
+     *
+     * @type {PromptEventDataStatusEnum}
+     * @memberof PromptEventData
+     */
+    status: PromptEventDataStatusEnum;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PromptEventData
+     */
+    isReverted?: boolean;
+}
+/**
+ * @export
+ */
+export declare const PromptEventDataStatusEnum: {
+    readonly Sending: 'sending';
+    readonly Queued: 'queued';
+    readonly Running: 'running';
+    readonly Finished: 'finished';
+    readonly Failed: 'failed';
+    readonly Interrupted: 'interrupted';
+};
+export type PromptEventDataStatusEnum = typeof PromptEventDataStatusEnum[keyof typeof PromptEventDataStatusEnum];
+/**
+ * Check if a given object implements the PromptEventData interface.
+ */
+export declare function instanceOfPromptEventData(value: object): value is PromptEventData;
+export declare function PromptEventDataFromJSON(json: any): PromptEventData;
+export declare function PromptEventDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): PromptEventData;
+export declare function PromptEventDataToJSON(json: any): PromptEventData;
+export declare function PromptEventDataToJSONTyped(value?: PromptEventData | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PromptEventData.js

@@ -0,0 +1,60 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Boat Public API v1
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products.  The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * @export
+ */
+export const PromptEventDataStatusEnum = {
+    Sending: 'sending',
+    Queued: 'queued',
+    Running: 'running',
+    Finished: 'finished',
+    Failed: 'failed',
+    Interrupted: 'interrupted'
+};
+/**
+ * Check if a given object implements the PromptEventData interface.
+ */
+export function instanceOfPromptEventData(value) {
+    if (!('prompt' in value) || value['prompt'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    return true;
+}
+export function PromptEventDataFromJSON(json) {
+    return PromptEventDataFromJSONTyped(json, false);
+}
+export function PromptEventDataFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'prompt': json['prompt'],
+        'status': json['status'],
+        'isReverted': json['is_reverted'] == null ? undefined : json['is_reverted'],
+    };
+}
+export function PromptEventDataToJSON(json) {
+    return PromptEventDataToJSONTyped(json, false);
+}
+export function PromptEventDataToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'prompt': value['prompt'],
+        'status': value['status'],
+        'is_reverted': value['isReverted'],
+    };
+}

package/dist/esm/models/PromptRequest.d.ts

@@ -0,0 +1,84 @@
+/**
+ * Boat Public API v1
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products.  The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * 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.
+ *
+ * @export
+ * @interface PromptRequest
+ */
+export interface PromptRequest {
+    /**
+     *
+     * @type {PromptRequestProviderEnum}
+     * @memberof PromptRequest
+     */
+    provider: PromptRequestProviderEnum;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof PromptRequest
+     */
+    model?: 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.
+     * @type {string}
+     * @memberof PromptRequest
+     */
+    reasoningEffort?: string | null;
+    /**
+     * Start a NEW conversation on the sandbox (runs in parallel with any existing ones) instead of continuing the most-recently-active one. Mutually exclusive with `conversationId`.
+     * @type {boolean}
+     * @memberof PromptRequest
+     */
+    _new?: boolean;
+    /**
+     * Continue a specific conversation by id (as returned by a previous prompt). Omit (and omit `new`) to continue the sandbox's most-recently-active conversation.
+     * @type {string}
+     * @memberof PromptRequest
+     */
+    conversationId?: string | null;
+    /**
+     * Natural-language task for the sandbox, including repo, preview, or browser-use instructions.
+     * @type {string}
+     * @memberof PromptRequest
+     */
+    prompt: string;
+}
+/**
+ * @export
+ */
+export declare const PromptRequestProviderEnum: {
+    readonly Codex: 'codex';
+    readonly ClaudeCode: 'claude-code';
+    readonly Claude: 'claude';
+    readonly Pi: 'pi';
+    readonly Opencode: 'opencode';
+    readonly PrimeAgent: 'prime-agent';
+    readonly Prime: 'prime';
+    readonly Kimi: 'kimi';
+    readonly KimiCode: 'kimi-code';
+};
+export type PromptRequestProviderEnum = typeof PromptRequestProviderEnum[keyof typeof PromptRequestProviderEnum];
+/**
+ * Check if a given object implements the PromptRequest interface.
+ */
+export declare function instanceOfPromptRequest(value: object): value is PromptRequest;
+export declare function PromptRequestFromJSON(json: any): PromptRequest;
+export declare function PromptRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PromptRequest;
+export declare function PromptRequestToJSON(json: any): PromptRequest;
+export declare function PromptRequestToJSONTyped(value?: PromptRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PromptRequest.js

@@ -0,0 +1,69 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Boat Public API v1
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products.  The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * @export
+ */
+export const PromptRequestProviderEnum = {
+    Codex: 'codex',
+    ClaudeCode: 'claude-code',
+    Claude: 'claude',
+    Pi: 'pi',
+    Opencode: 'opencode',
+    PrimeAgent: 'prime-agent',
+    Prime: 'prime',
+    Kimi: 'kimi',
+    KimiCode: 'kimi-code'
+};
+/**
+ * Check if a given object implements the PromptRequest interface.
+ */
+export function instanceOfPromptRequest(value) {
+    if (!('provider' in value) || value['provider'] === undefined)
+        return false;
+    if (!('prompt' in value) || value['prompt'] === undefined)
+        return false;
+    return true;
+}
+export function PromptRequestFromJSON(json) {
+    return PromptRequestFromJSONTyped(json, false);
+}
+export function PromptRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'provider': json['provider'],
+        'model': json['model'] == null ? undefined : json['model'],
+        'reasoningEffort': json['reasoningEffort'] == null ? undefined : json['reasoningEffort'],
+        '_new': json['new'] == null ? undefined : json['new'],
+        'conversationId': json['conversationId'] == null ? undefined : json['conversationId'],
+        'prompt': json['prompt'],
+    };
+}
+export function PromptRequestToJSON(json) {
+    return PromptRequestToJSONTyped(json, false);
+}
+export function PromptRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'provider': value['provider'],
+        'model': value['model'],
+        'reasoningEffort': value['reasoningEffort'],
+        'new': value['_new'],
+        'conversationId': value['conversationId'],
+        'prompt': value['prompt'],
+    };
+}