دستاویزات

فوری آغاز

JoinGonka Gateway Gonka ماڈلز تک رسائی کے لیے OpenAI اور Anthropic API کو سپورٹ کرتا ہے۔ تبدیل کریں base_url آپ کے کلائنٹ میں – اور سب کچھ کام کرتا ہے۔

بیس URL: https://gate.joingonka.ai/v1

ماڈل: MiniMaxAI/MiniMax-M2.7

تصدیق: Bearer YOUR_API_KEY

Python (OpenAI SDK)

python

from openai import OpenAI

client = OpenAI(
    base_url="https://gate.joingonka.ai/v1",
    api_key="YOUR_API_KEY",
)

response = client.chat.completions.create(
    model="MiniMaxAI/MiniMax-M2.7",
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "What is Gonka?"},
    ],
    temperature=0.7,
    max_tokens=1024,
)

print(response.choices[0].message.content)

TypeScript (OpenAI SDK)

typescript

import OpenAI from "openai";

const client = new OpenAI({
  baseURL: "https://gate.joingonka.ai/v1",
  apiKey: "YOUR_API_KEY",
});

const response = await client.chat.completions.create({
  model: "MiniMaxAI/MiniMax-M2.7",
  messages: [
    { role: "system", content: "You are a helpful assistant." },
    { role: "user", content: "What is Gonka?" },
  ],
  temperature: 0.7,
  max_tokens: 1024,
});

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

cURL

bash

curl https://gate.joingonka.ai/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "MiniMaxAI/MiniMax-M2.7",
    "messages": [
      {"role": "system", "content": "You are a helpful assistant."},
      {"role": "user", "content": "What is Gonka?"}
    ],
    "temperature": 0.7,
    "max_tokens": 1024
  }'

Anthropic API (Claude Code)

JoinGonka Gateway مقامی طور پر Anthropic Messages API (/v1/messages) کو سپورٹ کرتا ہے۔ Claude Code, Anthropic SDK، اور Anthropic فارمیٹ کو استعمال کرنے والے کوئی بھی ٹولز براہ راست کام کرتے ہیں - بغیر کسی پراکسی کے۔

Claude Code

Recommended — set it up with one command (also configures OpenClaw and Cline):

bash

npx @joingonka/setup

Or configure it manually:

bash

export ANTHROPIC_BASE_URL=https://gate.joingonka.ai
export ANTHROPIC_API_KEY=YOUR_API_KEY
claude

Python (Anthropic SDK)

python

import anthropic

client = anthropic.Anthropic(
    base_url="https://gate.joingonka.ai",
    api_key="YOUR_API_KEY",
)

message = client.messages.create(
    model="MiniMaxAI/MiniMax-M2.7",
    max_tokens=1024,
    messages=[
        {"role": "user", "content": "What is Gonka?"},
    ],
)

print(message.content[0].text)

cURL (Anthropic format)

bash

curl https://gate.joingonka.ai/v1/messages \
  -H "x-api-key: YOUR_API_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "MiniMaxAI/MiniMax-M2.7",
    "max_tokens": 1024,
    "messages": [
      {"role": "user", "content": "What is Gonka?"}
    ]
  }'

Streaming (Python)

python

import anthropic

client = anthropic.Anthropic(
    base_url="https://gate.joingonka.ai",
    api_key="YOUR_API_KEY",
)

with client.messages.stream(
    model="MiniMaxAI/MiniMax-M2.7",
    max_tokens=1024,
    messages=[{"role": "user", "content": "Explain Gonka"}],
) as stream:
    for text in stream.text_stream:
        print(text, end="", flush=True)

Tool Use (cURL)

bash

curl https://gate.joingonka.ai/v1/messages \
  -H "x-api-key: YOUR_API_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "MiniMaxAI/MiniMax-M2.7",
    "max_tokens": 1024,
    "tools": [{
      "name": "get_weather",
      "description": "Get current weather",
      "input_schema": {
        "type": "object",
        "properties": {"city": {"type": "string"}},
        "required": ["city"]
      }
    }],
    "messages": [{"role": "user", "content": "Weather in Moscow?"}]
  }'

