HI ▾
API कुंजी पाएँ

JS में Character AI API: Node और वेब ऐप सेटअप

एक Character AI API JS सेटअप आधिकारिक openai npm पैकेज, एक बेस URL और एक सर्वर रूट पर आधारित होता है जो आपकी कुंजी को ब्राउज़र से दूर रखता है। यह पेज Node कोड, एक स्ट्रीमिंग Express एंडपॉइंट और उसके साथ जाने वाले फ्रंट-एंड fetch दिखाता है।

ब्राउज़र पैनल को चमकदार पाइप द्वारा सर्वर क्यूब से लिंक किया गया है जिसमें चैट बबल्स हैं, JS प्रॉक्सी डिज़ाइन दिखाते हुए

मुख्य बिंदु

  1. openai npm पैकेज अपरिवर्तित काम करता है: baseURL, apiKey और मॉडल को uncensored में बदलें।
  2. कुंजी को ब्राउज़र कोड में कभी न भेजें। इसके बजाय एक छोटे सर्वर राउट को कॉल करें।
  3. स्ट्रीमिंग सर्वर-सेंट इवेंट्स का उपयोग करती है, और एक ओपन स्ट्रीम एक कन्करेंसी स्लॉट का उपयोग करती है।
  4. यदि आप कोई डिपेंडेंसी नहीं जोड़ना चाहते, तो साधारण fetch भी काम करता है।

संक्षिप्त संस्करण

आप JavaScript से एंडपॉइंट तक तीन तरीकों से पहुँच सकते हैं: openai npm पैकेज, साधारण fetch, या कोई भी लाइब्रेरी जो पहले से OpenAI चैट फॉर्मेट को समझती हो। बेस URL https://api.characteraiapi.com/v1 है, मॉडल ID uncensored है, और हर अनुरोध Authorization: Bearer <key> ले जाता है। यदि आपके पास अभी तक कोई कुंजी नहीं है, तो API कुंजी पेज साइन-अप और $0.50 के वन-क्लिक ट्रायल की व्याख्या करता है।

यह एक स्वतंत्र सेवा है, Character.ai उत्पाद नहीं। यह एक ओपन-वेट मॉडल चलाता है जिसे वयस्कों द्वारा कानूनी उपयोग के लिए बिना सामग्री अस्वीकृति के उत्तर देने के लिए ट्यून किया गया है, और यह छवियाँ, ऑडियो या वीडियो उत्पन्न नहीं करता है। एक कैरेक्टर ऐप के लिए यह पर्याप्त है: आप पर्सोना लिखते हैं, बातचीत को संग्रहीत करते हैं और यह तय करते हैं कि यह कैसा दिखना चाहिए।

openai पैकेज के साथ Node

एक प्रोजेक्ट बनाएं, पैकेज इंस्टॉल करें और ES मॉड्यूल का उपयोग करें। उदाहरण Node 18 या नए संस्करण की मानते हैं।

mkdir persona-chat && cd persona-chat
npm init -y
npm pkg set type=module
npm install openai express
export API_KEY="paste-your-key-here"

chat.js में एक पहला स्क्रिप्ट:

import OpenAI from "openai";

const client = new OpenAI({
  baseURL: "https://api.characteraiapi.com/v1",
  apiKey: process.env.API_KEY,
});

const completion = await client.chat.completions.create({
  model: "uncensored",
  messages: [
    { role: "system", content: "You are Juno, a sarcastic lighthouse keeper. Stay in character." },
    { role: "user", content: "A boat is signalling in the fog. Thoughts?" },
  ],
  temperature: 0.9,
});

console.log(completion.choices[0].message.content);
console.log(completion.usage);

इसे node chat.js के साथ चलाएं। उपयोग ऑब्जेक्ट आपको बताता है कि कॉल में कितने प्रॉम्प्ट और कंप्लीशन टोकन का उपयोग हुआ, जिसे आप प्रति मिलियन $0.15 और $0.50 से गुणा करके सटीक कीमत देख सकते हैं।

कुंजी को ब्राउज़र कोड में कभी न रखें

