مستندات API برای توسعه‌دهندگان

URL پایه و احراز هویت

URL پایه HTTPS://api.ollamaapiurl.com/v1 است. احراز هویت با ارسال کلید API منحصر‌به‌فرد خود در هدر Authorization انجام می‌شود. این کلید به عنوان اعتبارنامه شما برای تمام درخواست‌ها عمل می‌کند. آن را بلافاصله پس از ثبت‌نام از داشبورد خود دریافت کنید.

• کلید خود را امن نگه دارید. این کار دسترسی کامل به اعتبار پیش‌پرداخت شما را فراهم می‌کند.
• هر زمان از صفحه تنظیمات یک کلید جدید تولید کنید.

سیستم کلید API ما ساده است. یک کلید فعال برای هر حساب، ردیابی واضح را تضمین می‌کند. اگر دسترسی خود را از دست دادید، آن را بلافاصله بازنشانی کنید. احراز هویت با شماره تلفن مانع ورود شما نمی‌شود.

اولین درخواست

ارسان اولین پرامپت با استفاده از HTTP استاندارد. endpoint ورودی متنی را می‌پذیرد و خروجی متنی برمی‌گرداند. این روش با هر کتابخانه کلاینت HTTP که ترجیح می‌دهید کار می‌کند.

Copycurl https://api.ollamaapiurl.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List all available models in the local library"}]
  }'

پاسخ شامل مصرف توکن است. شما فقط بابت توکن‌های پردازش‌شده پرداخت می‌کنید. خطاها از موجودی پیش‌پرداخت شما کسر نمی‌شوند. این شفافیت به شما اجازه می‌دهد هزینه‌های خود را دقیقاً کنترل کنید.

یکپارچه‌سازی SDK پایتون

از کتابخانه رسمی پایتون OpenAI استفاده کنید. آن را به URL پایه ما متصل کنید. شناسه مدل را روی uncensored تنظیم کنید. این تضمین می‌کند که رفتار بدون سانسور را بدون دردسرهای تنظیم محلی دریافت کنید.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.ollamaapiurl.com/v1", api_key="YOUR_KEY")

resp = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)

کتابخانه تلاش‌های مجدد و قالب‌بندی را مدیریت می‌کند. شما JSON ساختاریافته یا متن خام دریافت می‌کنید. جریان‌دهی (streaming) نیز پشتیبانی می‌شود. این رویکرد کد شما را تمیز و قابل نگهداری نگه می‌دارد.

راه‌اندازی Node SDK

بسته openai را نصب کنید. URL پایه را به سرویس ما تنظیم کنید. کلید API را از محیط خود تنظیم کنید. این پیکربندی شبیه به پیکربندی Python است.

Copyimport OpenAI from "openai";

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

const resp = await client.chat.completions.create({
  model: "uncensored",
  messages: [{ role: "user", content: "Draft a villain monologue for my game." }],
});
console.log(resp.choices[0].message.content);

توسعه‌دهندگان Node رفتار یکسانی دریافت می‌کنند. مدل به پرامپت‌ها بلافاصله پاسخ می‌دهد. می‌توانید این را در هر وب‌سرور یا کارگر پس‌زمینه‌ای یکپارچه کنید. به منطق مسیریابی پیچیده‌ای نیاز نیست.

پاسخ‌های استریم

با تنظیم stream به true، پخش زنده (streaming) را فعال کنید. API قطعات را همان‌طور که تولید می‌شوند برمی‌گرداند. این امر تأخیر ادراکی را برای کاربران کاهش می‌دهد. می‌توانید توکن‌ها را هنگام ظاهر شدن آن‌ها نمایش دهید.

Copystream = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Tell the story in second person."}],
    stream=True,
)
for chunk in stream:
    if chunk.choices and chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="", flush=True)

قطعه نهایی شامل تعداد کل توکن‌ها است. این را برای تأیید صورت‌حساب استفاده کنید. جریان‌دهی با تمام پارامترها کار می‌کند. همچنین از فراخوانی تابع پشتیبانی می‌کند. کاربران شما پیشرفت را به‌صورت بلادرنگ مشاهده می‌کنند.

Limits, errors, and context

پنجره زمینه شما ۱۰۰,۰۰۰ توکن در مجموع پوشش می‌دهد. این شامل هم پرامپت و هم تکمیل می‌شود. می‌توانید تا ۱۶,۰۰۰ توکن در هر درخواست خروجی بگیرید. محدودیت نرخ اجازه ۳۰۰ درخواست در دقیقه را می‌دهد. درخواست‌های همزمان به ۸ درخواست به ازای هر کلید محدود می‌شوند.

خطاهای رایج شامل 401 برای کلیدهای نامعتبر است. خطای 402 به این معنی است که اعتبار پیش‌پرداخت شما تمام شده است. پاسخ 429 نشان می‌دهد که به محدودیت نرخ رسیده‌اید. داشبورد خود را بررسی کنید تا از طریق ارز دیجیتال شارژ کنید. اعتبار‌ها هرگز منقضی نمی‌شوند. اشتباهاتی مانند شارژهای مضاعف از طریق پشتیبانی رفع می‌شوند.