دونوں فارمیٹس (OpenAI اور Anthropic) ایک ہی API کی اور ایک ہی بیلنس استعمال کرتے ہیں۔

API اینڈ پوائنٹس

Inference

POST/v1/chat/completions

چیٹ کی تکمیل - OpenAI فارمیٹ (سٹریمنگ سپورٹڈ)

json

{
  "id": "chatcmpl-abc123...",
  "object": "chat.completion",
  "model": "MiniMaxAI/MiniMax-M2.7",
  "choices": [{
    "index": 0,
    "message": {
      "role": "assistant",
      "content": "Hello! How can I help you?",
      "tool_calls": []
    },
    "finish_reason": "stop"
  }],
  "usage": {
    "prompt_tokens": 12,
    "completion_tokens": 8,
    "total_tokens": 20
  },
  "x_joingonka": {
    "cost_ngonka": "24",
    "balance_ngonka": "11999976"
  }
}

POST/v1/messages

چیٹ کی تکمیل - Anthropic فارمیٹ (سٹریمنگ، tool_use)

json

{
  "id": "msg_abc123...",
  "type": "message",
  "role": "assistant",
  "content": [{"type": "text", "text": "Hello!"}],
  "model": "MiniMaxAI/MiniMax-M2.7",
  "stop_reason": "end_turn",
  "usage": {"input_tokens": 12, "output_tokens": 8}
}

GET/v1/models

دستیاب ماڈلز کی فہرست

json

{
  "object": "list",
  "data": [{
    "id": "MiniMaxAI/MiniMax-M2.7",
    "object": "model",
    "owned_by": "gonka-network",
    "context_length": 200000,
    "pricing": {
      "prompt": "0.00000007",
      "completion": "0.0000001"
    },
    "architecture": {
      "modality": "text->text"
    },
    "top_provider": {
      "context_length": 200000,
      "max_completion_tokens": 8192,
      "is_moderated": false
    },
    "supported_parameters": [
      "temperature", "top_p", "tools",
      "tool_choice", "max_tokens", "stop"
    ],
    "x_gonka": {
      "v_ram": 320,
      "context_window": 200000,
      "max_output": 8192,
      "actual_cost_ngonka": 1.2
    }
  }]
}

پلگ انز

پلگ انز API کی صلاحیتوں کو بڑھاتے ہیں۔ فعال کرنے کے لیے درخواست میں پلگ انز کا ایک صفہ پاس کریں۔

GET/v1/plugins

دستیاب پلگ انز کی فہرست

json

{
  "plugins": [
    {"id": "web", "description": "Web search — inject fresh results with citations"},
    {"id": "response-healing", "description": "Auto-fix truncated JSON"},
    {"id": "privacy-sanitization", "description": "Mask sensitive data"},
    {"id": "file-parser", "description": "Extract text from PDF"}
  ]
}

درخواست میں استعمال

json

{
  "model": "MiniMaxAI/MiniMax-M2.7",
  "messages": [{"role": "user", "content": "..."}],
  "plugins": ["response-healing", "privacy-sanitization"]
}

web

Gonka ماڈلز میں براہ راست ویب سرچ۔ ماڈلز (Kimi, MiniMax, DeepSeek) خود سرچ کی فعالیت نہیں رکھتے؛ گیٹ وے (gateway) انٹرنیٹ سے تازہ نتائج کو سیاق و سباق میں شامل کرتا ہے اور ذرائع کے حوالہ جات واپس کرتا ہے۔ یہ stream اور non-stream موڈز میں کام کرتا ہے۔ بیک اینڈ self-hosted ہے: درخواستیں آپ کے اکاؤنٹ کا استعمال کرتے ہوئے تھرڈ پارٹی سرچ APIs پر نہیں بھیجی جاتیں۔

طریقہ 1 – plugins array میں web آبجیکٹ (اختیارات کے ساتھ نتائج کا انجیکشن):

json