कुंजी को एक React कंपोनेंट में पेस्ट करना और पेज से API को कॉल करना आकर्षक लग सकता है। ऐसा न करें। हर विज़िटर नेटवर्क टैब या बंडल किए गए स्रोत को खोलकर उसे कॉपी कर सकता है, और फिर आपके बैलेंस को खर्च कर सकता है। समाधान एक पतला प्रॉक्सी है जो एक सर्वर पर होना चाहिए जिसे आप नियंत्रित करते हैं। ब्राउज़र आपके राउट पर उपयोगकर्ता का संदेश भेजता है; आपका राउट पूरा संदेश सूची बनाता है, कुंजी जोड़ता है और कॉल आगे बढ़ाता है।

इससे आपको उन चीज़ों को लागू करने की जगह मिलती है जिनके बारे में API को नहीं पता: एक पर्सोना जिसे उपयोगकर्ता ओवरराइड नहीं कर सकते, प्रति-उपयोगकर्ता संदेश सीमा, और लंबे इतिहास को ट्रिम करना। एक ब्राउज़र को केवल नया उपयोगकर्ता पाठ और एक कन्वर्सेशन ID भेजना चाहिए, न कि सिस्टम प्रॉम्प्ट।

एक स्ट्रीमिंग Express एंडपॉइंट

यहाँ एक छोटा सर्वर है जिसका एक राउट है। डेमो के लिए यह सत्रों को मेमोरी में रखता है; किसी भी वास्तविक उपयोग के लिए डेटाबेस का उपयोग करें।

import express from "express";
import OpenAI from "openai";

const client = new OpenAI({
  baseURL: "https://api.characteraiapi.com/v1",
  apiKey: process.env.API_KEY,
});

const PERSONA = "You are Juno, a sarcastic lighthouse keeper. Stay in character, two to four sentences.";
const sessions = new Map();

const app = express();
app.use(express.json({ limit: "100kb" }));
app.use(express.static("public"));

app.post("/api/chat", async (req, res) => {
  const { id, text } = req.body;
  if (!id || !text) return res.status(400).json({ error: "id and text required" });

  const history = sessions.get(id) ?? [{ role: "system", content: PERSONA }];
  history.push({ role: "user", content: text });

  res.setHeader("Content-Type", "text/plain; charset=utf-8");

  try {
    const stream = await client.chat.completions.create({
      model: "uncensored",
      messages: [history[0], ...history.slice(-20)],
      stream: true,
    });
    let reply = "";
    for await (const chunk of stream) {
      const piece = chunk.choices[0]?.delta?.content ?? "";
      if (piece) {
        reply += piece;
        res.write(piece);
      }
    }
    history.push({ role: "assistant", content: reply });
    sessions.set(id, history);
    res.end();
  } catch (err) {
    res.status(err.status === 429 ? 429 : 500).end("error");
  }
});

app.listen(3000);

सलाइस सिस्टम संदेश और पिछले 20 संदेशों को बनाए रखता है। पुराने संवाद हट जाते हैं, जिससे लागत स्थिर रहती है। प्रत्येक चंक के केवल सादे पाठ को भेजने से ब्राउज़र पक्ष सरल रहता है। यदि आप समृद्ध इवेंट्स चाहते हैं, तो सर्वर-सेंट इवेंट्स भेजें और उन्हें क्लाइंट पर पार्स करें।

अधिक समृद्ध स्ट्रीमिंग के लिए सर्वर-सेंट इवेंट्स

सादा पाठ भेजना एक डेमो के लिए काम कर सकता है, लेकिन वास्तविक चैट इंटरफ़ेस को आमतौर पर पाठ से अधिक की आवश्यकता होती है: एक संकेत जब रिप्लाई पूरी हो जाए, स्ट्रीम के बीच में एक त्रुटि संदेश, या अंत में टोकन उपयोग। सर्वर-सेंट इवेंट्स आपको उसी HTTP कनेक्शन पर नामित संदेश देते हैं। आपका राउट SSE फॉर्मेट में लाइनें लिखता है, और ब्राउज़र एक छोटे पार्सर के साथ उन्हें पढ़ता है।

// server: inside the route, after setting headers
res.setHeader("Content-Type", "text/event-stream");
res.setHeader("Cache-Control", "no-cache");

