Giter Club home page Giter Club logo

claude-unofficial-api's Introduction

demo_sped.mp4

This is a lightweight (isomorphic, 0 dependency) JavaScript library for interacting with the Claude AI chatbot's unofficial internal API. CLI installation, API installation + usage

Psst. It can also code full projects and output valid JSON

Features

  • ๐Ÿ’ฌ Start new conversations

  • ๐Ÿ“Ž Upload files

  • ๐Ÿงช Unit tests included with 85% coverage of code and 100% pass rates!

  • ๐ŸŒŽ Isomorphic (supposing you setup a proxy, cors make me sad)

  • ๐Ÿ”„ Async/await ready with modern syntax

  • ๐Ÿ’พ Get and respond to existing conversations

  • ๐Ÿš€ Upcoming

    • CLI: Retrying responses, Reflexion implementation, prompt templates, auto conversation saving
    • API: Better error handling, automated unit tests, caching layer, searching, setActiveModel, list available models, send message directly to existing conversation, hooks for events, used tokens count (percentage/raw), token estimator, available tokens for model
  • ๐Ÿ’ช Supports all claude models (claude-2, claude-1.3, claude-instant-100k - See --model flag)

Installation

npm install claude-ai

CLI installation

npm install -g claude-cli

Note Run claude --help or see CLI_DOCS.md for more info about the CLI

Usage

First, import the library:

const Claude = require('claude-ai'); 

Initialize a new Claude instance with your session key:

Note Get sessionKey from the sessionKey cookie via the Claude website.

const claude = new Claude({
  sessionKey: 'YOUR_SESSION_KEY' 
});

Start a conversation by calling startConversation() with a prompt message (or get existing conversations via .getConversations()):

const conversation = await claude.startConversation('Hello Claude!');

The Conversation instance exposes methods like sendMessage() to continue the chat:

await conversation.sendMessage('How are you today?');

The full code would look like:

const Claude = require('claude-ai');

const claude = new Claude({
  sessionKey: 'YOUR_SESSION_KEY'
});

const conversation = await claude.startConversation('Hello Claude!');

await conversation.sendMessage('How are you today?');

See the documentation below for the full API reference.

Documentation

Claude

The main class for interfacing with the Claude API.

Constructor:

const claude_instance = new Claude({
  sessionKey: string,
  proxy: string | ({endpoint, options}) => ({endpoint, options})
})
  • If proxy is a function it will be passed the API route to fetch as well as the fetch options which can then be manipulated before running through fetch. If you're feeling adventurous you could also just modify the claude.request functionnn (see source for more info)
  • If proxy is a string, it will simply be prepended before the API endpoint, example: https://claude.ai/

Parameters:

  • sessionKey - Your Claude sessionKey cookie

Methods (on an instance):

  • startConversation(prompt) - Starts a new conversation with the given prompt message
  • getConversations() - Gets recent conversations
  • clearConversations() - Clear all conversations
  • uploadFile(file) - Uploads a file

Conversation

Returned by Claude.startConversation().

Methods:

  • sendMessage(message, options) - Sends a followup message in the conversation
  • getInfo() - Gets the conversation (includes messages, name, created_at, update_at, etc)
  • delete() - Delete the conversation (returns fetch response)

SendMessage Options:

  • timezone - The timezone for completion
  • attachments - Array of file attachments
  • model - The Claude model to use (default: claude-2, other models that I know of include claude-1.3, and claude-instant-100k. Seems to also accept claude-1 but transform it to claude-1.3)
  • done - Callback when completed
  • progress - Progress callback

Contributing

Contributions welcome! This library was created by @Explosion-Scratch on GitHub. Please submit PRs to help improve it.

claude-unofficial-api's People

Contributors

alababdiy avatar aminzibayi avatar explosion-scratch avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.