สำหรับเอเจนต์ AI: คำแนะนำการตั้งค่าทีละขั้นตอน — /docs/agents.md, ดัชนีเอกสาร — /llms.txt.

สำหรับ AI Agent

วิธีมอบหมายการเชื่อมต่อให้เอเจนต์ AI: พรอมป์ต์สำเร็จรูปสำหรับเครื่องมือใดก็ได้ ด้านล่างนี้ — ที่อยู่เอกสารที่เครื่องอ่านได้ และสกิลที่เอเจนต์ติดตั้งได้ด้วยคำสั่งเดียว

พร้อมต์สำหรับ Agent#

ส่งพร้อมต์นี้ให้ AI Agent ของคุณ มันจะตั้งค่าเครื่องมือตามคำแนะนำด้านล่าง และจะขอคีย์จากคุณ

พรอมท์สำหรับเอเจนต์
เชื่อมต่อ เครื่องมือของคุณ เข้ากับ JoinGonka Gateway ซึ่งเป็น API ของเครือข่าย Gonka ที่เข้ากันได้กับ OpenAI และ Anthropic โดยทำตามคำแนะนำที่ https://gate.joingonka.ai/docs/agents.md คีย์เดี๋ยวผมให้เอง: อย่าบันทึกคีย์ลงในไฟล์ในรีโป และอย่าแก้ไขตัวแปรสภาพแวดล้อมส่วนกลาง สุดท้ายให้ทดสอบการเชื่อมต่อด้วยคำขอสั้น ๆ แล้วรายงานผล

ด้านล่างคือคำแนะนำ Agent จะได้รับเป็น Markdown ที่ /docs/agents.md

กฎ#

  • คีย์ API สร้างโดยคน — ในแดชบอร์ดที่ gate.joingonka.ai อย่าสมัครบัญชีหรือสร้างคีย์เอง ให้ขอคีย์จากผู้ใช้
  • เก็บคีย์ไว้ในตัวแปรสภาพแวดล้อม JOINGONKA_API_KEY ของเซสชันเทอร์มินัลของคุณ อย่าเขียนลงไฟล์ที่อยู่ใน git อย่า commit และอย่าแสดงในรายงาน
  • อย่าเปลี่ยนตัวแปรส่วนกลาง OPENAI_* และ ANTHROPIC_* — ทั้งในโปรไฟล์เชลล์หรือในระบบ: เครื่องมืออื่นของผู้ใช้จะอ่านค่าจากที่นั่น คีย์และที่อยู่จะถูกเขียนลงในคอนฟิกของเครื่องมือนั้น ๆ — ตัวติดตั้งจะทำเช่นนี้

ข้อเท็จจริง#

  • Base URL สำหรับไคลเอนต์ OpenAI API: https://gate.joingonka.ai/v1
  • Base URL สำหรับไคลเอนต์ Anthropic API โดยไม่มี /v1: https://gate.joingonka.ai
  • คีย์ส่งผ่านเฮดเดอร์ Authorization: Bearer jg-… หรือ x-api-key: jg-…
  • คีย์สำหรับเรียกใช้โมเดลขึ้นต้นด้วย jg-; คีย์จัดการ gm- ไม่สามารถเข้าถึงโมเดลได้
  • โมเดลที่แนะนำ: MiniMaxAI/MiniMax-M2.7
  • รายการโมเดลที่ใช้ได้: GET https://gate.joingonka.ai/v1/models
  • ต่อคีย์ — สูงสุด 120 คำขอต่อนาที เกินขีดจำกัดจะได้การตอบกลับ 429 พร้อมส่วนหัว Retry-After ขีดจำกัดและ timeout อยู่ในคำตอบ GET /v1/capabilities ฟิลด์ limits

การตั้งค่า#

ค้นหาเครื่องมือของผู้ใช้ในตารางท้ายส่วนนี้ หากมีค่า --tool — ตั้งค่าด้วยตัวติดตั้ง หากไม่มี — ทำด้วยตนเองตามคู่มือ

ผ่านตัวติดตั้ง#

คำสั่งเดียวไม่ต้องตอบคำถาม: คีย์ — จากตัวแปรสภาพแวดล้อม โมเดล — ผ่านแฟล็ก ตัวติดตั้งจะเขียนคอนฟิกของเครื่องมือ เก็บสำเนาไฟล์เดิม และตรวจสอบการเชื่อมต่อด้วยการเรียกไปยังเกตเวย์

