میں API کی کیسے حاصل کروں؟

Cruxy کے لیے سائن اپ کریں اور کوئک اسٹارٹ میں بیان کیے ڈیوائس لاگ ان فلو سے کی بنائیں: ڈیوائس کوڈ کی درخواست کریں، اسے براؤزر میں منظور کریں اور کی کے لیے پول کریں۔ API کیز ایپ کے اسی اکاؤنٹ سے آتی ہیں، اور API کا بل فی ٹوکن بنتا ہے، آپ کے پلان سے الگ۔

مجھے کون سا ماڈل پاس کرنا چاہیے؟

auto پاس کریں، جب تک کوئی وجہ نہ ہو۔ Mira چھوٹی، بڑے حجم کی کالز کے لیے تیز سائز ہے، Vaani متوازن ڈیفالٹ ہے، اور Kavi سب سے مشکل کاموں کے لیے گہرا سائز ہے۔ کسی سائز کے پیچھے کا ماڈل بدل سکتا ہے؛ سائز کی id معاہدہ ہے۔

کیا آپ کے پاس SDK ہے؟

چیٹ کمپلیشنز اور ماڈلز کے لیے کوئی بھی OpenAI کلائنٹ کام کرتا ہے، آپ جو بھی زبان پہلے سے استعمال کرتے ہیں۔ Cruxy کے اپنے روٹس کے لیے دستاویزات درخواست curl اور fetch کے ساتھ TypeScript میں دکھاتی ہیں۔

کیا میرا ڈیٹا تربیت کے لیے استعمال ہوتا ہے؟

آپ کے پرامپٹ اور آؤٹ پٹ آپ کی واضح، الگ رضامندی کے بغیر AI ماڈلز کی تربیت کے لیے استعمال نہیں ہوتے۔ درخواست کے لاگ ماڈل، ٹوکن کی تعداد، لاگت اور وقت رکھتے ہیں، اور مواد کا کوئی حصہ نہیں۔ پوری تفصیل پرائیویسی پالیسی میں ہے۔

ڈیویلپرز

آگے کی چیزیں بنائیں۔

ایک بیس URL، ایک کی اور پیچھے تین ماڈل سائز۔ چیٹ کے لیے OpenAI سے ہم آہنگ API، جب میموری، والٹس، فائلیں اور evals چاہیں تو Cruxy کے اپنے روٹس، اور ایک 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
  }
}

درخواست اصلی ہے۔ جواب مثال کے طور پر ہے اور اس کی شکل تک کاٹا گیا ہے۔

بیس URL: api.cruxy.ai/v1
ماڈلز: kavi · vaani · mira · auto
اسٹریمنگ: OpenAI کا SSE، [DONE] پر ختم
ایررز: ہر ایک پر ایک مستقل کوڈ

پلیٹ فارم

وہ سب جس پر آپ بنا سکتے ہیں۔ سب دستیاب، سب دستاویز شدہ۔

Chat APIدستیابتین ماڈل سائزوں پر OpenAI سے ہم آہنگ چیٹ کمپلیشنز۔ اسٹریمنگ، ٹول کالنگ اور ہر درخواست پر آپ کا مقرر کیا reasoning_effort۔چیٹ گائیڈ Cruxy Codeدستیابآپ کے ٹرمینل کے لیے کوڈنگ ایجنٹ۔ آپ کا کوڈ بیس پڑھتا ہے، ہر منظوری سے پہلے ڈف کے ساتھ فائلوں میں ترمیم کرتا ہے، آپ کے ٹیسٹ چلاتا ہے اور پل ریکوئسٹ کھولتا ہے۔Cruxy Code دیکھیں Evals APIدستیابآپ کے طے کیے کیسز کے سوٹ، آپ کے شروع کیے رن، آپ کے پڑھے نتائج۔ کسی ایویلیوایشن ہارنس کو OpenAI سے ہم آہنگ روٹس پر پوائنٹ کریں، یا evals روٹس براہ راست استعمال کریں۔API ریفرنس ایمبیڈنگز، ری رینک اور ماڈریشندستیابcruxy-embed ٹیکسٹ کو ویکٹرز میں بدلتا ہے، cruxy-rerank امیدواروں کو کوئری کے مقابل ترتیب دیتا ہے، اور cruxy-guard ٹیکسٹ کو کانٹینٹ سیفٹی کی کیٹیگریز پر کلاسیفائی کرتا ہے۔کک بک دستاویزاتدستیابایک کوئک اسٹارٹ، ہر روٹ کے لیے گائیڈ، ریٹریول، ٹول لوپس اور براؤزر میں اسٹریمنگ والی کک بک، اور مکمل API ریفرنس۔دستاویزات پڑھیں اسٹیٹسدستیابلائیو پروبز اور انسیڈنٹس، اپنے الگ ڈومین پر، تاکہ آپ اپنا کوڈ دیکھنے سے پہلے ہمیں دیکھ سکیں۔اسٹیٹس دیکھیں

