چطور کلید API بگیرم؟

در Cruxy ثبتنام کنید و با جریان ورود دستگاه که در شروع سریع شرح داده شده یک کلید بسازید: یک کد دستگاه بخواهید، آن را در مرورگر تأیید کنید و برای کلید poll کنید. کلیدهای API از همان حساب اپ میآیند، و API به ازای هر توکن، جدا از طرح شما، صورتحساب میشود.

کدام مدل را بفرستم؟

auto بفرستید، مگر دلیلی برای نفرستادن داشته باشید. Mira اندازه سریع برای فراخوانیهای کوتاه و پرحجم است، Vaani پیشفرض متوازن است، و Kavi اندازه عمیق برای سختترین کارها. مدل پشت یک اندازه میتواند تغییر کند؛ شناسه اندازه قرارداد است.

هر کلاینت OpenAI برای chat completions و models کار میکند، به هر زبانی که از قبل استفاده میکنید. برای مسیرهای خود Cruxy، مستندات درخواست را در curl و TypeScript با fetch نشان میدهند.

دادههای من برای آموزش استفاده میشود؟

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

توسعه‌دهندگان

آینده را بسازید.

Q: API با OpenAI سازگار است؟

بله، برای چت و فهرست مدلها. https://api.cruxy.ai/v1 مسیرهای /v1/chat/completions و /v1/models را در قالبهای OpenAI ارائه میکند، پس کلاینتها و چارچوبهای ارزیابی فعلی با تغییر base URL و کلید کار میکنند. بقیه API، از فایلها تا evals، مخصوص Cruxy است و زیر /api/v1 قرار دارد.

یک base URL، یک کلید و سه اندازه مدل پشت آن. یک API سازگار با OpenAI برای چت، مسیرهای خود Cruxy وقتی حافظه، مخزن‌ها، فایل‌ها و evals می‌خواهید، و یک CLI که در ریپازیتوری شما کار می‌کند.

رایگان شروع کنید شروع سریع را بخوانید

import OpenAI from 'openai';

const cruxy = new OpenAI({
  baseURL: 'https://api.cruxy.ai/v1',
  apiKey: process.env.CRUXY_API_KEY,
});

const res = await cruxy.chat.completions.create({
  model: 'auto',
  messages: [{ role: 'user', content: 'Summarize this ticket' }],
});

import os
from openai import OpenAI

cruxy = OpenAI(
    base_url="https://api.cruxy.ai/v1",
    api_key=os.environ["CRUXY_API_KEY"],
)

res = cruxy.chat.completions.create(
    model="auto",
    messages=[{"role": "user", "content": "Summarize this ticket"}],
)

curl https://api.cruxy.ai/v1/chat/completions \
  -H "Authorization: Bearer $CRUXY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "auto",
       "messages": [{"role": "user",
                     "content": "Summarize this ticket"}]}'

Response · chat.completion

{
  "id": "chatcmpl-8f3a1c2d",
  "object": "chat.completion",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Checkout fails on UPI when the cart
          holds a gift card. Steps to reproduce and
          a fix are below."
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 212,
    "completion_tokens": 96,
    "total_tokens": 308
  }
}

درخواست واقعی است. پاسخ نمونه‌ای است و به شکل کلی‌اش کوتاه شده.

Base URL: api.cruxy.ai/v1
مدل‌ها: kavi · vaani · mira · auto
استریم: SSE به سبک OpenAI، با [DONE] تمام می‌شود
خطاها: یک کد ثابت روی هر یک

پلتفرم

هر چیزی که می‌توانید روی آن بسازید. همه فعال، همه مستند.