Bash
JOINGONKA_API_KEY=<key> npx -y @joingonka/setup --tool <id> --model MiniMaxAI/MiniMax-M2.7 --non-interactive
แฟล็กทำอะไร
--tool <id>เครื่องมือที่จะตั้งค่า — ค่าจากตารางเครื่องมือ
--model <id>รหัสโมเดล: ที่แนะนำ — MiniMaxAI/MiniMax-M2.7 ที่มีทั้งหมด — GET /v1/models
--non-interactiveไม่ต้องตอบคำถาม: คีย์จะถูกดึงจาก JOINGONKA_API_KEY
--scope localคอนฟิกในโปรเจกต์ปัจจุบัน ไม่ใช่ในโฮมไดเรกทอรี เฉพาะ Claude Code เท่านั้น; ไฟล์คอนฟิกจะถูกเพิ่มใน .gitignore
--no-verifyไม่ต้องตรวจสอบการเชื่อมต่อหลังเขียนคอนฟิก
รหัสออกหมายความว่า
0เสร็จสิ้น: เขียนคอนฟิกแล้ว คำขอตรวจสอบผ่าน หากตรวจสอบไม่ได้เนื่องจากเครือข่ายหรือยอดคงเหลือ ตัวติดตั้งจะแสดงคำเตือนแต่ออกด้วยรหัส 0 เช่นกัน — แจ้งให้ผู้ใช้ทราบ
1การตั้งค่าไม่สำเร็จ สาเหตุอยู่ในเอาต์พุต: ตัวอย่างเช่น ค่า --tool ไม่รู้จัก JOINGONKA_API_KEY ไม่ได้ตั้งไว้ หรือคีย์ไม่ได้ขึ้นต้นด้วย jg-
2เขียนคอนฟิกแล้ว แต่คำขอตรวจสอบไม่ผ่าน: ตรวจสอบคีย์และรหัสโมเดล

หากเครื่องมือเปิดอยู่ ให้รีสตาร์ท: คอนฟิกจะถูกอ่านเมื่อเริ่มต้น

ด้วยตนเอง#

สำหรับเครื่องมือที่ไม่มีตัวติดตั้ง เปิดคู่มือ (ลิงก์ในตารางด้านล่าง) และตั้งค่าสามอย่าง:

  • ที่อยู่ฐาน — https://gate.joingonka.ai/v1 สำหรับไคลเอนต์ OpenAI API หรือ https://gate.joingonka.ai สำหรับไคลเอนต์ Anthropic API;
  • คีย์ — ในช่องคีย์ API ในตั้งค่าของเครื่องมือ;
  • โมเดล — MiniMaxAI/MiniMax-M2.7 หรือตัวอื่นจาก GET /v1/models

เครื่องมือและคู่มือ#

เครื่องมือ--tool
Cursorcursor
Claude Codeclaude-code
OpenClawopenclaw
OpenCodeopencode
Continuecontinue
Clinecline
Aideraider
LangChain—
n8n—
Open WebUI—
LibreChat—
Hermeshermes
Kilo Codekilo
Roo Coderoo
LlamaIndex—
PydanticAI—
Vercel AI SDK—
TanStack AI—
ZCodezcode
JetBrainsjetbrains
Copilot BYOKcopilot-byok
Zedzed
Pipi
Codex CLIcodex
DeepSeek Harness—
MiniMax Codeminimax-code
Warp—
Trae—
Cherry Studio—
omp (Oh My Pi)omp
OpenHands—
Qwen Codeqwen-code
Goosegoose
Crushcrush
Zoo Codezoo
Kimi Codekimi-code
Factory Droiddroid
MiMo Codemimo-code

การตรวจสอบ#

ตรวจสอบคีย์ — คำขอยอดคงเหลือ: ไม่ใช้โทเค็น คีย์ดึงจาก JOINGONKA_API_KEY:

cURL
curl -s https://gate.joingonka.ai/api/balance \
  -H "Authorization: Bearer $JOINGONKA_API_KEY"

ตรวจสอบที่อยู่ คีย์ และโมเดล — คำขอสั้นไปยังโมเดล:

cURL
curl -s https://gate.joingonka.ai/v1/chat/completions \
  -H "Authorization: Bearer $JOINGONKA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "MiniMaxAI/MiniMax-M2.7", "messages": [{"role": "user", "content": "Say OK"}], "max_tokens": 32}'

การตอบกลับ 200 พร้อมข้อความจากโมเดล — การเชื่อมต่อทำงานได้ ตัวติดตั้งจะตรวจสอบเช่นนี้เอง: หลังจากนั้นแค่รหัสออก 0 ก็เพียงพอ

