Getting Started

The @palico-ai/client-js is a Javascript library that helps you communicate with your Palico application. This library should primarily be used in secured server-side environments, such as a NodeJS server or a NextJS server runtime.

​

Setup and Installation

To install the Palico Client SDK on your NodeJS project, run the following command:

npm install @palico-ai/client-js

​

Create a Palico Client

npm run palico generate apikey

import { createClient } from "@palico-ai/client-js";

const client = createClient({
  serviceKey: "<your-service-key>",
  apiURL: "http://localhost:8000", // replace with your API URL
});

​

Calling an Agent

Here’s an example of how you can call an agent using the Palico Client SDK:

const response = await client.agent.chat({
  agentName: "chat",
  userMessage: "What is the weather today?",
  payload: {
    location: "San Francisco",
  },
  appConfig: {
    model: "gpt-3.5-turbo",
    provider: "openai",
  },
});

const { conversationId, requestId, message, data, toolCalls } = response;

Learn about the API reference for the chat method here.

​

Stream Response

You can also stream the response from the agent. Here’s an example of how you can stream the response from the agent:

  const response = await client.agent.chat({
    agentName: "chat_stream",
    userMessage: "Hello",
    appConfig: {},
    stream: true,
  });

for await (const chunk of response.readChunks()) {
  // Do something with the chunk
}

You can also get the merged chunks from the stream during or after the stream has completed:

const mergedChunks = await response.getMergedChunks();

​

API Reference

​

chat()

interface ToolCallResult {
  name: string;
  result: any;
}

interface ToolCall {
  id: string;
  name: string;
  parameters?: JSON;
}