@eigenpal/sdk 0.6.14 → 0.6.16

package/src/generated/types.gen.ts

@@ -12,20 +12,6 @@ export type PatchAgentBody = {
   };
 };
 
-export type RunAgentBody = {
-  input?: {
-    [key: string]: unknown;
-  };
-  _metadata?: {
-    [key: string]: unknown;
-  };
-  /**
-   * Git source ref to resolve for this run. Defaults to latest. Supports latest, main, exact versions/tags such as 1.2.3, semver ranges such as 1.2.x or 1.x, and exact commit SHAs.
-   */
-  sourceRef?: string;
-  [key: string]: unknown;
-};
-
 export type CreateAgentBody = {
   name: string;
   slug: string;
@@ -35,6 +21,10 @@ export type CreateAgentBody = {
   };
 };
 
+export type RunTargetInputBody = {
+  [key: string]: unknown;
+};
+
 export type RunFeedbackRequest = {
   body?: string | null;
   feedback?: string | null;
@@ -97,29 +87,6 @@ export type SourceSecretsEncryptBody = {
   }>;
 };
 
-export type RunWorkflowBody = {
-  /**
-   * Workflow inputs keyed by input name
-   */
-  input?: {
-    [key: string]: unknown;
-  };
-  /**
-   * Per-step output overrides for replay
-   */
-  overrides?: {
-    steps?: {
-      [key: string]: {
-        [key: string]: unknown;
-      };
-    };
-  } | null;
-  /**
-   * Caller surface (defaults to "api")
-   */
-  trigger?: 'api' | 'cli';
-};
-
 export type ApiErrorEnvelope = {
   issues: Array<ApiErrorIssue>;
   /**
@@ -187,32 +154,6 @@ export type PatchAgentResponse = {
   agent: AgentSummary;
 };
 
-export type RunAgentResponse = {
-  runId: string;
-  status?: ExecutionStatus | 'timeout';
-  output?: unknown;
-  schemaValid?: boolean | null;
-  error?: string | null;
-  requestedSourceRef?: string | null;
-  resolvedGitRef?: string | null;
-  resolvedGitTag?: string | null;
-  resolvedCommitSha?: string | null;
-  cost?: {
-    [key: string]: unknown;
-  };
-};
-
-export type ExecutionStatus =
-  | 'created'
-  | 'pending'
-  | 'running'
-  | 'waiting'
-  | 'finalizing'
-  | 'completed'
-  | 'failed'
-  | 'cancelled'
-  | 'rejected';
-
 export type ListAgentVersionsResponse = {
   agentId: string;
   slug: string;
@@ -263,6 +204,33 @@ export type AutomationSyncResponse = {
   warnings: Array<string>;
 };
 
+export type RunStartResponse = {
+  runId: string;
+  type: 'workflow' | 'agent';
+  status?: ExecutionStatus | 'pending' | 'timeout';
+  output?: unknown;
+  error?: string | null;
+  schemaValid?: boolean | null;
+  requestedSourceRef?: string | null;
+  resolvedGitRef?: string | null;
+  resolvedGitTag?: string | null;
+  resolvedCommitSha?: string | null;
+  cost?: {
+    [key: string]: unknown;
+  };
+};
+
+export type ExecutionStatus =
+  | 'created'
+  | 'pending'
+  | 'running'
+  | 'waiting'
+  | 'finalizing'
+  | 'completed'
+  | 'failed'
+  | 'cancelled'
+  | 'rejected';
+
 export type RunFilesResponse = {
   inputs: Array<{
     [key: string]: unknown;
@@ -280,10 +248,6 @@ export type RunRerunResponse = {
   status?: string;
 };
 
-export type RunResumeResponse = {
-  [key: string]: unknown;
-};
-
 export type RunEnvelope = {
   run:
     | RunSummary
@@ -414,25 +378,6 @@ export type WorkflowDetail = {
   yamlContent?: string | null;
 };
 
-export type RunWorkflowResponse = {
-  /**
-   * Newly created execution id (e.g. exec_xyz)
-   */
-  executionId: string;
-  /**
-   * Final execution status. Only set when the run completed within `wait_for_completion`.
-   */
-  status?: ExecutionStatus;
-  /**
-   * Workflow output (status=completed)
-   */
-  result?: unknown;
-  /**
-   * Error message (status=failed)
-   */
-  error?: string;
-};
-
 export type ListVersionsResponse = {
   data: Array<WorkflowVersion>;
   total: number;
@@ -761,69 +706,6 @@ export type AgentsUpdateResponses = {
 
 export type AgentsUpdateResponse = AgentsUpdateResponses[keyof AgentsUpdateResponses];
 
-export type AgentsRunData = {
-  body: RunAgentBody;
-  path: {
-    /**
-     * Agent id or slug
-     */
-    agentId: string;
-  };
-  query?: {
-    /**
-     * Seconds to hold the connection waiting for completion (max 600). Omit for async.
-     */
-    wait_for_completion?: number;
-    /**
-     * Git source ref to resolve for this run. Defaults to latest. Supports latest, main, exact versions/tags such as 1.2.3, semver ranges such as 1.2.x or 1.x, and exact commit SHAs.
-     */
-    sourceRef?: string;
-  };
-  url: '/api/v1/agents/{agentId}/run';
-};
-
-export type AgentsRunErrors = {
-  /**
-   * Validation error. Request shape did not match the spec.
-   */
-  400: ApiErrorEnvelope;
-  /**
-   * Missing or invalid API key
-   */
-  401: ApiErrorEnvelope;
-  /**
-   * API key lacks required scope
-   */
-  403: ApiErrorEnvelope;
-  /**
-   * Resource not found
-   */
-  404: ApiErrorEnvelope;
-  /**
-   * Rate limit exceeded
-   */
-  429: ApiErrorEnvelope;
-  /**
-   * Internal server error
-   */
-  500: ApiErrorEnvelope;
-};
-
-export type AgentsRunError = AgentsRunErrors[keyof AgentsRunErrors];
-
-export type AgentsRunResponses = {
-  /**
-   * Execution completed while waiting
-   */
-  200: RunAgentResponse;
-  /**
-   * Execution accepted
-   */
-  202: RunAgentResponse;
-};
-
-export type AgentsRunResponse = AgentsRunResponses[keyof AgentsRunResponses];
-
 export type AgentsTriggersEmailDeleteAliasData = {
   body?: never;
   path: {
@@ -1374,6 +1256,71 @@ export type AutomationsSyncResponses = {
 
 export type AutomationsSyncResponse = AutomationsSyncResponses[keyof AutomationsSyncResponses];
 
+export type RunStartWithTargetData = {
+  body: RunTargetInputBody;
+  path: {
+    /**
+     * Automation target without a version suffix.
+     */
+    target: string;
+  };
+  query?: {
+    /**
+     * Optional version or source ref. Defaults to latest.
+     */
+    version?: string;
+    wait_for_completion?: number;
+  };
+  url: '/api/v1/run/{target}';
+};
+
+export type RunStartWithTargetErrors = {
+  /**
+   * Validation error. Request shape did not match the spec.
+   */
+  400: ApiErrorEnvelope;
+  /**
+   * Missing or invalid API key
+   */
+  401: ApiErrorEnvelope;
+  /**
+   * API key lacks required scope
+   */
+  403: ApiErrorEnvelope;
+  /**
+   * Resource not found
+   */
+  404: ApiErrorEnvelope;
+  /**
+   * Rate limit exceeded
+   */
+  429: ApiErrorEnvelope;
+  /**
+   * Internal server error
+   */
+  500: ApiErrorEnvelope;
+};
+
+export type RunStartWithTargetError = RunStartWithTargetErrors[keyof RunStartWithTargetErrors];
+
+export type RunStartWithTargetResponses = {
+  /**
+   * Run completed while waiting
+   */
+  200: RunStartResponse;
+  /**
+   * Workflow run accepted
+   */
+  201: RunStartResponse;
+  /**
+   * Agent run accepted or wait timed out
+   */
+  202: RunStartResponse;
+};
+
+export type RunStartWithTargetResponse =
+  RunStartWithTargetResponses[keyof RunStartWithTargetResponses];
+
 export type RunsArtifactGetData = {
   body?: never;
   path: {
@@ -2165,7 +2112,9 @@ export type RunsRerunData = {
   path: {
     id: string;
   };
-  query?: never;
+  query?: {
+    wait_for_completion?: number;
+  };
   url: '/api/v1/runs/{id}/rerun';
 };
 
@@ -2200,66 +2149,20 @@ export type RunsRerunError = RunsRerunErrors[keyof RunsRerunErrors];
 
 export type RunsRerunResponses = {
   /**
-   * Rerun started
+   * Rerun completed while waiting
    */
   200: RunRerunResponse;
   /**
-   * Rerun started
+   * Workflow rerun accepted
    */
   201: RunRerunResponse;
-};
-
-export type RunsRerunResponse = RunsRerunResponses[keyof RunsRerunResponses];
-
-export type RunsResumeData = {
-  body?: never;
-  path: {
-    /**
-     * Run id
-     */
-    id: string;
-  };
-  query?: never;
-  url: '/api/v1/runs/{id}/resume';
-};
-
-export type RunsResumeErrors = {
-  /**
-   * Validation error. Request shape did not match the spec.
-   */
-  400: ApiErrorEnvelope;
-  /**
-   * Missing or invalid API key
-   */
-  401: ApiErrorEnvelope;
-  /**
-   * API key lacks required scope
-   */
-  403: ApiErrorEnvelope;
-  /**
-   * Resource not found
-   */
-  404: ApiErrorEnvelope;
   /**
-   * Rate limit exceeded
+   * Agent rerun accepted or wait timed out
    */
-  429: ApiErrorEnvelope;
-  /**
-   * Internal server error
-   */
-  500: ApiErrorEnvelope;
+  202: RunRerunResponse;
 };
 
-export type RunsResumeError = RunsResumeErrors[keyof RunsResumeErrors];
-
-export type RunsResumeResponses = {
-  /**
-   * Run resumed
-   */
-  200: RunResumeResponse;
-};
-
-export type RunsResumeResponse = RunsResumeResponses[keyof RunsResumeResponses];
+export type RunsRerunResponse = RunsRerunResponses[keyof RunsRerunResponses];
 
 export type RunsGetData = {
   body?: never;
@@ -2764,65 +2667,6 @@ export type WorkflowsGetResponses = {
 
 export type WorkflowsGetResponse = WorkflowsGetResponses[keyof WorkflowsGetResponses];
 
-export type WorkflowsRunData = {
-  body: RunWorkflowBody;
-  path: {
-    /**
-     * Workflow id (e.g. `wf_abc123`) or slug (e.g. `extract-invoice`, the workflow `name`).
-     */
-    id: string;
-  };
-  query?: {
-    /**
-     * Version id, or "latest" (default)
-     */
-    version?: string;
-    /**
-     * Seconds to hold the connection waiting for completion (max 60). Omit for async.
-     */
-    wait_for_completion?: number;
-  };
-  url: '/api/v1/workflows/{id}/run';
-};
-
-export type WorkflowsRunErrors = {
-  /**
-   * Validation error. Request shape did not match the spec.
-   */
-  400: ApiErrorEnvelope;
-  /**
-   * Missing or invalid API key
-   */
-  401: ApiErrorEnvelope;
-  /**
-   * API key lacks required scope
-   */
-  403: ApiErrorEnvelope;
-  /**
-   * Resource not found
-   */
-  404: ApiErrorEnvelope;
-  /**
-   * Rate limit exceeded
-   */
-  429: ApiErrorEnvelope;
-  /**
-   * Internal server error
-   */
-  500: ApiErrorEnvelope;
-};
-
-export type WorkflowsRunError = WorkflowsRunErrors[keyof WorkflowsRunErrors];
-
-export type WorkflowsRunResponses = {
-  /**
-   * Execution accepted. Body always includes `executionId`. When `wait_for_completion` is set and the execution completes within the window, `status`/`result`/`error` are also returned; otherwise poll `/api/v1/runs/{executionId}` for status.
-   */
-  201: RunWorkflowResponse;
-};
-
-export type WorkflowsRunResponse = WorkflowsRunResponses[keyof WorkflowsRunResponses];
-
 export type WorkflowsVersionsListData = {
   body?: never;
   path: {

package/src/index.ts

@@ -8,10 +8,13 @@
  * const client = new EigenpalClient({ apiKey: process.env.EIGENPAL_API_KEY! });
  *
  * // Async — enqueue and poll later.
- * const { executionId } = await client.workflows.run('wf_abc', { input: { ... } });
+ * const { runId } = await client.run('workflows.extract-invoice', {
+ *   input: { ... },
+ * });
  *
  * // Sync (server holds the connection up to 60s).
- * const result = await client.workflows.run('wf_abc', { input: { ... } }, {
+ * const result = await client.run('workflows.extract-invoice', {
+ *   input: { ... },
  *   waitForCompletion: 60,
  * });
  *
@@ -19,7 +22,15 @@
  * const final = await client.workflows.executions.runAndWait('wf_abc', { input: { ... } });
  * ```
  */
-export { EigenpalClient, type EigenpalOptions } from './client';
+export {
+  EigenpalClient,
+  type EigenpalOptions,
+  type RerunOptions,
+  type RunInput,
+  type RunOptions,
+  type RunStartResponse,
+  type RunTarget,
+} from './client';
 
 export {
   EigenpalAuthError,
@@ -34,20 +45,19 @@ export {
 
 export { toFile } from './lib/files';
 export type { FileDescriptor, FileInput, NodeReadableStream } from './lib/files';
-export type { ListAgentsOptions, RunAgentOptions } from './resources/agents';
+export type { ListAgentsOptions } from './resources/agents';
 export type { ListRunsOptions } from './resources/runs';
 export type { SourceRawOptions, SourceReleasesOptions } from './resources/source';
 export type {
   ListVersionsOptions,
   ListWorkflowsOptions,
-  RunWorkflowOptions,
   WorkflowInput,
 } from './resources/workflows';
 // Note: FileReference (by fileId) is intentionally NOT exported. From the
 // SDK perspective you always upload a file; fileId is an internal wire id
 // the server creates after upload — not something users construct.
 
-export type { RunAndWaitOptions } from './resources/executions';
+export type { RunAndWaitOptions, WorkflowRunAndWaitResponse } from './resources/executions';
 
 // Re-export the canonical generated types so users can type their own
 // callbacks and helpers without reaching into `./generated`.
@@ -71,10 +81,8 @@ export type {
   ListVersionsResponse,
   ListWorkflowsResponse,
   RawSourceResponse,
-  RunAgentResponse,
   RunSummary,
-  RunWorkflowBody,
-  RunWorkflowResponse,
+  RunTargetInputBody,
   RunsCancelResponse,
   RunsExpectedCreateResponse,
   RunsExpectedFileDeleteResponse,
@@ -85,7 +93,6 @@ export type {
   RunsGetResponse,
   RunsListResponse,
   RunsRerunResponse,
-  RunsResumeResponse,
   SourceLockfileResponse,
   SourceReleasesResponse,
   SourceRepositoryResponse,

package/src/lib/files.ts

@@ -1,5 +1,5 @@
 /**
- * File-input helpers for `client.workflows.run()` (and agent runs).
+ * File-input helpers for `client.run()`.
  *
  * A workflow input value is treated as a file when it is one of:
  *   - a Node readable stream — `fs.createReadStream('contract.pdf')`
@@ -69,7 +69,7 @@ export type FileInput = Blob | FileDescriptor | NodeReadableStream;
  * a file path or stream.
  *
  * ```ts
- * await client.workflows.run('extract-invoice', {
+ * await client.run('workflows.extract-invoice', {
  *   contract_document: toFile(buffer, 'contract.pdf'),
  * });
  * ```
@@ -188,49 +188,39 @@ async function appendFiles(
 }
 
 /**
- * Build a `multipart/form-data` body matching what `processMultipartRunBody`
- * on the server expects:
+ * JSON-body counterpart of {@link buildRunMultipart}: per-step overrides ride
+ * in the reserved `_overrides` body key.
+ */
+export function buildRunJsonBody(
+  input: Record<string, unknown> | undefined,
+  overrides?: { steps?: Record<string, Record<string, unknown>> }
+): Record<string, unknown> {
+  return overrides ? { ...(input ?? {}), _overrides: overrides } : (input ?? {});
+}
+
+/**
+ * Build multipart for the canonical `client.run(...)` endpoint
+ * (`POST /api/v1/run/{target}`):
  *
- *   - Each file in `input` becomes a top-level form field (key = input name).
- *   - Non-file inputs + overrides + trigger go in a `_json` text field.
+ *   - Each top-level file in `input` becomes a form field (key = input name).
+ *   - Non-file inputs go in the `_json` text field (the input object itself).
+ *   - Per-step overrides go in the reserved `_overrides` text field.
  *
  * Async because stream inputs are drained to bytes here. Only top-level file
  * values are extracted — files nested inside arrays / objects keep their
  * position in the JSON sidecar (the server has no nested-upload path).
  */
-export async function buildMultipart(args: {
+export async function buildRunMultipart(args: {
   input?: Record<string, unknown>;
   overrides?: { steps?: Record<string, Record<string, unknown>> };
-  trigger?: 'api' | 'cli';
 }): Promise<MultipartParts> {
   const fd = new FormData();
   const { scalars, fileCount } = await appendFiles(fd, args.input);
-
-  const sidecar: Record<string, unknown> = {};
-  if (Object.keys(scalars).length > 0) sidecar.input = scalars;
-  if (args.overrides) sidecar.overrides = args.overrides;
-  if (args.trigger) sidecar.trigger = args.trigger;
-  if (Object.keys(sidecar).length > 0) {
-    fd.append('_json', JSON.stringify(sidecar));
-  }
-
-  return { formData: fd, fileCount };
-}
-
-/**
- * Build multipart for agent runs. Agent run endpoints consume `_json` as the
- * input object itself, unlike workflow runs where `_json` is a sidecar with
- * `{ input, overrides, trigger }`.
- */
-export async function buildAgentMultipart(
-  input?: Record<string, unknown>
-): Promise<MultipartParts> {
-  const fd = new FormData();
-  const { scalars, fileCount } = await appendFiles(fd, input);
-
   if (Object.keys(scalars).length > 0) {
     fd.append('_json', JSON.stringify(scalars));
   }
-
+  if (args.overrides) {
+    fd.append('_overrides', JSON.stringify(args.overrides));
+  }
   return { formData: fd, fileCount };
 }

package/src/resources/agents.ts

@@ -7,7 +7,6 @@ import {
   agentsFilesUploadBatch,
   agentsGet,
   agentsList,
-  agentsRun,
   agentsTriggersEmailCreateAlias,
   agentsTriggersEmailDeleteAlias,
   agentsTriggersEmailGet,
@@ -34,10 +33,7 @@ import type {
   ListAgentsResponse,
   PatchAgentBody,
   PatchAgentResponse,
-  RunAgentResponse,
 } from '../generated/types.gen';
-import { buildAgentMultipart, hasFileInput } from '../lib/files';
-import type { WorkflowInput } from './workflows';
 
 type Dispatch = <T>(call: () => Promise<OperationResult<T>>) => Promise<T>;
 
@@ -48,12 +44,6 @@ export interface ListAgentsOptions {
   signal?: AbortSignal;
 }
 
-export interface RunAgentOptions {
-  waitForCompletion?: number;
-  sourceRef?: string;
-  signal?: AbortSignal;
-}
-
 export class AgentEmailTriggersResource {
   constructor(
     private readonly client: Client,
@@ -228,46 +218,4 @@ export class AgentsResource {
       agentsUpdate({ client: this.client, path: { agentId }, body, signal: options.signal })
     );
   }
-
-  async run(
-    agentId: string,
-    input?: WorkflowInput,
-    options: RunAgentOptions = {}
-  ): Promise<RunAgentResponse> {
-    const query = {
-      ...(options.waitForCompletion !== undefined
-        ? { wait_for_completion: options.waitForCompletion }
-        : {}),
-      ...(options.sourceRef !== undefined ? { sourceRef: options.sourceRef } : {}),
-    };
-
-    if (hasFileInput(input)) {
-      const { formData } = await buildAgentMultipart(input);
-      return this.dispatch<RunAgentResponse>(
-        () =>
-          this.client.post({
-            url: '/api/v1/agents/{agentId}/run',
-            path: { agentId },
-            query,
-            body: formData,
-            bodySerializer: null,
-            headers: { 'Content-Type': null },
-            signal: options.signal,
-          }) as Promise<OperationResult<RunAgentResponse>>
-      );
-    }
-
-    return this.dispatch(() =>
-      agentsRun({
-        client: this.client,
-        path: { agentId },
-        query,
-        body: {
-          ...(input !== undefined ? { input } : {}),
-          ...(options.sourceRef !== undefined ? { sourceRef: options.sourceRef } : {}),
-        },
-        signal: options.signal,
-      })
-    );
-  }
 }