Chat APIفعالchat completions سازگار با OpenAI روی سه اندازه مدل. استریم، فراخوانی ابزار و reasoning_effort که برای هر درخواست تنظیم می‌کنید.راهنمای چت Cruxy Codeفعالیک ایجنت کدنویسی برای ترمینال شما. کدبیس شما را می‌خواند، فایل‌ها را با یک diff پیش از هر تأیید ویرایش می‌کند، تست‌های شما را اجرا می‌کند و pull request باز می‌کند.Cruxy Code را بشناسید Evals APIفعالمجموعه‌هایی از موردهایی که تعریف می‌کنید، اجراهایی که شروع می‌کنید، نتایجی که بازمی‌خوانید. یک چارچوب ارزیابی را به مسیرهای سازگار با OpenAI وصل کنید، یا مسیرهای evals را مستقیم استفاده کنید.مرجع API امبدینگ، rerank و نظارتفعالcruxy-embed متن را به بردار تبدیل می‌کند، cruxy-rerank نامزدها را در برابر یک پرس‌وجو مرتب می‌کند، و cruxy-guard متن را در برابر دسته‌های ایمنی محتوا دسته‌بندی می‌کند.کوک‌بوک مستنداتفعالیک شروع سریع، راهنمایی برای هر مسیر، کوک‌بوکی با بازیابی، حلقه‌های ابزار و استریم در مرورگر، و مرجع کامل API.مستندات را بخوانید وضعیتفعالپایش‌های زنده و رخدادها، روی دامنه خودشان، تا پیش از بررسی کد خودتان ما را بررسی کنید.وضعیت را ببینید

چت

دو مسیر، یک مجموعه مدل. از آن یکی استفاده کنید که کلاینت شما از قبل می‌شناسد.

راهنمای چت

POST /v1/chat/completions

سازگار با OpenAI

هر کلاینت OpenAI یا چارچوب ارزیابی را با کلید Cruxy خود به https://api.cruxy.ai/v1 وصل کنید. آبجکت‌های استاندارد chat.completion، SSE به سبک OpenAI و قالب خطای OpenAI، با یک کد ثابت Cruxy درون آن.

temperature، top_p، max_tokens و reasoning_effort رعایت می‌شوند
فیلدهایی که گیت‌وی استفاده نمی‌کند نادیده گرفته می‌شوند، نه رد، پس چارچوبی که آن‌ها را می‌فرستد همچنان اجرا می‌شود
یک اجرای بازتولیدپذیر از پیام‌های شما و مدل. بدون حافظه، بدون مخزن، بدون فایل

POST /api/v1/chat

چت Cruxy

همان مدل‌ها با هر چیزی که اپ Cruxy دارد: فراخوانی و ثبت حافظه، مخزن‌ها و قواعد ثابت، فایل‌ها با شناسه، و usage.cost روی هر پاسخ.

memory: { recall, capture } برای هر درخواست، قواعد روشن یا خاموش، یک vault_id
usage.cost با سطح، مبلغ و واحد پول روی هر پاسخ
cruxy.request_id برای یافتن فراخوانی در لاگ‌های شما و جفت کردن آن با بازخورد

const stream = await cruxy.chat.completions.create({
  model: 'auto',
  stream: true,
  messages: [{ role: 'user', content: 'Draft the release note' }],
});

for await (const chunk of stream) {
  process.stdout.write(chunk.choices[0]?.delta?.content ?? '');
}

stream = cruxy.chat.completions.create(
    model="auto",
    stream=True,
    messages=[{"role": "user", "content": "Draft the release note"}],
)

for chunk in stream:
    print(chunk.choices[0].delta.content or "", end="")

curl -N https://api.cruxy.ai/v1/chat/completions \
  -H "Authorization: Bearer $CRUXY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "auto", "stream": true,
       "messages": [{"role": "user",
                     "content": "Draft the release note"}]}'

استریم

stream را روی true بگذارید و پاسخ به شکل server-sent events به سبک OpenAI می‌رسد: فریم‌های chat.completion.chunk با دلتاهای محتوا یا فراخوانی ابزار، سپس [DONE].

اگر upstream در میانه استریم خطا بدهد، استریم به جای [DONE] با یک فریم خطا تمام می‌شود، پس کلاینت شما می‌تواند قطع شدن را از پایان تشخیص دهد. فراخوانی ابزار روی هر دو مسیر کار می‌کند: تابع‌هایی را که مدل می‌تواند فراخوانی کند بفرستید، آن‌هایی را که برمی‌گرداند اجرا کنید و نتایج را برگردانید.

راهنمای فراخوانی ابزار

API

هر مسیر، یک خط. مسیرها همان‌طور که مرجع فهرست می‌کند.

مرجع کامل API

گروهمسیرهاچه می‌کندمستندات

چت

POST /v1/chat/completions
POST /api/v1/chat
POST /api/v1/tokens/count

