Codex API documentation and endpoints

כתובת URL בסיסית ואימות

שלח בקשות לכתובת ה-URL הבסיסית https://api.codexapipricing.com/v1 באמצעות מפתח ה-API שלך. נקודת הקצה הזו תואמת לספריות לקוח סטנדרטיות של OpenAI, כך שיש רק לעדכן את כתובת הבסיס ולספק את המפתח שלך. אשר על ידי העברת הכותרת Authorization: Bearer YOUR_API_KEY עם כל בקשה. ניתן ליצור מפתח מיד על ידי התחברות עם Google או אימייל וסיסמה. המפתח מוצג פעם אחת לאחר יצירתו, לכן שמור אותו בצורה מאובטחת. הפרומפטים שלך לא משמשים לאימון, מה שמבטיח פרטיות לנתונים שלך.

נקודת קצה להשלמות צ'אט

השתמשו ב POST /v1/chat/completions נקודת קצה (endpoint) ליצירת טקסט. זהו הממשק הראשי לשליחת הנחיות וקבלת תגובות. מזהה המודל הוא תמיד uncensored, ללא קשר לגרסת המודל הפועלת בשרתים שלנו. אתם יכולים לבדוק מודלים זמינים דרך GET /v1/models. שלחו את היסטוריית ההודעות שלכם ב- messages

פרמטרים נתמכים ומצב JSON

שלוו יצירה באמצעות פרמטרים כמו temperature, top_p, וכן stop. השתמש ב response_format מוגדר ל {"type": "json_object"} כדי לכפות פלט JSON. זה שימושי לחילוץ נתונים מבניים או קריאה לפונקציות. ניתן גם להגדיר max_tokens להגביל את אורך הפלט, עם ברירת מחדל של 2,048 אם לא צוין. חלון ההקשר תומך עד 100,000 טוקנים לשילוב של פרומפט והשלמה. העבר seed לתוצאות דטרמיניסטיות או presence_penalty וגם frequency_penalty להתאים חזרתיות. פרמטרים אלו מאפשרים עדינות התנהגות המודל ללא תצורה מורכבת. מצב JSON מבטיח עיצוב קפדני לפיענוח אמין באפליקציה שלכם.

תגובות בזרם באמצעות SSE

אפשרו זרימה על ידי הגדרת stream: true בבקשה שלך. ה-API מחזיר אירועים שנשלחים מהשרת (SSE) כפי שנוצרים טוקנים. זה מפחית את תחושת השהייה עבור תגובות ארוכות. עבד על הזרם כדי להציג טקסט באופן עוקב. תכונה זו עובדת עם כל ה-SDKs התואמים ל-OpenAI. זרימה אידיאלית לממשקי צ'אט שבהם משתמשים מצפים למשוב מיידי. הקטע האחרון מכיל את ספירת הטוקנים הכוללת לדיוק בחיוב. השתמש בשיטה זו כדי לטפל בפלטים גדולים ברכות בלי לחכות לתגובה מלאה.

מגבלות קצב וגופי בקשה

כל מפתח API מוגבל ל-300 בקשות לדקה ו-8 בקשות מקבילות. גודל גוף הבקשה המקסימלי הוא 8 MB. אם תחרוג ממגבלות אלו, תקבל שגיאת 429. ניתן ליצור מפתחות חדשים כדי להחליף קיימים, אך רק מפתח אחד פעיל לכל חשבון. שגיאות ודחייות אינן נספרות כנגד מגבלת הקצב שלך. חלון ההקשר של 100,000 טוקנים מאפשר היסטוריית שיחה נרחבת. שמור על גופי בקשות תמציתיים כדי להישאר בתוך מגבלות הגודל. עקוב אחר השימוש שלך כדי להימנע מהפרעות בשעות עומס. מגבלות אלו מבטיחות שימוש הוגן עבור כל הלקוחות בתשלום מראש.

טיפול בשגיאות ופתרון תקלות

טפול בשגיאות על ידי בדיקת קוד הסטטוס של HTTP. שגיאה 401 מצביעה על מפתח API לא חוקי או חסר. שגיאה 402 אומרת שהאשראי המקדים שלך אזל. שגיאה 429 מסמנת שחרגת מגבולי הקצב. השתמש ב error field in the response to get details. Mistakes like double charges are fixed via the Support page. Credit never expires, so you can top up later. Refusals for content policy violations are free. This predictable error structure helps you debug integration issues quickly without guessing the cause.

cURL

Copycurl https://api.codexapipricing.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the hourly rates for the large model."}]
  }'

Python

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.codexapipricing.com/v1", apiKey: process.env.API_KEY });

const resp = await client.chat.completions.create({
  model: "uncensored",
  messages: [{ role: "user", content: "Draft a villain monologue for my game." }],
});
console.log(resp.choices[0].message.content);

זרימה

Copystream = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Tell the story in second person."}],
    stream=True,
)
for chunk in stream:
    if chunk.choices and chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="", flush=True)