{
  "model": "MiniMaxAI/MiniMax-M2.7",
  "messages": [{"role": "user", "content": "What's new in the Gonka network?"}],
  "plugins": [{
    "id": "web",
    "max_results": 5,
    "search_prompt": "Relevant web search results:"
  }]
}

طریقہ 2 – ایجنٹ موڈ (mode: "agent"): ماڈل خود web_search کو صرف اس صورت میں کال کرتا ہے جب تلاش کی ضرورت ہو:

json

{
  "model": "MiniMaxAI/MiniMax-M2.7",
  "messages": [{"role": "user", "content": "What's new in the Gonka network?"}],
  "plugins": [{ "id": "web", "mode": "agent", "max_searches": 3 }]
}

اختیارات: max_results — نتائج کی تعداد (بائی ڈیفالٹ 5، زیادہ سے زیادہ 10)؛ search_prompt — نتائج سے پہلے آپ کا اپنا گراؤنڈنگ پرامپٹ۔

جواب کو annotations[].url_citation (url, title) کے ساتھ لیس کیا جاتا ہے — OpenRouter معیار:

json

{
  "choices": [{
    "message": {
      "role": "assistant",
      "content": "...",
      "annotations": [{
        "type": "url_citation",
        "url_citation": {
          "url": "https://gonka.ai/...",
          "title": "Gonka Network"
        }
      }]
    }
  }]
}

قیمت کا تعین: موڈ plugins:[{ "id": "web" }] — صرف ٹوکنز کے لیے (شامل نتائج عام prompt-ٹوکنز کے طور پر گنے جاتے ہیں)۔ ایجنٹ موڈ (mode: "agent") — لوپ کے تمام مراحل کے ٹوکنز اور ہر web_search کال کے لیے 1000 nGNK کا اضافی چارج (GNK کی شرح ~$0.15 پر 1000 تلاش کے لیے ≈ $0.0001)

یہ عمل privacy-sanitization کے ساتھ مطابقت نہیں رکھتا: مشترکہ درخواست 400 ایرر کوڈ واپس کرے گی۔

response-healing

کٹے ہوئے JSON/ساختہ آؤٹ پٹ کو خود بخود ٹھیک کرنا۔ صرف نان-سٹریمنگ درخواستوں کے لیے JSON مواد کے ساتھ کام کرتا ہے۔

privacy-sanitization

ماڈل کو بھیجنے سے پہلے پیغامات میں حساس ڈیٹا (API کیز، ای میل، IP ایڈریسز، JWT، کارڈ نمبرز) کو ماسک کرنا۔

موڈز: redact ([REDACTED] سے تبدیل کریں) یا tokenize ([TOKEN_001] سے تبدیل کریں)۔ باڈی میں privacy_mode پاس کریں۔

file-parser

PDF دستاویزات سے ٹیکسٹ نکالنا۔ data:application/pdf;base64,... اور RAW base64 کو سپورٹ کرتا ہے۔

مینجمنٹ کیز

SaaS انضمام کے لیے درجہ بندی والی API کیز۔ مینجمنٹ کی (gm-) حدود اور TTL کے ساتھ چائلڈ کیز (gc-) بناتی ہے۔

POST/api/management/keys

مینجمنٹ کی بنائیں (پری فکس gm-)۔ صرف چائلڈ کیز کے انتظام کے لیے استعمال ہوتی ہے۔

POST/api/management/keys/:id/children

اختیاری حدود کے ساتھ چائلڈ کی بنائیں (پری فکس gc-)۔ بلنگ مینجمنٹ کی کے مالک کے بیلنس سے کاٹی جاتی ہے۔

json

{
  "name": "Client A",
  "limit_daily_ngonka": "1000000000",
  "limit_monthly_ngonka": "10000000000",
  "expires_at": "2026-04-01T00:00:00Z",
  "rate_limit_rpm": 30
}

GET/api/management/keys/:id/children

استعمال کے اعدادوشمار کے ساتھ چائلڈ کیز کی فہرست۔

PUT/api/management/keys/:id/children/:childId