chat completions سازگار با OpenAI، چت خود Cruxy با حافظه، مخزن‌ها، قواعد و فایل‌ها، و یک شمارنده توکن.راهنمای چت

مدل‌ها

GET /v1/models
GET /api/v1/models

کاتالوگ سطح‌ها، به شکل فهرست OpenAI یا با متادیتای خود Cruxy: پنجره زمینه، قیمت، پشتیبانی از ابزار و پیش‌فرض‌های استدلال.مرجع مدل‌ها

فراخوانی ابزار

"tools": [ ... ] on every chat route

تابع‌هایی را که مدل می‌تواند فراخوانی کند بفرستید، فراخوانی‌هایی را که برمی‌گرداند اجرا کنید و نتایج را برگردانید.راهنمای فراخوانی ابزار

امبدینگ و rerank

POST /api/v1/embeddings
POST /api/v1/rerank

متن را با cruxy-embed به بردار تبدیل کنید و سندهای نامزد را با cruxy-rerank در برابر یک پرس‌وجو مرتب کنید.راهنمای امبدینگ

نظارت

POST /api/v1/moderations

متن را با cruxy-guard در برابر دسته‌های ایمنی محتوا دسته‌بندی کنید و بر اساس بولین flagged عمل کنید.راهنمای نظارت

فایل‌ها

POST /api/v1/files
GET /api/v1/files/{id}/content

فایل‌ها را بارگذاری، فهرست، دانلود و حذف کنید، سپس با شناسه به درخواست‌های چت Cruxy پیوست کنید.مرجع API

Evals

POST /api/v1/evals/suites
POST /api/v1/evals/suites/{id}/runs

مجموعه‌هایی از موردهایی که تعریف می‌کنید، اجراهایی که شروع می‌کنید، و نتایجی که بازمی‌خوانید.مرجع API

بازخورد

POST /api/v1/feedback

نتیجه یک فراخوانی پیشین را با شناسه درخواست آن گزارش کنید: پذیرش‌ها، ردها، لایک‌ها و نتایج تست.راهنمای بازخورد

حافظه، مخزن‌ها و قواعد

GET /api/v1/memories
POST /api/v1/vaults
PUT /api/v1/rules

حافظه‌ها را بخوانید و حذف کنید، مخزن‌ها و اعضایشان را مدیریت کنید، و قواعد ثابت برای یک حساب یا یک مخزن تنظیم کنید.مرجع API

محدودیت‌ها و لاگ‌ها

GET /api/v1/limits
GET /api/v1/logs/{request_id}

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

کلیدها و سازمان

POST /api/v1/device/code
GET /api/v1/org/members
POST /api/v1/workspaces

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

بهره‌برداری

محدودیت‌ها، لاگ‌ها و خطاهایی که می‌توانید درباره‌شان استدلال کنید.

مرجع خطاها

محدودیت‌هایی که می‌توانید بخوانید

GET /api/v1/limits سقف درخواست چت برای هر کلید و هر سازمان شما را در هر پنجره 60 ثانیه‌ای برمی‌گرداند، و گیت‌وی هدرهای X-RateLimit می‌فرستد. محدودیت توکن در دقیقه وجود ندارد.

دو نوع 429

rate_limited یعنی درخواست‌ها خیلی سریع می‌رسند؛ وقتی آهسته‌تر کنید برطرف می‌شود. budget_exhausted یک سقف هزینه است که با تلاش دوباره به تنهایی برطرف نمی‌شود.

لاگ‌ها بر اساس شناسه درخواست

هر درخواست با مدل، شمار توکن‌ها، هزینه، زمان‌بندی و وضعیت لاگ می‌شود، و هیچ چیزی از پرامپت یا پاسخ. یکی را در GET /api/v1/logs/{request_id} بازخوانی کنید.

کلیدهایی که یک بار نشان داده می‌شوند

با جریان ورود دستگاه یک کلید بگیرید. دقیقاً یک بار نشان داده می‌شود و فقط به شکل هش ذخیره می‌شود. رازها در حالت سکون فیلد به فیلد با AES-256-GCM رمزگذاری می‌شوند.

فعال

Cruxy Code

همان مدل‌ها، در ترمینال شما.