چیٹ

دو روٹس، ماڈلز کا ایک سیٹ۔ وہ استعمال کریں جو آپ کا کلائنٹ پہلے سے بولتا ہے۔

چیٹ گائیڈ

POST /v1/chat/completions

OpenAI سے ہم آہنگ

کسی بھی OpenAI کلائنٹ یا ایویلیوایشن ہارنس کو اپنی Cruxy کی کے ساتھ https://api.cruxy.ai/v1 پر پوائنٹ کریں۔ معیاری chat.completion آبجیکٹس، OpenAI کا SSE اور OpenAI کا ایرر اینویلپ، اندر ایک مستقل Cruxy کوڈ کے ساتھ۔

temperature، top_p، max_tokens اور reasoning_effort کا احترام کیا جاتا ہے
جو فیلڈز گیٹ وے استعمال نہیں کرتا وہ نظر انداز ہوتے ہیں، رد نہیں، تو انہیں بھیجنے والا ہارنس پھر بھی چلتا ہے
آپ کے پیغامات اور ماڈل کا دوبارہ پیدا ہو سکنے والا رن۔ نہ میموری، نہ والٹس، نہ فائلیں

POST /api/v1/chat

Cruxy چیٹ

وہی ماڈل ہر اس چیز کے ساتھ جو Cruxy ایپ میں ہے: میموری کی ریکال اور کیپچر، والٹس اور مستقل رولز، id سے فائلیں، اور ہر جواب پر 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 پر رکھیں اور جواب OpenAI کے سرور سینٹ ایونٹس کی صورت میں آتا ہے: content یا ٹول کال ڈیلٹا والے chat.completion.chunk فریم، پھر [DONE]۔

اگر اپ اسٹریم اسٹریم کے بیچ میں ناکام ہو جائے، تو اسٹریم [DONE] کے بجائے ایک ایرر فریم پر ختم ہوتی ہے، تاکہ آپ کا کلائنٹ کٹ جانے اور مکمل ہونے میں فرق کر سکے۔ ٹول کالنگ دونوں روٹس پر کام کرتی ہے: وہ فنکشن بھیجیں جو ماڈل کال کر سکتا ہے، جو وہ واپس کرے انہیں چلائیں اور نتائج واپس دیں۔

ٹول کالنگ گائیڈ

API

ہر روٹ، ایک سطر میں۔ پاتھ ویسے ہی جیسے ریفرنس درج کرتا ہے۔

مکمل API ریفرنس

گروپروٹسیہ کیا کرتا ہےدستاویزات

چیٹ

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

OpenAI سے ہم آہنگ چیٹ کمپلیشنز، میموری، والٹس، رولز اور فائلوں کے ساتھ Cruxy کی اپنی چیٹ، اور ایک ٹوکن کاؤنٹر۔چیٹ گائیڈ

ماڈلز

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

درجوں کا کیٹلاگ، OpenAI لسٹ کی صورت میں یا Cruxy کے اپنے میٹا ڈیٹا کے ساتھ: کانٹیکسٹ ونڈو، قیمت، ٹول سپورٹ اور ریزننگ ڈیفالٹس۔ماڈل ریفرنس

ٹول کالنگ

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

وہ فنکشن بھیجیں جو ماڈل کال کر سکتا ہے، جو کالز وہ واپس کرے انہیں چلائیں اور نتائج واپس دیں۔ٹول کالنگ گائیڈ

ایمبیڈنگز اور ری رینک

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

فائلیں اپ لوڈ، لسٹ، ڈاؤن لوڈ اور حذف کریں، پھر انہیں id سے Cruxy چیٹ درخواستوں کے ساتھ اٹیچ کریں۔API ریفرنس

Evals

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

آپ کے طے کیے کیسز کے سوٹ، آپ کے شروع کیے رن، اور آپ کے پڑھے نتائج۔API ریفرنس

فیڈبیک

POST /api/v1/feedback

پچھلی کال کا نتیجہ اس کی request id سے رپورٹ کریں: قبول، رد، تھمبس اور ٹیسٹ کے نتائج۔فیڈبیک گائیڈ

