คีย์ API Codex อธิบายสำหรับนักพัฒนา

ทำความเข้าใจรูปแบบคีย์ API

เมื่อสมัครรับบริการที่มี codex api key คุณจะได้รับสตริงตัวอักษรและตัวเลขที่ไม่ซ้ำกัน คีย์นี้ทำหน้าที่เป็นข้อมูลรับรองการตรวจสอบสิทธิ์สำหรับทุกคำขอที่ส่งไปยังแบ็กเอนด์ รูปแบบมาตรฐานมักเป็น sk-... หรือคำนำหน้าอื่น ๆ ขึ้นอยู่กับการใช้งานของผู้ให้บริการ อย่างไรก็ตาม เนื่องจากคุณใช้ proxy อิสระ คำนำหน้าอาจแตกต่างกัน ปัจจัยสำคัญคือไม่ใช่รูปแบบ แต่คือการส่งคีย์ผ่านส่วนหัว HTTP Authorization เป็น Bearer <your_key> อย่างถูกต้อง

คีย์ API ของคุณผูกกับบัญชีและระดับการใช้งานเฉพาะ ต่างจากบริการบางแห่งที่สร้างคีย์หลายอันสำหรับสภาพแวดล้อมที่แตกต่างกัน (dev vs. prod) การตั้งค่าของเราเรียบง่าย: บัญชีหนึ่ง คีย์หนึ่ง หากคุณทำคีย์หายหรือสงสัยว่ามีการละเมิดความปลอดภัย คุณสามารถสร้างคีย์ใหม่ได้ทันทีจากแดชบอร์ดของคุณ สิ่งนี้จะเพิกถอนคีย์เก่าทันที รับรองว่าจะไม่มีการเข้าถึงโดยไม่ได้รับอนุญาตคงอยู่ จำเป็นต้องอัปเดตตัวแปรสภาพแวดล้อมหรือไฟล์กำหนดค่าของคุณทุกครั้งเมื่อหมุนคีย์

แนวปฏิบัติด้านความปลอดภัยที่ดีที่สุด

• เก็บคีย์ของคุณในตัวแปรสภาพแวดล้อม ไม่ใช่ในซอร์สโค้ดของคุณ
• อย่าคอมมิต codex api key ของคุณไปยังที่สาธารณะ
• ใช้ฟังก์ชัน regenerate หากสงสัยว่ามีการเปิดเผย

ข้อผิดพลาดทั่วไป: 401 ไม่ได้รับอนุญาต

ข้อผิดพลาด 401 Unauthorized เป็นปัญหาที่พบบ่อยที่สุดเมื่อผสานรวมคีย์ API ใหม่ มันบ่งชี้ว่าเซิร์ฟเวอร์ปฏิเสธข้อมูลรับรองการตรวจสอบสิทธิ์ของคุณ ในบริบทของ claude code proxy หรือเอนด์พอยต์ที่เข้ากันได้กับ OpenAI สิ่งนี้มักหมายถึงคีย์หายไป ไม่ถูกต้อง หรือหมดอายุ

เพื่อแก้ไขข้อผิดพลาด ให้ตรวจสอบก่อนว่าคุณคัดลอกคีย์ตามที่จัดเตรียมไว้อย่างถูกต้อง คีย์มักจะเป็นตัวพิมพ์ใหญ่-เล็กและอาจมีช่องว่างหากคัดลอกไม่ถูกต้อง ตรวจสอบว่าคุณใช้ base URL ที่ถูกต้องสำหรับภูมิภาคหรือระดับบริการของคุณ หากคุณสร้างคีย์ใหม่เมื่อเร็วๆ นี้ ตรวจสอบให้แน่ใจว่าไคลเอนต์ของคุณใช้ค่าใหม่ ข้อผิดพลาด 401 ไม่เกี่ยวข้องกับยอดเงินการใช้งานหรือขีดจำกัดอัตราของคุณ มันเป็นเพียงความล้มเหลวในการตรวจสอบสิทธิ์

รายการตรวจสอบสำหรับการแก้ไข