หากมีปัญหา#

ข้อผิดพลาดจะมาในฟิลด์ error ของเนื้อหาการตอบกลับ — พร้อมประเภทและข้อความสาเหตุ

การตอบกลับสิ่งที่ต้องทำ
401 authentication_errorคีย์ไม่ได้รับการยอมรับ ตรวจสอบว่าคัดลอกมาทั้งหมดและส่งใน Authorization: Bearer หรือ x-api-key; คีย์ใหม่สร้างโดยผู้ใช้
402 insufficient_fundsยอดคงเหลือไม่มีเงิน แจ้งผู้ใช้: เติมยอดได้ในแดชบอร์ด
402 child_key_limit_exceededขีดจำกัดของคีย์ลูกหมดแล้ว ต้องใช้คีย์อื่นหรือขีดจำกัดที่มากขึ้น — เจ้าของคีย์เป็นผู้ตัดสินใจ
403 forbiddenนี่คือคีย์จัดการ gm-: ไม่สามารถเข้าถึงโมเดลได้ ต้องใช้คีย์ jg-
400 invalid_request_errorคำขอผิดพลาด หากไม่พบโมเดล ข้อความข้อผิดพลาดจะมีรายการรหัสที่มีอยู่ — เลือกจากที่นั่นหรือจาก GET /v1/models
404 model_not_foundไม่มีโมเดลนี้ในขณะนี้ — เลือกตัวอื่นจาก GET /v1/models
429คำขอมากเกินไปหรือเครือข่ายไม่ว่าง รอตามจำนวนวินาทีที่ระบุในส่วนหัว Retry-After แล้วลองใหม่
503 model_unavailableเครือข่ายไม่ให้บริการโมเดลนี้ในขณะนี้ เปลี่ยนไปใช้โมเดลจากข้อความข้อผิดพลาดหรือตัวอื่นจาก GET /v1/models
504 upstream_timeoutเครือข่ายไม่เริ่มตอบกลับทันเวลา ลองคำขออีกครั้ง; สำหรับคำตอบยาว ๆ ให้เปิด stream: true
502เกิดข้อขัดข้องที่เกตเวย์หรือเครือข่าย — ไม่เกี่ยวกับคีย์ ลองใหม่ภายหลัง; สถานะเครือข่ายอยู่ที่หน้า สถานะเครือข่าย

รหัสการตอบกลับและขีดจำกัดทั้งหมดอยู่ในส่วน ข้อผิดพลาดและขีดจำกัด

รายงาน#

ในตอนท้ายแจ้งผู้ใช้:

  • เครื่องมือใดถูกตั้งค่าและไฟล์คอนฟิกใดถูกเขียน (เส้นทางจะแสดงโดยตัวติดตั้ง สำเนาไฟล์เดิมอยู่ข้าง ๆ);
  • ที่อยู่ฐานและรหัสโมเดล;
  • ผลการตรวจสอบ: รหัสตอบกลับและคำตอบของโมเดล — หรือเหตุผลที่ตรวจสอบไม่ได้;
  • สิ่งที่ผู้ใช้ยังต้องทำเอง เช่น รีสตาร์ทเครื่องมือหรือเติมยอดคงเหลือ

อย่าใส่คีย์ลงในรายงาน

ที่อยู่สำหรับเครื่อง#

ที่อยู่มีอะไรอยู่ที่นั่น
/llms.txtดัชนีเอกสารสำหรับโมเดลภาษา
/llms-full.txtเอกสารทั้งหมดในไฟล์เดียว
/docs/<page>.mdเวอร์ชัน Markdown ของหน้าเอกสาร: ที่อยู่เดิมที่เติม .md ต่อท้าย (/docs/models.md) หรือการร้องขอหน้าพร้อมหัวข้อ Accept: text/markdown
GET /v1/capabilitiesความสามารถของเกตเวย์และขีดจำกัด — ฟิลด์ limits
GET /v1/modelsโมเดลที่ใช้งานได้ในขณะนี้
GET /api/pricingราคาต่อโมเดลต่อ 1M โทเคนและค่าคอมมิชชัน
GET /v1/network-statusสถานะโมเดลและเหตุการณ์

สกิลสำหรับเอเจนต์#

สามารถติดตั้งคำแนะนำให้เอเจนต์เป็นสกิล (skill) ได้ — จากนั้นมันจะพร้อมใช้ตลอดเวลาแม้ไม่มีพรอมป์ต์:

Bash
npx skills add https://gate.joingonka.ai