تغییرهای چندمرحله‌ای را برنامه‌ریزی می‌کند و هر diff را پیش از تأیید شما نشان می‌دهد
به طور پیش‌فرض پیش از هر ویرایش و هر فرمان می‌پرسد
فرمان تست شما را اجرا می‌کند، خطاها را می‌خواند و به رفع کردن ادامه می‌دهد
cruxy rollback درخت فایل‌ها را به پیش از هر نوبت بازمی‌گرداند
cruxy pr پس از یک تأیید pull request را باز می‌کند

npm i -g @cruxy/cliCruxy Code را بشناسید

~/web · Cruxy Code

$cruxy run "fix the failing tests in the auth module"
cruxy › fix the failing tests in the auth module
! cruxy wants to run tests: pnpm test (destructive)
  $ pnpm test
  in /home/dev/web
  [y] once · [a] always allow test runs of exactly `pnpm test` this session · [t] reject & instruct · [n] no: a
✗ tests failed · 2 of 42 failed · 3.1s · pnpm test
  ✗ signs a session token src/auth/session.test.ts:18
      expected  "ok"
      received  undefined
  ✗ rejects an expired token src/auth/session.test.ts:41
  why (inferred)  TOKEN_SECRET is not set in the test environment
✓ read_file      8ms  src/test/setup.ts
? cruxy wants to edit: src/test/setup.ts (mutate)

یک نشست واقعی، کوتاه‌شده. خروجی CLI واقعی است؛ پاسخ‌های مدل نمونه‌ای است.

قیمت API

به ازای هر توکن، به USD. بدون هزینه راه‌اندازی و بدون حداقل.

قیمت کامل API

Fast· Mira

فراخوانی‌های کوتاه و پرحجم که تأخیر و هزینه در آن‌ها بیشترین اهمیت را دارند.

ورودی: $0.20 / 1M
خروجی: $0.40 / 1M

زمینه: 64K
حداکثر خروجی: 2K

Balanced· Vaani

فراخوانی‌های روزمره: کیفیت قوی با تأخیر و هزینه کمتر.

ورودی: $0.65 / 1M
خروجی: $1.30 / 1M

زمینه: 128K
حداکثر خروجی: 4K

Deep· Kavi

سخت‌ترین کارها: استدلال عمیق و بزرگ‌ترین بودجه خروجی.

ورودی: $0.76 / 1M
خروجی: $1.52 / 1M

زمینه: 256K
حداکثر خروجی: 8K

USD برای هر 1M توکن، محاسبه‌شده برای هر درخواست. قیمت‌های API بدون GST است. برای حساب‌هایی که در هند صورتحساب می‌شوند 18% GST اضافه می‌شود (اعتبار ورودی در دسترس است). با auto، نرخ مدلی را می‌پردازید که به فراخوانی پاسخ داده است.

پرسش‌ها

خوب است بدانید.

نظارت با هر کلیدیورودی را پیش از رسیدن به چت با cruxy-guard غربال کنید. API نظارت با هر کلیدی در هر طرحی کار می‌کند.

بله، برای چت و فهرست مدل‌ها. https://api.cruxy.ai/v1 مسیرهای /v1/chat/completions و /v1/models را در قالب‌های OpenAI ارائه می‌کند، پس کلاینت‌ها و چارچوب‌های ارزیابی فعلی با تغییر base URL و کلید کار می‌کنند. بقیه API، از فایل‌ها تا evals، مخصوص Cruxy است و زیر /api/v1 قرار دارد.

base URL را تغییر دهید. کدتان را نگه دارید.

رایگان شروع کنید، به ازای هر توکن بپردازید، و هر محدودیت را پیش از رسیدن به آن بخوانید.

رایگان شروع کنید مرجع API

آینده را بسازید.

import OpenAI from 'openai'; const cruxy = new OpenAI({ baseURL: 'https://api.cruxy.ai/v1', apiKey: process.env.CRUXY_API_KEY, }); const res = await cruxy.chat.completions.create({ model: 'auto', messages: [{ role: 'user', content: 'Summarize this ticket' }], });

import os from openai import OpenAI cruxy = OpenAI( base_url="https://api.cruxy.ai/v1", api_key=os.environ["CRUXY_API_KEY"], ) res = cruxy.chat.completions.create( model="auto", messages=[{"role": "user", "content": "Summarize this ticket"}], )