1. ยืนยันว่าสตริงคีย์ API ตรงกับแดชบอร์ดอย่างสมบูรณ์
2. ตรวจสอบรูปแบบหัว Authorization: Authorization: Bearer YOUR_KEY
3. ตรวจสอบว่า base URL ถูกต้องสำหรับประเภทบัญชีของคุณ
4. ตรวจสอบว่าไม่มีช่องว่างเพิ่มเติมที่เพิ่มระหว่างการคัดลอก-วาง

เกินขีดจำกัดอัตรา: ข้อผิดพลาด 429

เมื่อคุณเกินปริมาณคำขอที่อนุญาต API จะส่งข้อผิดพลาด 429 Too Many Requests สำหรับบริการของเรา ขีดจำกัดถูกตั้งค่าไว้ที่ 300 คำขอต่อนาทีต่อคีย์ ขีดจำกัดนี้ถูกบังคับใช้เพื่อให้แน่ใจว่าการใช้งานที่เป็นธรรมและรักษาเวลาแฝงต่ำสำหรับผู้ใช้ทุกคน หากคุณกำลังรันเซสชันการเขียนโค้ดปริมาณสูง คุณอาจถึงขีดจำกัดนี้ได้อย่างรวดเร็ว โดยเฉพาะอย่างยิ่งหากโค้ดของคุณกระตุ้นคำขอภายในหลายรายการ

เมื่อเกิดข้อผิดพลาด 429 การตอบกลับมักจะรวมหัว Retry-After ที่ระบุจำนวนวินาทีที่คุณควรรอก่อนลองใหม่ การ implement exponential backoff ในโค้ดไคลเอนต์ของคุณเป็นวิธีมาตรฐานในการจัดการข้อผิดพลาดเหล่านี้อย่างราบรื่น แทนที่จะลองใหม่ทันที ให้รอระยะเวลาสั้นๆ แล้วเพิ่มเวลารอเป็นสองเท่าสำหรับการลองใหม่ครั้งถัดไป สิ่งนี้ป้องกันไม่ให้แอปพลิเคชันของคุณท่วมเซิร์ฟเวอร์ด้วยคำขอในขณะที่รีเซ็ตขีดจำกัด

ควรสังเกตว่าขีดจำกัดอัตราเป็นต่อคีย์ ไม่ใช่ต่อบัญชี หากคุณมีอุปกรณ์หรือกระบวนการหลายรายการที่ใช้คีย์เดียวกัน พวกมันจะแบ่งปันงบประมาณ 300 คำขอ/นาที พิจารณาใช้คีย์แยกต่างหากสำหรับสภาพแวดล้อมที่แตกต่างกันหากคุณต้องการปริมาณงานรวมที่สูงขึ้น

กำหนดค่า Base URL ให้ถูกต้อง

Base URL เป็นพื้นฐานของการผสานรวม API ใดๆ สำหรับบริการที่เข้ากันได้กับ OpenAI base URL จะกำหนดว่าคำขอของคุณถูกส่งไปที่ใด base URL ของเราคือ https://api.claudecodeapikey.com/v1 URL นี้ต้องได้รับการกำหนดค่าในไลบรารีไคลเอนต์หรือ SDK ของคุณก่อนทำคำขอใดๆ หากคุณใช้ base URL ที่ผิด คุณจะรับข้อผิดพลาดการเชื่อมต่อหรือการตอบกลับที่ไม่คาดคิด

นักพัฒนาหลายคนใช้ SDK ทางการของ OpenAI สำหรับ Python, Node.js หรือภาษาอื่นๆ เพื่อเปลี่ยนไปใช้พร็อกซีของเรา คุณเพียงแค่อัปเดตการกำหนดค่า base URL เท่านั้น ตัวอย่างเช่น ใน Python คุณอาจตั้งค่า base_url='https://api.claudecodeapikey.com/v1' ตรวจสอบให้แน่ใจว่าโปรโตคอล (https) และเส้นทาง (/v1) ถูกต้อง การละเว้นเส้นทาง /v1 เป็นข้อผิดพลาดทั่วไปที่นำไปสู่ข้อผิดพลาด 404