for await (const chunk of stream) {
  const piece = chunk.choices[0]?.delta?.content ?? "";
  if (piece) res.write(`data: ${JSON.stringify({ token: piece })}\n\n`);
}
res.write(`data: ${JSON.stringify({ done: true })}\n\n`);
res.end();

प्रत्येक टोकन को JSON के रूप में एन्कोड करने से एक क्लासिक बग से बचा जाता है: एक टोकन जिसमें लाइन ब्रेक होता है, वह अन्यथा SSE फ्रेमिंग को तोड़ देता। क्लाइंट पर, रिस्पॉन्स बॉडी पढ़ें, एक खाली लाइन पर स्प्लिट करें, data: प्रीफिक्स हटाएं और JSON पार्स करें। done संदेश इंटरफ़ेस को इनपुट बॉक्स को फिर से सक्षम करने और भेजने के बटन को फिर से सक्षम करने का संकेत देता है।

डिस्कनेक्ट्स को हैंडल करें। जब उपयोगकर्ता टैब बंद करता है, तो सर्वर पर रिस्पॉन्स ऑब्जेक्ट एक close इवेंट उत्पन्न करता है। इसे सुनें और अपस्ट्रीम अनुरोध को रद्द करें, अन्यथा आपका सर्वर उन टोकन को खींचता रहेगा जिन्हें कोई नहीं पढ़ रहा है, और स्ट्रीम आपके कन्करेंसी स्लॉट में से एक को व्यस्त रखेगी। इस उद्देश्य के लिए OpenAI SDK अनुरोध विकल्पों में एक AbortSignal स्वीकार करता है।

ब्राउज़र पक्ष

फ्रंट एंड अपने राउट को कॉल करता है, API होस्ट को नहीं। fetch के साथ एक स्ट्रीम किए गए रिस्पॉन्स को पढ़ने में कुछ लाइनें लगती हैं:

const id = crypto.randomUUID();

async function send(text, onToken) {
  const res = await fetch("/api/chat", {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({ id, text }),
  });
  if (!res.ok) throw new Error("request failed: " + res.status);

  const reader = res.body.getReader();
  const decoder = new TextDecoder();
  while (true) {
    const { done, value } = await reader.read();
    if (done) break;
    onToken(decoder.decode(value, { stream: true }));
  }
}

send("Is the lamp lit?", (t) => { document.querySelector("#out").textContent += t; });

जब तक रिप्लाई स्ट्रीम हो रही हो, भेजने के बटन को अक्षम करें। यह डबल सबमिट से बचाता है और कन्करेंसी सीमा का सम्मान करता है, क्योंकि एक स्ट्रीम किए गए अनुरोध को समाप्त होने तक अपना स्लॉट घेरे रखना पड़ता है।

सत्रों को उचित रूप से संग्रहीत करें

मेमोरी-आधारित मैप प्रक्रिया के पुनरारंभ होने पर सब कुछ खो देता है और जैसे ही आप दो सर्वर इंस्टेंस चलाते हैं, यह टूट जाता है। जैसे ही प्रोटोटाइप काम कर ले, सत्रों को एक डेटाबेस या की-वैल्यू स्टोर में स्थानांतरित करें। संदेश सूची को JSON कॉलम के रूप में संग्रहीत करें, जिसकी कुंजी उपयोगकर्ता और पात्र के अनुसार हो। जब एक अनुरोध आता है, तो सूची लोड करें, नया उपयोगकर्ता संदेश जोड़ें, API को कॉल करें, प्रतिक्रिया जोड़ें और सूची को वापस लिखें।

शुरुआत में यह तय करें कि सिस्टम प्रॉम्प्ट का मालिक कौन है। इसे अपने कोड या कॉन्फ़िगरेशन में रखें, न कि उस संग्रहीत सूची में जिसे ब्राउज़र प्रभावित कर सकता है। यदि पर्सोना इतिहास के साथ संग्रहीत है, तो एक उपयोगकर्ता एक अनुरोध बनाकर उसे ओवरराइट करने का प्रयास कर सकता है। सर्वर पर हर बार संदेश ऐरे को पुनर्निर्मित करें: कॉन्फ़िगरेशन से सिस्टम संदेश, उसके बाद संग्रहीत टर्न।