میموری، والٹس اور رولز

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

میموریز پڑھیں اور حذف کریں، والٹس اور ان کے ارکان کا انتظام کریں، اور اکاؤنٹ یا والٹ کے لیے مستقل رولز مقرر کریں۔API ریفرنس

حدود اور لاگز

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

آپ کی ہر کی اور ہر ادارے کی درخواستوں کی حدیں، اور 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 خرچ کی وہ حد ہے جو صرف دوبارہ کوشش سے ختم نہیں ہوتی۔

request id سے لاگز

ہر درخواست ماڈل، ٹوکن کی تعداد، لاگت، وقت اور اسٹیٹس کے ساتھ لاگ ہوتی ہے، اور پرامپٹ یا جواب کا کوئی حصہ نہیں۔ ایک کو GET /api/v1/logs/{request_id} پر واپس پڑھیں۔

کیز ایک بار دکھائی جاتی ہیں

ڈیوائس لاگ ان فلو سے کی حاصل کریں۔ یہ بالکل ایک بار دکھائی جاتی ہے اور صرف ہیش کی صورت میں محفوظ ہوتی ہے۔ اسٹوریج میں سیکرٹس AES-256-GCM سے فیلڈ در فیلڈ انکرپٹڈ ہیں۔

دستیاب

Cruxy Code

وہی ماڈل، آپ کے ٹرمینل میں۔

کئی مرحلوں کی تبدیلیوں کا منصوبہ بناتا ہے اور منظوری سے پہلے ہر ڈف دکھاتا ہے
ڈیفالٹ طور پر ہر ترمیم اور ہر کمانڈ سے پہلے پوچھتا ہے
آپ کی ٹیسٹ کمانڈ چلاتا ہے، ناکامیاں پڑھتا ہے اور ٹھیک کرتا رہتا ہے
cruxy rollback ٹری کو کسی بھی ٹرن سے پہلے کی حالت میں بحال کرتا ہے
cruxy pr ایک منظوری کے بعد پل ریکوئسٹ کھولتا ہے

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 کی شکلوں میں دستیاب ہیں، تو موجودہ کلائنٹ اور ایویلیوایشن ہارنس بیس URL اور کی بدلنے پر کام کرتے ہیں۔ باقی API، فائلوں سے evals تک، Cruxy کا اپنا ہے اور /api/v1 کے تحت رہتا ہے۔

بیس 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 کی دو قسمیں

request id سے لاگز

کیز ایک بار دکھائی جاتی ہیں

وہی ماڈل، آپ کے ٹرمینل میں۔

فی ٹوکن، USD میں۔ نہ سیٹ اپ فیس اور نہ کم سے کم حد۔

جاننے کے لائق۔

کیا API OpenAI سے ہم آہنگ ہے؟

میں API کی کیسے حاصل کروں؟

مجھے کون سا ماڈل پاس کرنا چاہیے؟

کیا آپ کے پاس SDK ہے؟

کیا میرا ڈیٹا تربیت کے لیے استعمال ہوتا ہے؟

بیس URL بدلیں۔ اپنا کوڈ رکھیں۔

آگے کی چیزیں بنائیں۔

وہ سب جس پر آپ بنا سکتے ہیں۔ سب دستیاب، سب دستاویز شدہ۔

دو روٹس، ماڈلز کا ایک سیٹ۔ وہ استعمال کریں جو آپ کا کلائنٹ پہلے سے بولتا ہے۔

OpenAI سے ہم آہنگ

Cruxy چیٹ

ہر روٹ، ایک سطر میں۔ پاتھ ویسے ہی جیسے ریفرنس درج کرتا ہے۔

حدود، لاگز اور ایررز جن پر آپ سوچ سکیں۔

حدود جو آپ پڑھ سکیں

429 کی دو قسمیں

request id سے لاگز

کیز ایک بار دکھائی جاتی ہیں

وہی ماڈل، آپ کے ٹرمینل میں۔

فی ٹوکن، USD میں۔ نہ سیٹ اپ فیس اور نہ کم سے کم حد۔

جاننے کے لائق۔

کیا API OpenAI سے ہم آہنگ ہے؟

میں API کی کیسے حاصل کروں؟

مجھے کون سا ماڈل پاس کرنا چاہیے؟

کیا آپ کے پاس SDK ہے؟

کیا میرا ڈیٹا تربیت کے لیے استعمال ہوتا ہے؟

بیس URL بدلیں۔ اپنا کوڈ رکھیں۔