asteroid-odyssey 1.0.25 → 1.2.2

package/dist/generated/agents/sdk.gen.d.ts

@@ -1,5 +1,5 @@
-import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
-import type { GetOpenApiData, HealthCheckData, ExecuteAgentData, GetExecutionStatusData, GetExecutionResultData } from './types.gen';
+import { type Options as ClientOptions, type TDataShape, type Client } from '@hey-api/client-fetch';
+import type { GetOpenApiData, UploadExecutionFilesData, HealthCheckData, ExecuteAgentData, ExecuteAgentStructuredData, GetExecutionStatusData, GetExecutionResultData, GetBrowserSessionRecordingData } from './types.gen';
 export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
     /**
      * You can provide a client instance returned by `createClient()` instead of
@@ -17,6 +17,13 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
  * Get the OpenAPI schema
  */
 export declare const getOpenApi: <ThrowOnError extends boolean = false>(options?: Options<GetOpenApiData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<unknown, unknown, ThrowOnError>;
+/**
+ * Upload files to an execution
+ */
+export declare const uploadExecutionFiles: <ThrowOnError extends boolean = false>(options: Options<UploadExecutionFilesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<{
+    message?: string;
+    file_ids?: Array<string>;
+}, import("./types.gen").ErrorResponse, ThrowOnError>;
 /**
  * Check the health of the API
  */
@@ -30,6 +37,11 @@ export declare const healthCheck: <ThrowOnError extends boolean = false>(options
  * Executes an agent with the provided parameters
  */
 export declare const executeAgent: <ThrowOnError extends boolean = false>(options: Options<ExecuteAgentData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").ExecutionResponse, import("./types.gen").ErrorResponse, ThrowOnError>;
+/**
+ * Execute an agent with structured parameters
+ * Executes an agent with structured parameters including optional agent profile configuration. This is the recommended method for new integrations.
+ */
+export declare const executeAgentStructured: <ThrowOnError extends boolean = false>(options: Options<ExecuteAgentStructuredData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").ExecutionResponse, import("./types.gen").ErrorResponse, ThrowOnError>;
 /**
  * Get execution status
  */
@@ -38,3 +50,8 @@ export declare const getExecutionStatus: <ThrowOnError extends boolean = false>(
  * Get execution result
  */
 export declare const getExecutionResult: <ThrowOnError extends boolean = false>(options: Options<GetExecutionResultData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").ExecutionResultResponse, import("./types.gen").ErrorResponse, ThrowOnError>;
+/**
+ * Get browser session recording
+ * Retrieves the browser session recording URL for a completed execution
+ */
+export declare const getBrowserSessionRecording: <ThrowOnError extends boolean = false>(options: Options<GetBrowserSessionRecordingData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").BrowserSessionRecordingResponse, import("./types.gen").ErrorResponse, ThrowOnError>;

package/dist/generated/agents/sdk.gen.js

@@ -1,7 +1,8 @@
 "use strict";
 // This file is auto-generated by @hey-api/openapi-ts
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getExecutionResult = exports.getExecutionStatus = exports.executeAgent = exports.healthCheck = exports.getOpenApi = void 0;
+exports.getBrowserSessionRecording = exports.getExecutionResult = exports.getExecutionStatus = exports.executeAgentStructured = exports.executeAgent = exports.healthCheck = exports.uploadExecutionFiles = exports.getOpenApi = void 0;
+const client_fetch_1 = require("@hey-api/client-fetch");
 const client_gen_1 = require("./client.gen");
 /**
  * Get the OpenAPI schema
@@ -13,6 +14,27 @@ const getOpenApi = (options) => {
     });
 };
 exports.getOpenApi = getOpenApi;
+/**
+ * Upload files to an execution
+ */
+const uploadExecutionFiles = (options) => {
+    return (options.client ?? client_gen_1.client).post({
+        ...client_fetch_1.formDataBodySerializer,
+        security: [
+            {
+                name: 'X-Asteroid-Agents-Api-Key',
+                type: 'apiKey'
+            }
+        ],
+        url: '/execution/{id}/files',
+        ...options,
+        headers: {
+            'Content-Type': null,
+            ...options?.headers
+        }
+    });
+};
+exports.uploadExecutionFiles = uploadExecutionFiles;
 /**
  * Check the health of the API
  */
@@ -44,6 +66,27 @@ const executeAgent = (options) => {
     });
 };
 exports.executeAgent = executeAgent;
+/**
+ * Execute an agent with structured parameters
+ * Executes an agent with structured parameters including optional agent profile configuration. This is the recommended method for new integrations.
+ */
+const executeAgentStructured = (options) => {
+    return (options.client ?? client_gen_1.client).post({
+        security: [
+            {
+                name: 'X-Asteroid-Agents-Api-Key',
+                type: 'apiKey'
+            }
+        ],
+        url: '/agent/{id}/execute',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options?.headers
+        }
+    });
+};
+exports.executeAgentStructured = executeAgentStructured;
 /**
  * Get execution status
  */
@@ -76,3 +119,20 @@ const getExecutionResult = (options) => {
     });
 };
 exports.getExecutionResult = getExecutionResult;
+/**
+ * Get browser session recording
+ * Retrieves the browser session recording URL for a completed execution
+ */
+const getBrowserSessionRecording = (options) => {
+    return (options.client ?? client_gen_1.client).get({
+        security: [
+            {
+                name: 'X-Asteroid-Agents-Api-Key',
+                type: 'apiKey'
+            }
+        ],
+        url: '/execution/{id}/browser_session/recording',
+        ...options
+    });
+};
+exports.getBrowserSessionRecording = getBrowserSessionRecording;

package/dist/generated/agents/types.gen.d.ts

@@ -32,7 +32,8 @@ export type ExecutionResultResponse = {
     execution_id: string;
     status: Status;
     /**
-     * The execution result data (if execution is completed)
+     * (Deprecated, use execution_result instead) The structured result data from the execution. Contains the outcome, reasoning, final answer, and result.
+     * @deprecated
      */
     result?: {
         [key: string]: unknown;
@@ -41,17 +42,58 @@ export type ExecutionResultResponse = {
      * Error message (if execution failed)
      */
     error?: string;
+    execution_result?: ExecutionResult;
+};
+/**
+ * The result of an execution. Contains the outcome, reasoning, and result.
+ */
+export type ExecutionResult = {
+    /**
+     * The outcome of the execution (success or failure)
+     */
+    outcome?: 'success' | 'failure';
+    /**
+     * The reasoning behind the execution outcome
+     */
+    reasoning?: string;
+    /**
+     * The structured result data from the execution. This will follow the format defined in the result_schema of the agent.
+     */
+    result?: {
+        [key: string]: unknown;
+    };
 };
 /**
  * Status of the execution
  */
-export type Status = 'starting' | 'running' | 'paused' | 'completed' | 'cancelled' | 'failed' | 'awaiting_completion';
+export type Status = 'starting' | 'running' | 'paused' | 'completed' | 'cancelled' | 'failed' | 'awaiting_completion' | 'paused_by_agent';
 export type ErrorResponse = {
     /**
      * Error message
      */
     error: string;
 };
+export type BrowserSessionRecordingResponse = {
+    /**
+     * The URL of the browser session recording
+     */
+    recording_url: string;
+};
+/**
+ * Request to execute an agent with structured parameters including optional agent profile configuration
+ */
+export type StructuredAgentExecutionRequest = {
+    /**
+     * The ID of the browser profile to use
+     */
+    agent_profile_id?: string;
+    /**
+     * Dynamic data to be merged into the saved agent configuration.
+     */
+    dynamic_data?: {
+        [key: string]: unknown;
+    };
+};
 export type GetOpenApiData = {
     body?: never;
     path?: never;
@@ -64,6 +106,53 @@ export type GetOpenApiResponses = {
      */
     200: unknown;
 };
+export type UploadExecutionFilesData = {
+    body: {
+        /**
+         * Files to upload to the execution
+         */
+        files?: Array<Blob | File>;
+    };
+    path: {
+        /**
+         * The ID of the execution
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/execution/{id}/files';
+};
+export type UploadExecutionFilesErrors = {
+    /**
+     * Bad request
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Execution not found
+     */
+    404: ErrorResponse;
+};
+export type UploadExecutionFilesError = UploadExecutionFilesErrors[keyof UploadExecutionFilesErrors];
+export type UploadExecutionFilesResponses = {
+    /**
+     * Files uploaded successfully
+     */
+    200: {
+        /**
+         * Success message
+         */
+        message?: string;
+        /**
+         * IDs of the uploaded files
+         */
+        file_ids?: Array<string>;
+    };
+};
+export type UploadExecutionFilesResponse = UploadExecutionFilesResponses[keyof UploadExecutionFilesResponses];
 export type HealthCheckData = {
     body?: never;
     path?: never;
@@ -127,6 +216,39 @@ export type ExecuteAgentResponses = {
     202: ExecutionResponse;
 };
 export type ExecuteAgentResponse = ExecuteAgentResponses[keyof ExecuteAgentResponses];
+export type ExecuteAgentStructuredData = {
+    body: StructuredAgentExecutionRequest;
+    path: {
+        /**
+         * The ID of the agent
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/agent/{id}/execute';
+};
+export type ExecuteAgentStructuredErrors = {
+    /**
+     * Invalid request
+     */
+    400: ErrorResponse;
+    /**
+     * Agent not found
+     */
+    404: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+export type ExecuteAgentStructuredError = ExecuteAgentStructuredErrors[keyof ExecuteAgentStructuredErrors];
+export type ExecuteAgentStructuredResponses = {
+    /**
+     * Agent execution started successfully
+     */
+    202: ExecutionResponse;
+};
+export type ExecuteAgentStructuredResponse = ExecuteAgentStructuredResponses[keyof ExecuteAgentStructuredResponses];
 export type GetExecutionStatusData = {
     body?: never;
     path: {
@@ -185,6 +307,35 @@ export type GetExecutionResultResponses = {
     200: ExecutionResultResponse;
 };
 export type GetExecutionResultResponse = GetExecutionResultResponses[keyof GetExecutionResultResponses];
+export type GetBrowserSessionRecordingData = {
+    body?: never;
+    path: {
+        /**
+         * The ID of the execution
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/execution/{id}/browser_session/recording';
+};
+export type GetBrowserSessionRecordingErrors = {
+    /**
+     * Browser session not found
+     */
+    404: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+export type GetBrowserSessionRecordingError = GetBrowserSessionRecordingErrors[keyof GetBrowserSessionRecordingErrors];
+export type GetBrowserSessionRecordingResponses = {
+    /**
+     * Browser session recording retrieved successfully
+     */
+    200: BrowserSessionRecordingResponse;
+};
+export type GetBrowserSessionRecordingResponse = GetBrowserSessionRecordingResponses[keyof GetBrowserSessionRecordingResponses];
 export type ClientOptions = {
-    baseUrl: 'https://odyssey.asteroid.ai/api/v1' | (string & {});
+    baseUrl: 'https://odyssey.asteroid.ai/api/v1' | `${string}://${string}/api/v1` | (string & {});
 };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import type { Client } from '@hey-api/client-fetch';
-import type { AgentExecutionRequest, ExecutionStatusResponse } from './generated/agents/types.gen';
+import type { StructuredAgentExecutionRequest, ExecutionStatusResponse, BrowserSessionRecordingResponse } from './generated/agents/types.gen';
 /**
  * Create an API client with a provided API key.
  *
@@ -13,17 +13,20 @@ export declare const AsteroidClient: (apiKey: string, options?: {
     baseUrl?: string;
 }) => Client;
 /**
- * Execute an agent with the provided parameters.
+ * Execute an agent with parameters including optional agent profile ID.
  *
  * @param client - The API client.
  * @param agentId - The ID of the agent to execute.
- * @param executionData - The execution parameters.
+ * @param executionData - The structured execution parameters.
  * @returns The execution ID.
  *
  * @example
- * const executionId = await executeAgent(client, 'my-agent-id', { input: "some dynamic value" });
+ * const executionId = await executeAgent(client, 'my-agent-id', {
+ *   agent_profile_id: 'profile-123',
+ *   dynamic_data: { input: "some dynamic value" }
+ * });
  */
-export declare const executeAgent: (client: Client, agentId: string, executionData: AgentExecutionRequest) => Promise<string>;
+export declare const executeAgent: (client: Client, agentId: string, executionData: StructuredAgentExecutionRequest) => Promise<string>;
 /**
  * Get the current status for an execution.
  *
@@ -62,6 +65,36 @@ export declare const getExecutionResult: (client: Client, executionId: string) =
  * const result = await waitForExecutionResult(client, executionId, 2000);
  */
 export declare const waitForExecutionResult: (client: Client, executionId: string, interval?: number, timeout?: number) => Promise<Record<string, unknown>>;
+/**
+ * Get the browser session recording URL for a completed execution.
+ *
+ * @param client - The API client.
+ * @param executionId - The execution identifier.
+ * @returns The browser session recording URL.
+ *
+ * @example
+ * const recording = await getBrowserSessionRecording(client, executionId);
+ * console.log(recording.recording_url);
+ */
+export declare const getBrowserSessionRecording: (client: Client, executionId: string) => Promise<BrowserSessionRecordingResponse>;
+/**
+ * Upload files to an execution.
+ *
+ * @param client - The API client.
+ * @param executionId - The execution identifier.
+ * @param files - Array of files to upload.
+ * @returns The uploaded file IDs and success message.
+ *
+ * @example
+ * const fileInput = document.getElementById('file-input') as HTMLInputElement;
+ * const files = Array.from(fileInput.files || []);
+ * const result = await uploadExecutionFiles(client, executionId, files);
+ * console.log(result.file_ids);
+ */
+export declare const uploadExecutionFiles: (client: Client, executionId: string, files: Array<Blob | File>) => Promise<{
+    message?: string;
+    file_ids?: string[];
+}>;
 /**
  * Optionally, re-export all generated functions and types.
  */

package/dist/index.js

@@ -36,7 +36,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.waitForExecutionResult = exports.getExecutionResult = exports.getExecutionStatus = exports.executeAgent = exports.AsteroidClient = void 0;
+exports.uploadExecutionFiles = exports.getBrowserSessionRecording = exports.waitForExecutionResult = exports.getExecutionResult = exports.getExecutionStatus = exports.executeAgent = exports.AsteroidClient = void 0;
 const client_fetch_1 = require("@hey-api/client-fetch");
 const AgentsSDK = __importStar(require("./generated/agents/sdk.gen"));
 /**
@@ -58,18 +58,21 @@ const AsteroidClient = (apiKey, options) => {
 };
 exports.AsteroidClient = AsteroidClient;
 /**
- * Execute an agent with the provided parameters.
+ * Execute an agent with parameters including optional agent profile ID.
  *
  * @param client - The API client.
  * @param agentId - The ID of the agent to execute.
- * @param executionData - The execution parameters.
+ * @param executionData - The structured execution parameters.
  * @returns The execution ID.
  *
  * @example
- * const executionId = await executeAgent(client, 'my-agent-id', { input: "some dynamic value" });
+ * const executionId = await executeAgent(client, 'my-agent-id', {
+ *   agent_profile_id: 'profile-123',
+ *   dynamic_data: { input: "some dynamic value" }
+ * });
  */
 const executeAgent = async (client, agentId, executionData) => {
-    const response = await AgentsSDK.executeAgent({
+    const response = await AgentsSDK.executeAgentStructured({
         client,
         path: { id: agentId },
         body: executionData,
@@ -124,7 +127,7 @@ const getExecutionResult = async (client, executionId) => {
     if (response.data.error) {
         throw new Error(response.data.error);
     }
-    return response.data.result || {};
+    return response.data.execution_result || {};
 };
 exports.getExecutionResult = getExecutionResult;
 /**
@@ -160,6 +163,54 @@ const waitForExecutionResult = async (client, executionId, interval = 1000, time
     throw new Error(`Execution ${executionId} timed out after ${timeout}ms`);
 };
 exports.waitForExecutionResult = waitForExecutionResult;
+/**
+ * Get the browser session recording URL for a completed execution.
+ *
+ * @param client - The API client.
+ * @param executionId - The execution identifier.
+ * @returns The browser session recording URL.
+ *
+ * @example
+ * const recording = await getBrowserSessionRecording(client, executionId);
+ * console.log(recording.recording_url);
+ */
+const getBrowserSessionRecording = async (client, executionId) => {
+    const response = await AgentsSDK.getBrowserSessionRecording({
+        client,
+        path: { id: executionId },
+    });
+    if (response.error) {
+        throw new Error(response.error.error);
+    }
+    return response.data;
+};
+exports.getBrowserSessionRecording = getBrowserSessionRecording;
+/**
+ * Upload files to an execution.
+ *
+ * @param client - The API client.
+ * @param executionId - The execution identifier.
+ * @param files - Array of files to upload.
+ * @returns The uploaded file IDs and success message.
+ *
+ * @example
+ * const fileInput = document.getElementById('file-input') as HTMLInputElement;
+ * const files = Array.from(fileInput.files || []);
+ * const result = await uploadExecutionFiles(client, executionId, files);
+ * console.log(result.file_ids);
+ */
+const uploadExecutionFiles = async (client, executionId, files) => {
+    const response = await AgentsSDK.uploadExecutionFiles({
+        client,
+        path: { id: executionId },
+        body: { files },
+    });
+    if (response.error) {
+        throw new Error(response.error.error);
+    }
+    return response.data;
+};
+exports.uploadExecutionFiles = uploadExecutionFiles;
 /**
  * Optionally, re-export all generated functions and types.
  */

package/package.json

@@ -1,17 +1,12 @@
 {
   "name": "asteroid-odyssey",
-  "version": "v1.0.25",
+  "version": "1.2.2",
   "description": "SDK for interacting with Asteroid Agents API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "tsc",
-    "prepare": "npm run build",
-    "openapi-ts": "openapi-ts"
-  },
   "keywords": [
     "asteroid",
     "agents",
@@ -28,5 +23,9 @@
   },
   "dependencies": {
     "@hey-api/client-fetch": "^0.8.3"
+  },
+  "scripts": {
+    "build": "tsc",
+    "openapi-ts": "openapi-ts"
   }
-}
+}

package/dist/AgentsSDK.d.ts

@@ -1,70 +0,0 @@
-import { OpenAPI as AgentsOpenAPI } from './src/generated/agents';
-import { OpenAPI as PlatformOpenAPI } from './src/generated/platform';
-import type { Agent } from './src/generated/agents/models/Agent';
-import type { CreateWorkflowRequest } from './src/generated/agents/models/CreateWorkflowRequest';
-import type { WorkflowExecutionRequest } from './src/generated/agents/models/WorkflowExecutionRequest';
-import type { WorkflowExecution } from './src/generated/agents/models/WorkflowExecution';
-import type { Status } from './src/generated/platform/models/Status';
-import type { FeedbackRequest } from './src/generated/platform/models/FeedbackRequest';
-import type { Feedback } from './src/generated/platform/models/Feedback';
-/**
- * AgentsSDK provides a simple interface for interacting with the Asteroid Agents API.
- * It wraps the generated client services and exposes high-level methods.
- */
-export declare class AsteroidAgents {
-    /**
-     * Optionally pass a custom OpenAPI config. For instance, to change the API base URL.
-     * @param config Partial OpenAPI config values.
-     */
-    constructor(apiKey: string, agentsConfig?: Partial<typeof AgentsOpenAPI>, platformConfig?: Partial<typeof PlatformOpenAPI>);
-    /**
-     * Retrieves the OpenAPI schema from the API.
-     * @returns The OpenAPI specification.
-     */
-    getOpenApiSchema(): Promise<any>;
-    /**
-     * Checks the health of the API.
-     * @returns An object containing the health status.
-     */
-    healthCheck(): Promise<{
-        status?: string;
-    }>;
-    /**
-     * Retrieves a list of all agents.
-     * @returns An array of agents.
-     */
-    getAgents(): Promise<Agent[]>;
-    /**
-     * Creates a new workflow for a given agent.
-     * @param agentName The name of the agent for which the workflow is created.
-     * @param request The workflow creation request.
-     * @returns The ID of the newly created workflow.
-     */
-    createWorkflow(agentName: string, request: CreateWorkflowRequest): Promise<string>;
-    /**
-     * Executes a saved workflow for an agent.
-     * @param workflowId The ID of the workflow to execute.
-     * @param request The execution request containing dynamic values.
-     * @returns A string indicating that the job was queued.
-     */
-    runWorkflow(workflowId: string, request: WorkflowExecutionRequest): Promise<string>;
-    /**
-     * Retrieves all workflows along with their executions.
-     * @returns An array containing workflow executions.
-     */
-    getWorkflowRuns(): Promise<WorkflowExecution[]>;
-    /**
-     * Retrieves the status of a run.
-     * @param runId The ID of the run to retrieve the status for.
-     * @returns The status of the run.
-     */
-    getRunStatus(runId: string): Promise<Status>;
-    getRunResult(runId: string): Promise<string>;
-    /**
-     * Creates feedback for a run.
-     * @param runId The ID of the run to create feedback for.
-     * @param request The feedback request.
-     * @returns The feedback created.
-     */
-    createRunFeedback(runId: string, request: FeedbackRequest): Promise<Feedback>;
-}