ตรวจสอบเสมอว่าไคลเอนต์ของคุณส่งคำขอไปยังเอนด์พอยต์ที่ถูกต้อง คุณสามารถทำได้โดยตรวจสอบบันทึกเครือข่ายของคุณหรือใช้เครื่องมือเช่น curl เพื่อทดสอบการเชื่อมต่อ การเชื่อมต่อที่สำเร็จไปยัง base URL ยืนยันว่าการกำหนดค่าของคุณถูกต้อง

จัดการการตอบกลับแบบสตรีมมิง

การตอบกลับแบบสตรีมมิงช่วยให้คุณรับส่วนของการตอบกลับ API ขณะที่กำลังสร้าง แทนที่จะรอให้การตอบกลับทั้งหมดเสร็จสิ้น สิ่งนี้สำคัญมากสำหรับเอเจนต์การเขียนโค้ดที่แสดงตัวอย่างโค้ดแบบเรียลไทม์ API ของเรารองรับสตรีมมิงผ่าน Server-Sent Events (SSE) เมื่อคุณเปิดใช้งานสตรีมมิงในไคลเอนต์ของคุณ คุณจะรับสตรีมของชิ้นส่วน แต่ละชิ้นมีการตอบกลับบางส่วน

เพื่อเปิดใช้งานสตรีมมิง ให้ตั้งค่าพารามิเตอร์ stream เป็น true ในคำขอของคุณ ไลบรารีไคลเอนต์จะจัดการโปรโตคอล SSE โดยอัตโนมัติ คุณสามารถประมวลผลแต่ละชิ้นส่วนเมื่อมาถึง อัปเดต UI หรือบันทึกความคืบหน้า สิ่งนี้ให้ประสบการณ์ผู้ใช้ที่ดีขึ้น โดยเฉพาะสำหรับการสร้างโค้ดที่ยาวนาน

สตรีมมิงไม่เปลี่ยนโมเดลพื้นฐานหรือความสามารถของมัน เป็นเพียงกลไกการขนส่ง โมเดลยังคงประมวลผลพรอมต์ทั้งหมดและสร้างการตอบกลับเต็มรูปแบบ ความแตกต่างอยู่ที่วิธีการส่งเอาต์พุตไปยังไคลเอนต์ของคุณ

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.claudecodeapikey.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)

ปัญหาการกำหนดค่าการเรียกใช้เครื่องมือ

การเรียกใช้เครื่องมือ (หรือการเรียกใช้ฟังก์ชัน) ช่วยให้ LLM ขอการกระทำเฉพาะ เช่น การรันตัวอย่างโค้ดหรือสอบถามฐานข้อมูล API ของเรารองรับการเรียกใช้เครื่องมือ หมายความว่าคุณสามารถกำหนดฟังก์ชันในคำขอของคุณและรับการตอบกลับแบบ JSON ที่มีโครงสร้างจากโมเดล สิ่งนี้สำคัญมากสำหรับเอเจนต์การเขียนโค้ดขั้นสูงที่ต้องการโต้ตอบกับระบบภายนอก

เพื่อกำหนดค่าการเรียกใช้เครื่องมือ คุณต้องจัดเตรียมรายการคำจำกัดความของฟังก์ชันในพารามิเตอร์ tools เครื่องมือแต่ละอันควรมีชื่อ คำอธิบาย และสคีมาพารามิเตอร์ โมเดลจะตัดสินใจเมื่อเรียกใช้เครื่องมือตามพรอมต์ หากโมเดลตัดสินใจเรียกใช้เครื่องมือ การตอบกลับจะรวมอาร์เรย์ tool_calls ที่มีชื่อฟังก์ชันและอาร์กิวเมนต์