چائلڈ کی کی حدود، RPM یا حیثیت کو اپ ڈیٹ کریں۔

DELETE/api/management/keys/:id/children/:childId

چائلڈ کی کو غیر فعال کریں (سافٹ ڈیلیٹ)۔

Account

GET/api/balance

موجودہ بیلنس

json

{
  "balance_ngonka": "11999976",
  "balance_usd": 0.008,
  "cost_per_token_ngonka": 1,
  "tokens_remaining": 11999976
}

GET/api/keys

API کیز کی فہرست

POST/api/keys

API کی بنائیں

DELETE/api/keys/:id

API کی حذف کریں

Billing

GET/api/usage

استعمال کے اعدادوشمار

Query: period=day|week|month&tz=-180

json

{
  "period": "month",
  "usage": [{
    "date": "2026-03-20",
    "requests": 42,
    "tokens": 18500,
    "costNgonka": "22200"
  }]
}

GET/api/deposits

ڈپازٹ ہسٹری

Query: limit=50&offset=0&from=2026-03-01&to=2026-03-21

json

{
  "deposits": [{
    "id": "abc-123",
    "type": "DEPOSIT_GNK",
    "amountNgonka": "10000000",
    "description": "GNK deposit via memo",
    "createdAt": "2026-03-20T12:00:00Z"
  }],
  "total": 3
}

GET/api/transactions

لین دین کی ہسٹری

Query: limit=50&offset=0&type=INFERENCE&from=2026-03-01&to=2026-03-21

json

{
  "transactions": [{
    "id": "def-456",
    "type": "INFERENCE",
    "amountNgonka": "-1200",
    "feeNgonka": "120",
    "description": null,
    "createdAt": "2026-03-20T14:30:00Z"
  }],
  "total": 128
}

GET/api/pricing

ٹیرف اور کمیشن (عوامی، بغیر اجازت کے)

json

{
  "deposit_usdt_fee_percent": 5,
  "deposit_gnk_fee_percent": 0,
  "usage_fee_percent": 10,
  "withdrawal_fee_percent": 5,
  "gnk_usd_price": 0.3465
}

Streaming & Errors

جب stream: true، جواب SSE (Server-Sent Events) کے ذریعے چنکس میں آتا ہے۔

OpenAI (stream: true)

text

data: {"choices":[{"delta":{"content":"Hello"}}]}

data: {"choices":[{"delta":{"content":"!"}}]}

data: {"choices":[],"x_joingonka":{"cost_ngonka":"24"}}

data: [DONE]

Anthropic (stream: true)

text

event: message_start
data: {"type":"message_start","message":{...}}

event: content_block_delta
data: {"type":"content_block_delta","delta":{"type":"text_delta","text":"Hello"}}

event: message_stop
data: {"type":"message_stop"}

خرابیاں

json

// 400 — неверный запрос
{"error": {"message": "...", "type": "invalid_request_error"}}

// 401 — не авторизован
{"error": {"message": "...", "type": "authentication_error"}}

// 402 — недостаточный баланс
{"error": {"message": "...", "type": "insufficient_funds", "balance_ngonka": "0"}}

// 429 — rate limit
{"error": {"message": "...", "type": "rate_limit_error"}}

// 502 — ошибка сети Gonka
{"error": {"message": "...", "type": "api_error"}}

ماڈلز

Gonka نیٹ ورک ایک سنگل API کے ذریعے متعدد ماڈلز فراہم کرتا ہے — موجودہ فہرست ہمیشہ GET /v1/models کی درخواست کے ذریعے حاصل کی جا سکتی ہے۔ ماڈل منتخب کرنے کے لیے — ریکوئسٹ باڈی کے model فیلڈ میں اس کی ID پاس کریں۔

ماڈل	فروشندہ	سیاق و سباق	زیادہ سے زیادہ آؤٹ پٹ	VRAM	حیثیت
MiniMax M2.7	MiniMax	195K	8K	320 GB	دستیاب
Kimi K2.6	Moonshot AI	195K	8K	720 GB	دستیاب
DeepSeek V4 Flash	DeepSeek	371K	32K	280 GB	دستیاب