प्रति-उपयोगकर्ता सीमा भी सेट करें। बिना किसी सीमा वाले एक सार्वजनिक चैट विजेट स्क्रिप्टेड दुरुपयोग को आमंत्रित करता है, और हर टोकन के लिए आपको बिल किया जाता है। प्रति उपयोगकर्ता प्रति घंटे एक काउंटर, जो API कॉल से पहले जाँचा जाता है, शुरुआत करने के लिए पर्याप्त है। इसे संदेश लंबाई की एक ऊपरी सीमा के साथ जोड़ें ताकि एक अनुरोध एक मेगाबाइट टेक्स्ट न भेज सके। API 8 MB तक के बॉडी स्वीकार करता है, लेकिन आपकी अपनी सीमा बहुत कम होनी चाहिए, जैसे कि प्रति उपयोगकर्ता संदेश के लिए 4,000 वर्ण।

साधारण fetch, टूल्स और JSON मोड

यदि आप कोई निर्भरता नहीं चाहते, तो एक कच्चा कॉल उसी तरह काम करता है। इसे सर्वर, वर्कर या स्क्रिप्ट से चलाएं, सार्वजनिक पेज कोड से नहीं।

const r = await fetch("https://api.characteraiapi.com/v1/chat/completions", {
  method: "POST",
  headers: {
    "Authorization": "Bearer " + process.env.API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    model: "uncensored",
    response_format: { type: "json_object" },
    messages: [
      { role: "system", content: "Reply with JSON only: {\"mood\": string, \"line\": string}" },
      { role: "user", content: "Juno sees a light on the water." },
    ],
  }),
});
const data = await r.json();
console.log(JSON.parse(data.choices[0].message.content));

टूल कॉलिंग उसी tools और tool_choice फ़ील्ड के साथ काम करता है जो SDK भेजता है। जब मॉडल tool_calls लौटाता है, तो फ़ंक्शन चलाएं और आउटपुट को role: "tool" और मिलते-जुलते tool_call_id के साथ एक संदेश के रूप में वापस भेजें। एक गेम में यह पासा फेंकना, इन्वेंटरी लुकअप या उस पात्र के बारे में यादों की जाँच के लिए उपयोगी है। स्ट्रीमिंग के दौरान, टूल कॉल आंशिक टुकड़ों के रूप में आते हैं जिन्हें तर्कों को पार्स करने से पहले जोड़ना होता है।

होस्टिंग, सीमाएँ और लागत

स्ट्रीमिंग में कुछ डिप्लॉयमेंट विवरण होते हैं जो सादे JSON रूट्स में नहीं होते। कुछ होस्टिंग प्लेटफ़ॉर्म और प्रॉक्सी प्रतिक्रियाओं को बफ़र करते हैं या यह सीमित करते हैं कि एक अनुरोध कितनी देर तक खुला रह सकता है। यदि टोकन अंत में एक साथ आते हैं, तो एक बफ़रिंग परत आपके सर्वर और ब्राउज़र के बीच होती है। अपने प्लेटफ़ॉर्म का दस्तावेज़ीकरण जाँचें उस विकल्प के लिए जो एक रूट के लिए बफ़रिंग को अक्षम करता है, और फ़ंक्शन निष्पादन के लिए किसी भी समय सीमा के लिए, क्योंकि एक लंबी रोलप्ले प्रतिक्रिया कई सेकंड तक चल सकती है।

nginx जैसे एक रिवर्स प्रॉक्सी के लिए, प्रतिक्रिया बफ़रिंग एक आम कारण है और स्थान के आधार पर इसे बंद करने की एक सेटिंग होती है। सर्वरलेस फ़ंक्शंस के लिए, प्लेटफ़ॉर्म दस्तावेज़ों में स्ट्रीमिंग प्रतिक्रिया मोड खोजें। यदि आपका होस्ट स्ट्रीम नहीं कर सकता, तो एक सस्ते सर्वर पर एक छोटा हमेशा-चालू Node प्रोसेस एक विश्वसनीय फॉलबैक है।

