@uip/sdk — UIP-AI TypeScript SDK

TypeScript client for the UIP-AI Platform — isomorphic (Node.js + browser).

Install

npm install @uip/sdk

Quick Start

import { UIPClient } from '@uip/sdk';

const client = new UIPClient({
  apiKey: '<your-api-token>',
  baseUrl: 'http://localhost:8000',
});

// Health check
const health = await client.monitoring.health();
console.log(health);

// List workflows
const workflows = await client.workflows.list();

// Deploy a template and submit
const workflow = await client.templates.deploy('demo-hello-world');
const job = await client.jobs.submit(workflow.id);
const result = await job.wait(60);
console.log(result.status);

Resources

| Resource | Description | |----------|-------------| | client.workflows | CRUD for workflow definitions | | client.jobs | Submit, poll, cancel, stream jobs | | client.templates | List and deploy templates | | client.credentials | Store and manage secrets | | client.connectors | Inspect registered connector types | | client.ai | List AI providers and models | | client.monitoring | Platform health and status | | client.manifest | System capabilities and version |

Error Handling

import { UIPClient, NotFoundError, ValidationError } from '@uip/sdk';

try {
  await client.workflows.get('nonexistent');
} catch (err) {
  if (err instanceof NotFoundError) {
    console.log('Not found');
  }
}

Build

npm run build     # tsup → ESM + CJS + .d.ts
npm run test      # vitest

Version Compatibility

SDK reports API_VERSION field matching the platform contract version.