بطور ڈیفالٹ (اگر model کی وضاحت نہیں کی گئی ہے)، نیٹ ورک کا فلیگ شپ ماڈل استعمال ہوتا ہے۔ میٹا ڈیٹا کے ساتھ موجودہ فہرست — GET /v1/models۔

تمام میٹا ڈیٹا کے ساتھ ماڈلز کی موجودہ فہرست – GET /v1/models۔ ویژن اور ملٹی موڈل ان پٹ (image_url) ابھی تک اپ اسٹریم گونگا نیٹ ورک کے ذریعے تعاون یافتہ نہیں ہیں۔

ٹیرف اور کمیشن

مکمل شفافیت: نیچے تمام گیٹ وے فیسیں دی گئی ہیں۔ اصل اقدار API سے لائیو لوڈ ہوتی ہیں — عوامی اینڈ پوائنٹ GET /api/pricing بغیر اجازت کے دستیاب ہے۔

آپریشن	کمیشن	نوٹ
انفرینس پر اضافی چارج	10%	Gonka نیٹ ورک کی قیمت پر پلیٹ فارم کا اضافی چارج — گیٹ وے کی آمدنی کا بنیادی ذریعہ۔ ٹوکن کی لاگت کے ساتھ ہر درخواست سے کاٹا جاتا ہے۔
USDT کے ذریعے ٹاپ اپ	5%	کریپٹو (USDT) کے ذریعے ادائیگی کرنے پر ادائیگی فراہم کنندہ کی طرف سے روکا جاتا ہے۔
GNK کے ذریعے ٹاپ اپ	مفت	براہ راست GNK on-chain منتقلی بغیر کسی گیٹ وے فیس کے کریڈٹ کی جاتی ہے۔
فنڈز کا نکاسی	5%	بیرونی پتے پر GNK نکالتے وقت کاٹا جاتا ہے۔ واپسی پروسیسنگ دستی طور پر 24-48 گھنٹوں کے اندر کی جاتی ہے۔
موجودہ GNK قیمت	$0.147	GNK/USD ریٹ جس پر ٹاپ اپ اور بیلنس کا حساب لگایا جاتا ہے۔ خود بخود اپ ڈیٹ ہوتا ہے۔

GET /api/pricing

حدود

ماڈلز: تمام گونکا نیٹ ورک ماڈلز (DevShards ملٹی ماڈل آرکیٹیکچر)

درخواست کی حد: API کلید کے ساتھ درخواستوں کی تعداد مقررہ طور پر محدود نہیں ہے (نیٹ ورک کی ہم آہنگی کی حد لاگو ہوتی ہے)؛ بغیر کلید کے — 20 فی دن فی IP (اینٹی اسپیم)

زیادہ سے زیادہ ٹوکنز: DeepSeek V4 Flash کے لیے فی درخواست 32,768 ٹوکنز تک اور دیگر ماڈلز کے لیے 8,192 تک (حد سے تجاوز کرنے والی اقدار کو gateway کے ذریعے کاٹ دیا جاتا ہے)۔ طویل جوابات کے لیے، ٹائم آؤٹ سے بچنے کے لیے stream:true استعمال کریں۔

سٹریمنگ: سپورٹڈ (SSE, stream: true)

نیٹ ورک ٹائم آؤٹ: اگر Gonka نیٹ ورک نے درخواست قبول کر لی لیکن 300 سیکنڈ کے اندر جواب نہیں دیا تو درخواست 504 کی خرابی کے ساتھ ختم ہو جاتی ہے، اور پرامپٹ کی پروسیسنگ تخمینہ کے مطابق منہا کر دی جاتی ہے: نیٹ ورک کی طرف سے قبول کردہ درخواست کو منسوخ نہیں کیا جا سکتا، نوڈ اسے ہر حال میں پروسیس کرتا ہے۔ ٹائم آؤٹ ہونے پر Completion چارج نہیں کیا جاتا۔ طویل جنریشنز کے لیے stream:true استعمال کریں۔