अंत में, सीक्रेट को होस्ट के एन्वायरमेंट वेरिएबल स्टोर में डालें और इसे बिल्ड आउटपुट से बाहर रखें। फ्रंट-एंड बिल्ड टूल्स अक्सर किसी भी वेरिएबल को ब्राउज़र बंडल में इन्लाइन कर देते हैं जिसमें एक सार्वजनिक प्रीफ़िक्स होता है, इसलिए उस प्रीफ़िक्स के बिना एक नाम का उपयोग करें, और इसे केवल सर्वर कोड में पढ़ें। एक तेज़ जाँच यह है कि आपकी कुंजी के पहले कुछ अक्षरों के लिए अपने बिल्ड फ़ाइलों में खोजें।

सीमाएँ, पुनः प्रयास और लागत

एक पूर्ण कुंजी 8 समानांतर अनुरोधों और प्रति मिनट 300 की अनुमति देती है। एक ट्रायल कुंजी 2 और 60 की अनुमति देती है। एक सीमा से अधिक होने पर API HTTP 429 के साथ जवाब देता है और कोड rate_limited या concurrency। एक अस्थायी ओवरलोड भी एक 429 है और Retry-After: 5 शामिल करता है। जावास्क्रिप्ट में SDK एक त्रुटि फेंकता है जिसमें status === 429 होता है; इसे पकड़ें, प्रतीक्षा करें और फिर से प्रयास करें। SDK डिफ़ॉल्ट रूप से कुछ बार फिर से प्रयास भी करता है, जिसे आप क्लाइंट पर maxRetries विकल्प के साथ ट्यून कर सकते हैं।

प्रति टर्न लागत का अनुमान लगाना आसान है। 2,000 इनपुट टोकन और 250 आउटपुट टोकन वाले चैट की लागत इनपुट के लिए 2,000 x $0.15 / 1,000,000 = $0.0003 और आउटपुट के लिए 250 x $0.50 / 1,000,000 = $0.000125 होती है, यानी कुल $0.000425। एक हज़ार टर्न की लागत $0.425 है। विफल या अस्वीकृत अनुरोधों के लिए चार्ज नहीं किया जाता। $20 से $500 तक टॉप-अप और बोनस टियर के लिए मूल्य निर्धारण पृष्ठ देखें, और पूर्ण पैरामीटर सूची के लिए दस्तावेज़ देखें।

प्रश्न और उत्तर

क्या मैं API को सीधे एक React या Vue ऐप से कॉल कर सकता हूँ?

तकनीकी रूप से हाँ, लेकिन कुंजी हर आगंतुक के लिए दिखाई देगी। एक छोटे सर्वर रूट का उपयोग करें जो कुंजी जोड़ता है और अनुरोध को आगे बढ़ाता है।

मुझे किस npm पैकेज का उपयोग करना चाहिए?

आधिकारिक openai पैकेज काम करता है। baseURL को एंडपॉइंट पर सेट करें, apiKey के रूप में अपनी कुंजी का उपयोग करें और मॉडल uncensored। साधारण fetch भी ठीक है।

क्या यह Deno, Bun या Cloudflare Workers पर चलता है?

कोई भी रनटाइम जो Bearer हेडर के साथ एक HTTPS अनुरोध कर सकता है, उसे कॉल कर सकता है। openai पैकेज कई रनटाइम का समर्थन करता है, इसलिए अपने लिए इसके दस्तावेज़ जाँचें।

मैं पेज पर टोकन कैसे स्ट्रीम करूं?

सर्वर पर stream: true सेट करें, प्रत्येक चंक को ब्राउज़र को आगे बढ़ाएं और fetch रीडर के साथ इसे पढ़ें। प्रत्येक खुला स्ट्रीम एक कॉन्करेंसी स्लॉट पकड़े रखता है।

क्या यह Character.ai का आधिकारिक API है?

नहीं। यह एक स्वतंत्र OpenAI-संगत सेवा है जिसकी अपनी कुंजी और एक मॉडल है, जो आपके अपने पात्र ऐप्स के लिए एक बैकएंड के रूप में प्रदान की जाती है।

आपकी कुंजी बस एक फ़ॉर्म दूर है

एक खाता बनाएँ, कुंजी कॉपी करें, बेस URL बदलें। सेटअप यही है।

API कुंजी पाएँ