Reference

import { EigenpalClient } from '@eigenpal/sdk';

const client = new EigenpalClient({ apiKey: process.env.EIGENPAL_API_KEY });

// Small files use multipart; larger files are pre-uploaded automatically.
const result = await client.run(
  'workflows.extract-invoice',
  { contract: file }, // File / Blob / { content, filename, mimeType }
  { waitForCompletion: 60 }
);

console.log(result.finished, result.output);

import { EigenpalClient } from '@eigenpal/sdk';

const client = new EigenpalClient({
  apiKey: process.env.EIGENPAL_API_KEY,
  // For self-hosted deployments:
  baseUrl: process.env.EIGENPAL_BASE_URL,
});

// AuthCheckResponse

// ListAutomationsResponse

// AutomationDetail

await client.automations.move('workflows.extract-invoice', {
  folderPath: 'billing/invoices',
});
await client.automations.move('workflows.extract-invoice', { folderId: null });

// UpdateAutomationRequest

// AutomationDetail

// Workflows archive the automations parent and keep run history.
// Agents remove the agent implementation/history and best-effort-clean storage.
await client.automations.delete('workflows.extract-invoice');

// DeleteAutomationResponse

// Record<string, unknown>

// AutomationTriggersResponse

// ListAutomationVersionsResponse

await client.automations.createVersion('workflows.extract-invoice', {
  yaml: 'name: extract-invoice\n...',
  version: '1.2.0',
  activate: false, // requires an existing current version
});
// Copy without retagging the source snapshot:
await client.automations.createVersion('workflows.extract-invoice', {
  historyId: 'wfh_old',
  version: '1.3.0',
  activate: false,
});

// CreateAutomationVersionRequest

// AutomationVersion

await client.automations.promoteVersion('workflows.extract-invoice', 'wfh_candidate');
// Untagged restore snapshots and unknown ids return 404.

// AutomationVersion

await client.automations.restoreVersion('workflows.extract-invoice', 'wfh_old');
await client.automations.restoreVersion('workflows.extract-invoice', 'wfh_old', {
  message: 'Roll back after failed candidate',
});
// Restore creates a new untagged current snapshot. Send {} when no message is needed.

// RestoreAutomationVersionRequest

// AutomationVersion

// DatasetReviewRequestList

// CreateDatasetReviewRequest

// DatasetReviewDetail

// DatasetReviewDetail

// UpdateDatasetReviewRequest

// DatasetReviewDetail

// DatasetReviewEventList

// DatasetReviewItemList

// UpdateDatasetReviewItem

// DatasetReviewItemResponse

// Blob

// Blob

// DatasetImportResponse

// EvaluatorConfigResponse

// EvaluatorConfigUpdate

// EvaluatorConfigResponse

// DatasetExampleList

// DatasetExampleMutation

// DatasetExample

// DatasetExample

// DatasetExampleUpdate

// DatasetExample

// DatasetExample

// DatasetExampleExpectedFileList

// DatasetExampleExpectedFileUploadResponse

// Blob

// DatasetExampleExpectedFileRenameRequest

// DatasetExampleExpectedFileRenameResponse

// DatasetExampleInputFileList

// DatasetExampleInputFileUploadResponse

// Blob

// DatasetExampleInputFileRenameRequest

// DatasetExampleInputFileRenameResponse

// ExampleRunResponse

// Record<string, unknown>

// ExperimentCreate

// ExperimentCreateResponse

// ExperimentDetail

// ExperimentDetail

// string

// string

// ExperimentCreate

// string

// DatasetReviewInboxList

// ExperimentRef

// RunScoresResponse

// RunReviewHealthResponse

// PromoteRunRequest

// PromoteRunResponse

// RunReviewDetail

// RunReviewRequest

// RunReviewDetail

// RunReviewDetail

// RunReviewExpectedArtifacts

// RunReviewExpectedFileCopyRequest

// RunReviewExpectedFileMutationResponse

// Blob

// RunReviewExpectedFileUpdateRequest

// RunReviewExpectedFileUpdateResponse

const page = await client.emailServers.list({ limit: 20, offset: 0 });
console.log(page.total, page.data[0]?.transport);

// ListEmailServersResponse

const server = await client.emailServers.create({
  name: 'Alerts',
  transport: 'resend',
  apiKey: process.env.RESEND_API_KEY!,
  fromEmail: 'alerts@example.com',
  fromName: 'EigenPal',
});
// Secrets are never returned — look for configuration flags instead.
console.log(server.id, server.apiKeyConfigured);

// CreateEmailServerRequest

// EmailServer

// EmailServer

// UpdateEmailServerRequest

// EmailServer

// DeleteEmailServerResponse

const result = await client.emailServers.test('ems_…', { to: 'ops@example.com' });
if (result.ok) console.log(result.messageId);

// TestEmailServerRequest

// TestEmailServerResponse

// File

// File

// DeleteFileResponse

// CreateFileUploadSessionRequest

// PresignedFileUploadSession | PresignedMultipartFileUploadSession | HttpChunkedFileUploadSession | MultipartFileUploadFallback

// FileUploadSession

// AbortFileUploadResponse

// AcceptHttpChunkedUploadChunkResponse

// File

// ListFileUploadPartsResponse

// PresignFileUploadPartRequest

// PresignFileUploadPartResponse

const folders = await client.folders.list({ type: 'workflow', tree: 'true' });

// ListFoldersResponse

const folder = await client.folders.create({
  name: 'invoices',
  type: 'workflow',
  parentId: 'fldr_…',
});

// CreateFolderRequest

// Folder

// Folder

// UpdateFolderRequest

// Folder

// DeleteFolderResponse

// HumanReviewListResponse

// HumanReviewTaskResponse

// Record<string, unknown>

// HumanReviewApproveResponse

// Record<string, unknown>

// HumanReviewFieldResponse

// Record<string, unknown>

// HumanReviewRejectResponse

// ListModelsResponse

// ParsingReadiness

// RunsListResponse

// RunStartBody

// Run

// Run

// RunArtifactsResponse

// RunCancelResponse

// RunEventsResponse

// Run

// RunStepsResponse

// RunStepDetailResponse

// RunTraceResponse

// RunUsageResponse

// ListTemplatesResponse

await client.templates.create(file, { name: 'Contract' });
await client.templates.createFromFileId('file_abcdefghijklmnopqrstu', { name: 'Contract' });

// TemplateFileReferenceRequest

// CreatedTemplate

// Template

await client.templates.replace('tmpl_…', file);
await client.templates.replaceFromFileId('tmpl_…', 'file_abcdefghijklmnopqrstu');

// TemplateReplaceRequest

// Template

// DeleteTemplateResponse

// Blob