KrosAI Docs
DashboardGet Started
  • Getting Started
    • Introduction
    • Quickstart Guide
    • Authentication
  • OpenAI SDK Compatability
  • Endpoints
    • Completions API
      • Create Chat Completion
    • Translation API
    • Text Summarization API
    • Audio Transcription API
    • Sentiment Analysis API
  • AGENT
    • Agents API
      • Create Agent
      • List Agents
      • Get Agent
      • Update Agent
      • Delete Agent
      • Start Voice Session
    • Conversations API
      • Create Conversation
      • List Conversations
      • Get Conversation
      • Get Conversation Messages
    • Knowledge Base API
      • Create Knowledge Base
      • List Knowledge Base
      • Upload Document
      • List Document
  • Resources
    • AI Voice Agents
    • In-App Voice Assistants
    • Virtual Health Assistants
    • EdTech Language Tutors
  • SDKS
    • Node.JS SDK
    • React Native SDK
    • Flutter
Powered by GitBook
On this page
  • 🚀 Installation
  • 🛠️ Usage
  • 📚 API Reference
  1. SDKS

Node.JS SDK

A Node.js SDK for interacting with the KrosAI Agent APIs.

🚀 Installation

Install via npm:

npm install krosai-node-sdk

or via yarn:

yarn add krosai-node-sdk

🛠️ Usage

Import the SDK:

import { KrosAI } from 'krosai-node-sdk';

Initialize the SDK:

const krosai = new KrosAI({
  apiKey: 'your-api-key',
  // Optional: baseUrl: 'https://api.krosai.com'
});

✨ Basic Operations

1. Create an Agent

const agent = await krosai.createAgent({
  name: 'My Agent',
  description: 'A helpful assistant',
});

2. Create a Conversation

const conversation = await krosai.createConversation({
  agentId: agent.id,
});

3. Send a Message

const message = await krosai.sendMessage({
  conversationId: conversation.id,
  content: 'Hello, how can you help me?',
});

4. Get Conversation Messages

const messages = await krosai.getConversationMessages(conversation.id);

5. Create a Knowledge Base

const knowledgeBase = await krosai.createKnowledgeBase({
  name: 'My Knowledge Base',
  description: 'Contains important information',
});

6. Upload a Document to Knowledge Base

const document = await krosai.uploadDocument({
  knowledgeBaseId: knowledgeBase.id,
  file: Buffer.from('document content'),
  fileName: 'example.txt',
});

📚 API Reference

🧠 Agents

Method
Description

createAgent(request: CreateAgentRequest): Promise<Agent>

Create a new agent.

listAgents(): Promise<Agent[]>

List all agents.

getAgent(agentId: string): Promise<Agent>

Retrieve details of a specific agent.

updateAgent(agentId: string, request: UpdateAgentRequest): Promise<Agent>

Update an existing agent.

deleteAgent(agentId: string): Promise<void>

Delete an agent.


💬 Conversations

Method
Description

createConversation(request: CreateConversationRequest): Promise<Conversation>

Create a new conversation for an agent.

listConversations(agentId: string): Promise<Conversation[]>

List all conversations for a specific agent.

getConversation(conversationId: string): Promise<Conversation>

Retrieve details of a conversation.

getConversationMessages(conversationId: string): Promise<Message[]>

Get all messages within a conversation.

sendMessage(request: SendMessageRequest): Promise<Message>

Send a new message in a conversation.


📚 Knowledge Bases

Method
Description

createKnowledgeBase(request: CreateKnowledgeBaseRequest): Promise<KnowledgeBase>

Create a new knowledge base.

listKnowledgeBases(): Promise<KnowledgeBase[]>

List all knowledge bases.

uploadDocument(request: UploadDocumentRequest): Promise<Document>

Upload a document to a knowledge base.

listDocuments(knowledgeBaseId: string): Promise<Document[]>

List all documents in a specific knowledge base.

PreviousEdTech Language TutorsNextReact Native SDK

Last updated 1 month ago