ttc-ai-chat-sdk 1.2.2 → 1.3.0

package/README.md

@@ -173,6 +173,144 @@ const models = await assistant.getModels();
 await assistant.selectModel("model-id", "llm"); // type: 'llm' | 'stt' | 'tts'
 ```
 
+## Assistant API (Server-Side)
+
+The `AssistantAPI` allows you to manage assistants from your backend. Use it to create assistants, generate tokens, and manage assistant metadata.
+
+### Initialize the Assistant API
+
+```typescript
+import { ttc } from "ttc-ai-chat-sdk";
+
+const apiKey = "your-api-key";
+const assistantAPI = ttc.assistantAPI(apiKey);
+```
+
+### Create an Assistant
+
+Create a new assistant for a user and get a chat token for the frontend:
+
+```typescript
+const result = await assistantAPI.create(
+  "My Assistant",           // name
+  "user-unique-id-123",     // cuid (custom user ID)
+  {
+    backstory: "You are a helpful shopping assistant",
+    emote: "friendly",
+    traits: "helpful, knowledgeable",
+    metadata: { theme: "dark" }
+  }
+);
+
+if (result.status === "success") {
+  const { chatId, token } = result.data;
+  // Send token to frontend
+}
+```
+
+### Generate a New Token
+
+Generate a fresh token for an existing assistant:
+
+```typescript
+const result = await assistantAPI.generateToken(
+  "user-unique-id-123",  // cuid
+  "30d"                  // expiry duration
+);
+
+if (result.status === "success") {
+  const { token } = result.data;
+}
+```
+
+### Validate a Token
+
+Check if a token is still valid:
+
+```typescript
+const result = await assistantAPI.validateToken(token);
+
+if (result.status === "success") {
+  // result.data.status: 'valid' | 'expired' | 'error' | 'notFound'
+  console.log("Token status:", result.data.status);
+}
+```
+
+### Fetch Assistants
+
+Get a list of all assistants or fetch a specific one:
+
+```typescript
+// Fetch all assistants (paginated)
+const list = await assistantAPI.fetchMany(1, 10, {});
+
+// Fetch a specific assistant by ID or cuid
+const assistant = await assistantAPI.fetch({ cuid: "user-unique-id-123" });
+// or
+const assistant = await assistantAPI.fetch({ id: "assistant-id" });
+```
+
+### Update an Assistant
+
+Update assistant metadata or persona:
+
+```typescript
+await assistantAPI.update("assistant-id", {
+  name: "Updated Name",
+  backstory: "New backstory",
+  metadata: { theme: "light" }
+});
+```
+
+### Delete an Assistant
+
+```typescript
+await assistantAPI.delete("assistant-id");
+```
+
+### Express Integration (Auth Server)
+
+For seamless token management, you can integrate with Express to automatically handle token creation and validation:
+
+```typescript
+import express from "express";
+import { ttc } from "ttc-ai-chat-sdk";
+
+const app = express();
+
+ttc.assistantAPI("your-api-key", {
+  express: app,
+  endpoint: "/ttc-auth",
+  userData: async (req) => {
+    // Extract user info from your auth system
+    const user = await getUserFromRequest(req);
+    return {
+      cuid: user.id,
+      name: user.name,
+      option: {
+        backstory: "Helpful assistant for " + user.name,
+        metadata: { userId: user.id }
+      }
+    };
+  }
+});
+
+app.listen(3000);
+```
+
+Then on the frontend, initialize the assistant with the auth URL:
+
+```typescript
+const assistant = await ttc.assistant({
+  modules: [MyAppModule],
+  url: "http://localhost:3000/ttc-auth",
+  tokenCb: async () => {
+    // Return your platform's auth token
+    return localStorage.getItem("authToken");
+  }
+});
+```
+
 ## Full Documentation
 
 For complete API reference, all available methods, and advanced configuration, check out the full SDK documentation.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ttc-ai-chat-sdk",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "description": "TypeScript client sdk for TTC AI services with decorators and schema validation.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",