快速開始

幾分鐘內快速上手 LensOS。

選擇你的框架查看對應的設定指南：

1. 安裝 SDK

Terminal

bun add @lens-os/sdk

2. 取得 API Key

你需要 LensOS API 金鑰和 OpenAI API 金鑰。前往儀表板建立 LensOS 金鑰：

開啟 API Keys 管理頁面 →

.env

# 僅限伺服器端 — 絕對不要使用 NEXT_PUBLIC_ 前綴
LENS_OS_API_KEY=your-lens-api-key
LENS_MODEL_API_KEY=your-openai-api-key

3. 建立伺服器路由

Agent handler 在伺服器端運行。API 金鑰保留在這裡，永遠不會暴露給客戶端。

src/app/api/lens/agent/chat/route.ts

import { createAgentHandler } from '@lens-os/sdk/server';

const handler = createAgentHandler({
  apiKey: process.env.LENS_OS_API_KEY!,
  openaiKey: process.env.LENS_MODEL_API_KEY!,
});

export const { POST } = handler;

4. 建立前端元件

客戶端只需要端點 URL — 不需要 API 金鑰。

src/components/ChatPanel.tsx

'use client';
import { useLensAgent } from '@lens-os/sdk/react';

export default function ChatPanel() {
  const { messages, isLoading, sendMessage } = useLensAgent({
    endpoint: '/api/lens/agent/chat',
  });

  return (
    <div>
      {messages.map((msg, i) => (
        <div key={i} className={msg.role}>
          {typeof msg.content === 'string' ? msg.content : ''}
        </div>
      ))}
      <input
        disabled={isLoading}
        onKeyDown={(e) => {
          if (e.key === 'Enter' && e.currentTarget.value.trim()) {
            sendMessage(e.currentTarget.value);
            e.currentTarget.value = '';
          }
        }}
        placeholder="問我任何問題..."
      />
    </div>
  );
}

Tip

就這樣 — 只需 3 個檔案就能運行 AI Agent。API 金鑰保留在伺服器端，客戶端僅透過端點 URL 通訊。

驗證安裝

建立一個簡單的測試檔案，確認 SDK 安裝正確：

test-lens.ts

import { LensClient } from "@lens-os/sdk";

const client = new LensClient({
  apiKey: process.env.LENS_OS_API_KEY!,
});

async function test() {
  try {
    const config = await client.getConfig();
    console.log("✅ SDK 安裝成功");
    console.log("Rules 數量:", config.rules?.length || 0);
  } catch (error) {
    console.error("❌ 錯誤:", error);
  }
}

test();

Terminal

bun test-lens.ts

Tip

如果看到「✅ SDK 安裝成功」，表示安裝完成，可以繼續下一步！

下一步

創建 Widget 元件

將 AI 嵌入你的前端應用程式。

建立企業規則

設定規則，控制代理的行為與限制。

建立企業工具

新增自訂工具，擴展代理功能。

建立企業知識體系

建立知識庫，用於特定領域的資料存取。