Skip to content
This repository was archived by the owner on Aug 28, 2024. It is now read-only.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Jan.ai API Wrapper for JavaScript

Obsolete

⚠️ Obsolete Notice
This project is now considered obsolete due to changes in the API. For the most up-to-date and official documentation, please refer to the following link: Cortex API Reference.

This repository provides a simple JavaScript wrapper for interacting with the Jan.ai API. The wrapper allows you to make various API requests easily in your JavaScript applications.

Example Usage

const janApi = require('./janApi'); // Replace with the actual file path

// Get a list of available models
const models = await janApi.endpoints.models.Listmodels();
console.log(models);

// Complete a chat interaction
const chatResponse = await janApi.endpoints.chat.CompleteChat();
console.log(chatResponse);

// List available assistants
const assistants = await janApi.chat.assistants.ListAssistants();
console.log(assistants);

// Create a new thread
const newThread = await janApi.chat.threads.CreateThread("New Thread", "jan", "Jan", "Hi, how are you?");
console.log(newThread);

API Endpoints

Models

  • Listmodels: Get a list of available models.
  • GetModel(name): Get details about a specific model.

Chat

  • CompleteChat(name): Get a completion for a chat interaction.

Chat Assistants

  • ListAssistants: Get a list of available assistants.
  • GetAssistant(name): Get details about a specific assistant.

Chat Messages

  • ListMessages(threadID): Get a list of messages in a thread.
  • CreateMessage(threadID, role, message): Create a new message in a thread.
  • RetrieveMessage(threadID, messageID): Get details about a specific message.

Chat Threads

  • CreateThread(title, assistant_id, assistant_name, instructions, model_id, model_settings, model_parameters, model_engine, metadata): Create a new thread.
  • ListThreads: Get a list of available threads.
  • RetrieveThread(threadID): Get details about a specific thread.
  • ModifyThread(threadID, new_title): Modify the title of a thread.
  • DeleteThread(threadID): Delete a thread.

Feel free to adapt the code according to your application's requirements.

About

[DEPRECATED] This repository provides a simple JavaScript wrapper for interacting with the Jan.ai API. The wrapper allows you to make various API requests easily in your JavaScript applications.

Topics

Resources

Security policy

Stars

4 stars

Watchers

1 watching

Forks

Sponsor this project

Used by

Contributors

Languages