ปัญหาทั่วไปเกิดจากการกำหนดสคีมา JSON ที่ไม่ถูกต้อง ตรวจสอบให้แน่ใจว่าประเภทพารามิเตอร์และฟิลด์ที่ต้องการของคุณถูกระบุอย่างถูกต้อง หากสคีมาไม่ถูกต้อง โมเดลอาจล้มเหลวในการเรียกใช้เครื่องมืออย่างถูกต้อง ทดสอบคำจำกัดความเครื่องมือของคุณด้วยพรอมต์ง่ายๆ เพื่อยืนยันว่าโมเดลเข้าใจพฤติกรรมที่คาดหวัง

ขีดจำกัดหน้าต่างบริบท

หน้าต่างบริบทกำหนดปริมาณข้อความสูงสุดที่โมเดลสามารถประมวลผลในคำขอเดียว รวมถึงทั้งพรอมต์ (อินพุต) และการสร้างข้อความ (เอาต์พุต) โมเดลของเรามีหน้าต่างบริบทที่ 100,000 โทเคน นี่เป็นปริมาณข้อความที่สำคัญ แต่ไม่ใช่ไม่มีที่สิ้นสุด หากพรอมต์ของคุณบวกเอาต์พุตที่คาดหวังเกินขีดจำกัดนี้ API จะส่งข้อผิดพลาด

เพื่อจัดการบริบทอย่างมีประสิทธิภาพ ให้ตรวจสอบการใช้งานโทเคนของพรอมต์ของคุณ ไฟล์ที่ยาวหรือประวัติการสนทนาที่กว้างขวางสามารถบริโภคโทเคนที่มีอยู่ได้อย่างรวดเร็ว หากคุณเข้าใกล้ขีดจำกัด ให้พิจารณาตัดข้อความเก่าหรือสรุปการโต้ตอบก่อนหน้า ไคลเอนต์บางรายจัดการสิ่งนี้โดยอัตโนมัติโดยการเลื่อนหน้าต่าง แต่เป็นการดีที่สุดที่จะตระหนักถึงขีดจำกัดเพื่อหลีกเลี่ยงข้อผิดพลาดที่ไม่คาดคิด

จำไว้ว่าหน้าต่างบริบทรวมโทเคนทั้งหมดที่ส่งไปยังโมเดล รวมถึงข้อความระบบ ข้อความผู้ใช้ และข้อความผู้ช่วย วางแผนงบประมาณโทเคนของคุณตามนั้นเพื่อให้แน่ใจว่าการดำเนินงานที่ราบรื่นในช่วงเซสชันการเขียนโค้ดยาวนาน

สร้างคีย์ใหม่

การสร้างคีย์ API ใหม่เป็นกระบวนการง่าย ๆ ที่ช่วยรักษาความปลอดภัย หากคุณสงสัยว่าคีย์ของคุณอาจถูกเปิดเผยหรือต้องการหมุนเปลี่ยนข้อมูลประจำตัวเป็นระยะ คุณสามารถสร้างคีย์ใหม่จากแดชบอร์ดของคุณ คีย์เก่าจะถูกยกเลิกการใช้งานทันที ดังนั้นคำขอที่กำลังดำเนินการโดยใช้คีย์เก่าจะล้มเหลว

เมื่อคุณสร้างคีย์ใหม่ โปรดอัปเดตไคลเอนต์และการกำหนดค่าทั้งหมดของคุณด้วยค่าใหม่ รวมถึงตัวแปรสภาพแวดล้อม ไฟล์กำหนดค่า และค่าที่ระบุไว้ในโค้ดของคุณ การไม่อัปเดตทุกตำแหน่งอาจทำให้เกิดข้อผิดพลาดการตรวจสอบสิทธิ์สำหรับบางส่วนของแอปพลิเคชันของคุณ

บริการของเราอนุญาตให้สร้างคีย์ใหม่ได้ไม่จำกัดจำนวน ไม่มีการลงโทษสำหรับการหมุนเปลี่ยนคีย์ของคุณบ่อยครั้ง นี่เป็นแนวทางปฏิบัติที่ดีสำหรับการรักษาความปลอดภัย โดยเฉพาะในสภาพแวดล้อมที่ใช้ร่วมกันหรือเมื่อแจกจ่ายคีย์ให้กับสมาชิกในทีม

Copycurl https://api.claudecodeapikey.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'