Important
Claude seems to have blocked all non-browser traffic to their internal API โ Effectively rendering this project useless. If you have a fix/method to get around this please PR. Sorry โ @Explosion-Scratch
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
-
๐ฌ 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,, hooks for events, used tokens count (percentage/raw), token estimator,setActiveModel
, list available models, send message directly to existing conversationavailable tokens for model
- CLI:
-
๐ช Supports all claude models (
claude-2
,claude-1.3
,claude-instant-100k
- See--model
flag)
npm install claude-ai
npm install -g claude-cli
Note Run
claude --help
or see CLI_DOCS.md for more info about the CLI
First, import the library:
const Claude = require('claude-ai');
Initialize a new Claude instance with your session key:
Note Get
sessionKey
from thesessionKey
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'
});
await claude.init();
const conversation = await claude.startConversation('Hello Claude!');
await conversation.sendMessage('How are you today?');
See the documentation below for the full API reference.
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 ClaudesessionKey
cookie
Methods (on an instance):
startConversation(prompt)
- Starts a new conversation with the given prompt messagegetConversations()
- Gets recent conversationsclearConversations()
- Clear all conversationsuploadFile(file)
- Uploads a file
Returned by Claude.startConversation()
.
Methods:
sendMessage(message, options)
- Sends a followup message in the conversationgetInfo()
- Gets the conversation (includes messages, name, created_at, update_at, etc)delete()
- Delete the conversation (returns fetch response)
SendMessage Options:
timezone
- The timezone for completionattachments
- Array of file attachmentsmodel
- The Claude model to use (default:claude-2
, other models that I know of includeclaude-1.3
, andclaude-instant-100k
. Seems to also acceptclaude-1
but transform it toclaude-1.3
)done
- Callback when completedprogress
- Progress callback
Contributions welcome! This library was created by @Explosion-Scratch on GitHub. Please submit PRs to help improve it.