asteroid-odyssey 1.0.17 → 1.0.22

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, GetAgentsData, QueueOptimisationJobData, CreateWorkflowData, DeleteWorkflowData, GetWorkflowData, ExecuteWorkflowData, GetExecutionsForWorkflowData, DeleteExecutionData, GetExecutionData, UpdateExecutionStatusData, GetBrowserSessionData, SetSlackChannelData, GetAgentWorkflowExecutionsData, GetExecutionProgressData, GetExecutionFilesData } from './types.gen';
+import type { GetOpenApiData, HealthCheckData, GetAgentsData, QueueOptimisationJobData, CreateWorkflowData, DeleteWorkflowData, GetWorkflowData, ExecuteWorkflowData, GetExecutionsForWorkflowData, DeleteWorkflowCredentialsData, GetWorkflowCredentialsData, AddWorkflowCredentialData, GetCredentialsPublicKeyData, DeleteExecutionData, GetExecutionData, UpdateExecutionStatusData, GetBrowserSessionData, SetSlackChannelData, GetAgentWorkflowExecutionsData, GetExecutionProgressData, GetExecutionFilesData, GetWorkflowVersionsData, GetExecutionUserMessagesData, CreateExecutionUserMessageData } 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
@@ -57,6 +57,22 @@ export declare const executeWorkflow: <ThrowOnError extends boolean = false>(opt
  * Get all executions for a workflow
  */
 export declare const getExecutionsForWorkflow: <ThrowOnError extends boolean = false>(options: Options<GetExecutionsForWorkflowData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").Execution[], unknown, ThrowOnError>;
+/**
+ * Delete credentials for a workflow
+ */
+export declare const deleteWorkflowCredentials: <ThrowOnError extends boolean = false>(options: Options<DeleteWorkflowCredentialsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<unknown, unknown, ThrowOnError>;
+/**
+ * Get credentials for a workflow (and all prior versions of the workflow)
+ */
+export declare const getWorkflowCredentials: <ThrowOnError extends boolean = false>(options: Options<GetWorkflowCredentialsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").CredentialsResponse, unknown, ThrowOnError>;
+/**
+ * Add a credential for a workflow
+ */
+export declare const addWorkflowCredential: <ThrowOnError extends boolean = false>(options: Options<AddWorkflowCredentialData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<unknown, unknown, ThrowOnError>;
+/**
+ * Get the public key for credentials
+ */
+export declare const getCredentialsPublicKey: <ThrowOnError extends boolean = false>(options?: Options<GetCredentialsPublicKeyData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<string, unknown, ThrowOnError>;
 /**
  * Delete an execution
  */
@@ -93,3 +109,15 @@ export declare const getExecutionProgress: <ThrowOnError extends boolean = false
  * Get files for an execution
  */
 export declare const getExecutionFiles: <ThrowOnError extends boolean = false>(options: Options<GetExecutionFilesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").File[], unknown, ThrowOnError>;
+/**
+ * Get all versions of a workflow
+ */
+export declare const getWorkflowVersions: <ThrowOnError extends boolean = false>(options: Options<GetWorkflowVersionsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").Workflow[], unknown, ThrowOnError>;
+/**
+ * Get all user messages for an execution
+ */
+export declare const getExecutionUserMessages: <ThrowOnError extends boolean = false>(options: Options<GetExecutionUserMessagesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").UserMessage[], unknown, ThrowOnError>;
+/**
+ * Create a user message for an execution
+ */
+export declare const createExecutionUserMessage: <ThrowOnError extends boolean = false>(options: Options<CreateExecutionUserMessageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<unknown, unknown, ThrowOnError>;

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

@@ -1,7 +1,7 @@
 "use strict";
 // This file is auto-generated by @hey-api/openapi-ts
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getExecutionFiles = exports.getExecutionProgress = exports.getAgentWorkflowExecutions = exports.setSlackChannel = exports.getBrowserSession = exports.updateExecutionStatus = exports.getExecution = exports.deleteExecution = exports.getExecutionsForWorkflow = exports.executeWorkflow = exports.getWorkflow = exports.deleteWorkflow = exports.createWorkflow = exports.queueOptimisationJob = exports.getAgents = exports.healthCheck = exports.getOpenApi = void 0;
+exports.createExecutionUserMessage = exports.getExecutionUserMessages = exports.getWorkflowVersions = exports.getExecutionFiles = exports.getExecutionProgress = exports.getAgentWorkflowExecutions = exports.setSlackChannel = exports.getBrowserSession = exports.updateExecutionStatus = exports.getExecution = exports.deleteExecution = exports.getCredentialsPublicKey = exports.addWorkflowCredential = exports.getWorkflowCredentials = exports.deleteWorkflowCredentials = exports.getExecutionsForWorkflow = exports.executeWorkflow = exports.getWorkflow = exports.deleteWorkflow = exports.createWorkflow = exports.queueOptimisationJob = exports.getAgents = exports.healthCheck = exports.getOpenApi = void 0;
 const client_gen_1 = require("./client.gen");
 /**
  * Get the OpenAPI schema
@@ -105,6 +105,50 @@ const getExecutionsForWorkflow = (options) => {
     });
 };
 exports.getExecutionsForWorkflow = getExecutionsForWorkflow;
+/**
+ * Delete credentials for a workflow
+ */
+const deleteWorkflowCredentials = (options) => {
+    return (options.client ?? client_gen_1.client).delete({
+        url: '/workflow/{workflow_id}/credentials',
+        ...options
+    });
+};
+exports.deleteWorkflowCredentials = deleteWorkflowCredentials;
+/**
+ * Get credentials for a workflow (and all prior versions of the workflow)
+ */
+const getWorkflowCredentials = (options) => {
+    return (options.client ?? client_gen_1.client).get({
+        url: '/workflow/{workflow_id}/credentials',
+        ...options
+    });
+};
+exports.getWorkflowCredentials = getWorkflowCredentials;
+/**
+ * Add a credential for a workflow
+ */
+const addWorkflowCredential = (options) => {
+    return (options.client ?? client_gen_1.client).patch({
+        url: '/workflow/{workflow_id}/credentials',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options?.headers
+        }
+    });
+};
+exports.addWorkflowCredential = addWorkflowCredential;
+/**
+ * Get the public key for credentials
+ */
+const getCredentialsPublicKey = (options) => {
+    return (options?.client ?? client_gen_1.client).get({
+        url: '/credentials/public_key',
+        ...options
+    });
+};
+exports.getCredentialsPublicKey = getCredentialsPublicKey;
 /**
  * Delete an execution
  */
@@ -193,3 +237,37 @@ const getExecutionFiles = (options) => {
     });
 };
 exports.getExecutionFiles = getExecutionFiles;
+/**
+ * Get all versions of a workflow
+ */
+const getWorkflowVersions = (options) => {
+    return (options.client ?? client_gen_1.client).get({
+        url: '/workflow/{workflow_id}/versions',
+        ...options
+    });
+};
+exports.getWorkflowVersions = getWorkflowVersions;
+/**
+ * Get all user messages for an execution
+ */
+const getExecutionUserMessages = (options) => {
+    return (options.client ?? client_gen_1.client).get({
+        url: '/execution/{id}/user_messages',
+        ...options
+    });
+};
+exports.getExecutionUserMessages = getExecutionUserMessages;
+/**
+ * Create a user message for an execution
+ */
+const createExecutionUserMessage = (options) => {
+    return (options.client ?? client_gen_1.client).post({
+        url: '/execution/{id}/user_messages',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options?.headers
+        }
+    });
+};
+exports.createExecutionUserMessage = createExecutionUserMessage;

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

@@ -31,14 +31,14 @@ export type Agent = {
      * The visibility of the agent
      */
     visibility: string;
-    /**
-     * The required fields for the agent
-     */
-    required_fields: Array<string>;
     /**
      * The prompts for the agent
      */
     required_prompts: Array<string>;
+    /**
+     * The fields that must be provided when creating a workflow for a given agent
+     */
+    required_fields?: Array<string>;
 };
 /**
  * A JSON Schema that defines the expected structure and validation rules for workflow results.
@@ -57,7 +57,7 @@ export type CreateWorkflowRequest = {
     user_id?: string;
     result_schema: ResultSchema;
     /**
-     * JSON object containing static workflow configuration (e.g. a prompt_template).
+     * Unused field for custom configuration
      */
     fields: {
         [key: string]: unknown;
@@ -66,10 +66,15 @@ export type CreateWorkflowRequest = {
      * The prompts for the workflow. They can have variables in them. They will be merged with the dynamic data passed when the workflow is executed.
      */
     prompts: Array<string>;
+    workflow_options: UnresolvedWorkflowOptions;
     /**
      * The Language Model Provider for the Workflow
      */
     provider: 'openai' | 'anthropic';
+    /**
+     * The URL to start the workflow.
+     */
+    start_url: string;
 };
 export type Workflow = {
     /**
@@ -93,12 +98,6 @@ export type Workflow = {
      * Workflow name.
      */
     name: string;
-    /**
-     * Workflow configuration.
-     */
-    fields: {
-        [key: string]: unknown;
-    };
     /**
      * The prompts for the workflow. They can have variables in them. They will be merged with the dynamic data passed when the workflow is executed.
      */
@@ -107,6 +106,22 @@ export type Workflow = {
      * The variables in the prompts.
      */
     prompt_variables?: Array<string>;
+    /**
+     * Additional options for the workflow. See documentation for more details.
+     */
+    workflow_options?: {
+        [key: string]: unknown;
+    };
+    /**
+     * The URL to start the workflow.
+     */
+    start_url: string;
+    /**
+     * JSON object containing static workflow configuration (e.g. a prompt_template).
+     */
+    fields?: {
+        [key: string]: unknown;
+    };
 };
 export type WorkflowExecution = {
     workflow: Workflow;
@@ -118,6 +133,26 @@ export type WorkflowExecution = {
 export type WorkflowExecutionRequest = {
     [key: string]: unknown;
 };
+export type CredentialsRequest = {
+    credentials: Array<Credential>;
+};
+export type Credential = {
+    /**
+     * The credential name
+     */
+    name: string;
+    /**
+     * The encrypted credential
+     */
+    data: string;
+};
+export type CredentialsResponse = {
+    /**
+     * The name of the workflow
+     */
+    workflow_name: string;
+    credentials: Array<Credential>;
+};
 export type Execution = {
     /**
      * Execution identifier.
@@ -250,6 +285,98 @@ export type File = {
      */
     signed_url: string;
 };
+/**
+ * A message given to the agent by the user
+ */
+export type UserMessage = {
+    /**
+     * Unique identifier for the message
+     */
+    id: string;
+    /**
+     * ID of the execution this message belongs to
+     */
+    execution_id: string;
+    /**
+     * ID of the user who created the message
+     */
+    user_id: string;
+    /**
+     * The message content
+     */
+    message: string;
+    /**
+     * When the message was created
+     */
+    created_at: string;
+    /**
+     * Whether the message has been injected into the agent's conversation
+     */
+    injected: boolean;
+    /**
+     * When the message was injected into the agent's conversation
+     */
+    injected_at: string;
+};
+export type CreateMessageRequest = {
+    /**
+     * The message content
+     */
+    message: string;
+};
+/**
+ * Optional workflow configuration options. All fields are optional and will use defaults if not specified.
+ */
+export type UnresolvedWorkflowOptions = {
+    /**
+     * Maximum number of iterations for the workflow
+     */
+    max_iterations?: number;
+    /**
+     * Timeout in seconds per step
+     */
+    timeout_per_step?: number;
+    /**
+     * Browser viewport width
+     */
+    viewport_width?: number;
+    /**
+     * Browser viewport height
+     */
+    viewport_height?: number;
+    /**
+     * Maximum retries for LLM calls
+     */
+    max_llm_retries?: number;
+    /**
+     * Delay between retries in seconds
+     */
+    llm_retry_delay?: number;
+    /**
+     * Maximum pause duration in minutes
+     */
+    max_pause_duration?: number;
+    /**
+     * Status check interval in seconds
+     */
+    status_check_interval?: number;
+    /**
+     * Temperature for LLM (0.0 to 1.0)
+     */
+    temperature?: number;
+    /**
+     * Prompt template for LLM
+     */
+    prompt_template?: string;
+    /**
+     * Allowed tools for LLM
+     */
+    allowed_tools?: Array<string>;
+    /**
+     * Require human approval to finish
+     */
+    require_human_approval_to_finish?: boolean;
+};
 export type GetOpenApiData = {
     body?: never;
     path?: never;
@@ -421,6 +548,80 @@ export type GetExecutionsForWorkflowResponses = {
     200: Array<Execution>;
 };
 export type GetExecutionsForWorkflowResponse = GetExecutionsForWorkflowResponses[keyof GetExecutionsForWorkflowResponses];
+export type DeleteWorkflowCredentialsData = {
+    body?: never;
+    path: {
+        workflow_id: string;
+    };
+    query?: never;
+    url: '/workflow/{workflow_id}/credentials';
+};
+export type DeleteWorkflowCredentialsErrors = {
+    /**
+     * Workflow not found
+     */
+    404: unknown;
+};
+export type DeleteWorkflowCredentialsResponses = {
+    /**
+     * Credentials deleted successfully
+     */
+    200: unknown;
+};
+export type GetWorkflowCredentialsData = {
+    body?: never;
+    path: {
+        workflow_id: string;
+    };
+    query?: never;
+    url: '/workflow/{workflow_id}/credentials';
+};
+export type GetWorkflowCredentialsErrors = {
+    /**
+     * Workflow not found
+     */
+    404: unknown;
+};
+export type GetWorkflowCredentialsResponses = {
+    /**
+     * The workflow credentials
+     */
+    200: CredentialsResponse;
+};
+export type GetWorkflowCredentialsResponse = GetWorkflowCredentialsResponses[keyof GetWorkflowCredentialsResponses];
+export type AddWorkflowCredentialData = {
+    body: CredentialsRequest;
+    path: {
+        workflow_id: string;
+    };
+    query?: never;
+    url: '/workflow/{workflow_id}/credentials';
+};
+export type AddWorkflowCredentialResponses = {
+    /**
+     * Credentials set successfully
+     */
+    200: unknown;
+};
+export type GetCredentialsPublicKeyData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/credentials/public_key';
+};
+export type GetCredentialsPublicKeyErrors = {
+    /**
+     * Public key not found
+     */
+    404: unknown;
+};
+export type GetCredentialsPublicKeyResponses = {
+    /**
+     * The public key for credentials
+     */
+    200: string;
+};
+export type GetCredentialsPublicKeyResponse = GetCredentialsPublicKeyResponses[keyof GetCredentialsPublicKeyResponses];
 export type DeleteExecutionData = {
     body?: never;
     path: {
@@ -592,6 +793,68 @@ export type GetExecutionFilesResponses = {
     200: Array<File>;
 };
 export type GetExecutionFilesResponse = GetExecutionFilesResponses[keyof GetExecutionFilesResponses];
+export type GetWorkflowVersionsData = {
+    body?: never;
+    path: {
+        workflow_id: string;
+    };
+    query?: never;
+    url: '/workflow/{workflow_id}/versions';
+};
+export type GetWorkflowVersionsErrors = {
+    /**
+     * Workflow not found
+     */
+    404: unknown;
+};
+export type GetWorkflowVersionsResponses = {
+    /**
+     * List of workflow versions
+     */
+    200: Array<Workflow>;
+};
+export type GetWorkflowVersionsResponse = GetWorkflowVersionsResponses[keyof GetWorkflowVersionsResponses];
+export type GetExecutionUserMessagesData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/execution/{id}/user_messages';
+};
+export type GetExecutionUserMessagesErrors = {
+    /**
+     * Execution not found
+     */
+    404: unknown;
+};
+export type GetExecutionUserMessagesResponses = {
+    /**
+     * List of messages for the execution
+     */
+    200: Array<UserMessage>;
+};
+export type GetExecutionUserMessagesResponse = GetExecutionUserMessagesResponses[keyof GetExecutionUserMessagesResponses];
+export type CreateExecutionUserMessageData = {
+    body: CreateMessageRequest;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/execution/{id}/user_messages';
+};
+export type CreateExecutionUserMessageErrors = {
+    /**
+     * Execution not found
+     */
+    404: unknown;
+};
+export type CreateExecutionUserMessageResponses = {
+    /**
+     * Message created successfully
+     */
+    201: unknown;
+};
 export type ClientOptions = {
     baseUrl: `${string}://${string}/api/v1` | (string & {});
 };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import type { Client } from '@hey-api/client-fetch';
-import type { CreateWorkflowRequest, WorkflowExecutionRequest, Execution } from './generated/agents/types.gen';
+import type { CreateWorkflowRequest, WorkflowExecutionRequest, Execution, BrowserSession } from './generated/agents/types.gen';
 /**
  * Create an API client with a provided API key.
  *
@@ -9,7 +9,9 @@ import type { CreateWorkflowRequest, WorkflowExecutionRequest, Execution } from
  * @example
  * const client = AsteroidClient('your-api-key');
  */
-export declare const AsteroidClient: (apiKey: string) => Client;
+export declare const AsteroidClient: (apiKey: string, options?: {
+    baseUrl?: string;
+}) => Client;
 /**
  * Create a new workflow for a given agent.
  *
@@ -80,6 +82,14 @@ export declare const getWorkflowExecutionProgress: (client: Client, executionId:
  * console.log(result);
  */
 export declare const getWorkflowResult: (client: Client, executionId: string) => Promise<Record<string, unknown>>;
+/**
+ * Get the browser session for an execution.
+ *
+ * @param client - The API client.
+ * @param executionId - The execution identifier.
+ * @returns The browser session.
+ */
+export declare const getBrowserSession: (client: Client, executionId: string) => Promise<BrowserSession>;
 /**
  * Waits for a workflow execution to reach a terminal state and returns the result.
  * Continuously polls the execution status until it's either "completed", "cancelled", or "failed".

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.getWorkflowResult = exports.getWorkflowExecutionProgress = exports.getExecutionStatus = exports.executeWorkflowById = exports.createNewWorkflow = exports.AsteroidClient = void 0;
+exports.waitForExecutionResult = exports.getBrowserSession = exports.getWorkflowResult = exports.getWorkflowExecutionProgress = exports.getExecutionStatus = exports.executeWorkflowById = exports.createNewWorkflow = exports.AsteroidClient = void 0;
 const client_fetch_1 = require("@hey-api/client-fetch");
 const AgentsSDK = __importStar(require("./generated/agents/sdk.gen"));
 /**
@@ -48,9 +48,9 @@ const AgentsSDK = __importStar(require("./generated/agents/sdk.gen"));
  * @example
  * const client = AsteroidClient('your-api-key');
  */
-const AsteroidClient = (apiKey) => {
+const AsteroidClient = (apiKey, options) => {
     return (0, client_fetch_1.createClient)({
-        baseUrl: 'https://odyssey.asteroid.ai/api/v1',
+        baseUrl: options?.baseUrl || 'https://odyssey.asteroid.ai/api/v1',
         headers: {
             'X-Asteroid-Agents-Api-Key': apiKey
         }
@@ -75,9 +75,6 @@ exports.AsteroidClient = AsteroidClient;
  * });
  */
 const createNewWorkflow = async (client, agentName, workflowDetails) => {
-    // Add a workflow_name key to the workflowDetails.fields object
-    // This field is deprecated and will be removed in a future version.
-    workflowDetails.fields.workflow_name = workflowDetails.name;
     const response = await AgentsSDK.createWorkflow({
         client,
         path: { agent_name: agentName },
@@ -173,6 +170,24 @@ const getWorkflowResult = async (client, executionId) => {
     return execution.result;
 };
 exports.getWorkflowResult = getWorkflowResult;
+/**
+ * Get the browser session for an execution.
+ *
+ * @param client - The API client.
+ * @param executionId - The execution identifier.
+ * @returns The browser session.
+ */
+const getBrowserSession = async (client, executionId) => {
+    const browserSession = await AgentsSDK.getBrowserSession({
+        client,
+        path: { id: executionId },
+    });
+    if (browserSession.error) {
+        throw new Error(browserSession.error);
+    }
+    return browserSession.data;
+};
+exports.getBrowserSession = getBrowserSession;
 /**
  * Waits for a workflow execution to reach a terminal state and returns the result.
  * Continuously polls the execution status until it's either "completed", "cancelled", or "failed".

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "asteroid-odyssey",
-  "version": "v1.0.17",
+  "version": "v1.0.22",
   "description": "SDK for interacting with Asteroid Agents API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",