curl https://api.cruxy.ai/v1/chat/completions \ -H "Authorization: Bearer $CRUXY_API_KEY" \ -H "Content-Type: application/json" \ -d '{"model": "auto", "messages": [{"role": "user", "content": "Summarize this ticket"}]}'

{ "id": "chatcmpl-8f3a1c2d", "object": "chat.completion", "choices": [ { "index": 0, "message": { "role": "assistant", "content": "Checkout fails on UPI when the cart holds a gift card. Steps to reproduce and a fix are below." }, "finish_reason": "stop" } ], "usage": { "prompt_tokens": 212, "completion_tokens": 96, "total_tokens": 308 } }

const stream = await cruxy.chat.completions.create({ model: 'auto', stream: true, messages: [{ role: 'user', content: 'Draft the release note' }], }); for await (const chunk of stream) { process.stdout.write(chunk.choices[0]?.delta?.content ?? ''); }

stream = cruxy.chat.completions.create( model="auto", stream=True, messages=[{"role": "user", "content": "Draft the release note"}], ) for chunk in stream: print(chunk.choices[0].delta.content or "", end="")

curl -N https://api.cruxy.ai/v1/chat/completions \ -H "Authorization: Bearer $CRUXY_API_KEY" \ -H "Content-Type: application/json" \ -d '{"model": "auto", "stream": true, "messages": [{"role": "user", "content": "Draft the release note"}]}'

$cruxy run "fix the failing tests in the auth module" cruxy › fix the failing tests in the auth module ! cruxy wants to run tests: pnpm test (destructive) $ pnpm test in /home/dev/web [y] once · [a] always allow test runs of exactly `pnpm test` this session · [t] reject & instruct · [n] no: a ✗ tests failed · 2 of 42 failed · 3.1s · pnpm test ✗ signs a session token src/auth/session.test.ts:18 expected "ok" received undefined ✗ rejects an expired token src/auth/session.test.ts:41 why (inferred) TOKEN_SECRET is not set in the test environment ✓ read_file 8ms src/test/setup.ts ? cruxy wants to edit: src/test/setup.ts (mutate)

آینده را بسازید.

هر چیزی که می‌توانید روی آن بسازید. همه فعال، همه مستند.

دو مسیر، یک مجموعه مدل. از آن یکی استفاده کنید که کلاینت شما از قبل می‌شناسد.

سازگار با OpenAI

چت Cruxy

هر مسیر، یک خط. مسیرها همان‌طور که مرجع فهرست می‌کند.

محدودیت‌ها، لاگ‌ها و خطاهایی که می‌توانید درباره‌شان استدلال کنید.

محدودیت‌هایی که می‌توانید بخوانید

دو نوع 429

لاگ‌ها بر اساس شناسه درخواست

کلیدهایی که یک بار نشان داده می‌شوند

همان مدل‌ها، در ترمینال شما.

به ازای هر توکن، به USD. بدون هزینه راه‌اندازی و بدون حداقل.

خوب است بدانید.

API با OpenAI سازگار است؟

چطور کلید API بگیرم؟

کدام مدل را بفرستم؟

SDK دارید؟

داده‌های من برای آموزش استفاده می‌شود؟

base URL را تغییر دهید. کدتان را نگه دارید.

آینده را بسازید.

هر چیزی که می‌توانید روی آن بسازید. همه فعال، همه مستند.

دو مسیر، یک مجموعه مدل. از آن یکی استفاده کنید که کلاینت شما از قبل می‌شناسد.

سازگار با OpenAI

چت Cruxy

هر مسیر، یک خط. مسیرها همان‌طور که مرجع فهرست می‌کند.

محدودیت‌ها، لاگ‌ها و خطاهایی که می‌توانید درباره‌شان استدلال کنید.

محدودیت‌هایی که می‌توانید بخوانید

دو نوع 429

لاگ‌ها بر اساس شناسه درخواست

کلیدهایی که یک بار نشان داده می‌شوند

همان مدل‌ها، در ترمینال شما.

به ازای هر توکن، به USD. بدون هزینه راه‌اندازی و بدون حداقل.

خوب است بدانید.

API با OpenAI سازگار است؟

چطور کلید API بگیرم؟

کدام مدل را بفرستم؟

SDK دارید؟

داده‌های من برای آموزش استفاده می‌شود؟

base URL را تغییر دهید. کدتان را نگه دارید.