مرجع واجهة البرمجة

كل ما يستطيع ذكاؤك الاصطناعي — أو أنت — استدعاءه: المناهج المدرسية، الاختبار نفسه، الصور، ملفات PDF، ومؤشر العمل.

طريقة المصادقة

تحتاج طلبات الاختبار إلى Authorization: Bearer مع مفتاح الاختبار. أرسل If-Match مع رقم الإصدار الحالي حتى لا يمحو حفظان بعضهما. هذه الردود لا تُخزَّن مؤقتًا أبدًا.

افتح المخطط الكامل

عنوان الأساس

https://quiz.ai/api/v1

طريقة المصادقة

Authorization: Bearer <quiz-scoped-key>

خريطة واجهة API

GET
/api/v1

خريطة لواجهة البرمجة والروابط التي تليها.

لا حاجة لمفتاح
GET
/api/v1/openapi.json

مخطط OpenAPI 3.1 الكامل — مفيد للأدوات التي تستطيع قراءته.

لا حاجة لمفتاح

المناهج المدرسية

GET
/api/v1/curricula

اعرض المناهج المدرسية التي نعرفها.

لا حاجة لمفتاح
GET
/api/v1/curricula/{curriculumId}

اقرأ تفاصيل منهج واحد.

لا حاجة لمفتاح
GET
/api/v1/curricula/{curriculumId}/objectives?subject=math&grade=5&limit=100&offset=0

ابحث في أهداف التعلم لمنهج حسب المادة والصف.

لا حاجة لمفتاح

الاختبار

GET
/api/v1/target

اعرف أي اختبار يُسمح لهذا المفتاح بالكتابة فيه.

مفتاح الاختبار
GET
/api/v1/quizzes/{quizId}

اقرأ الاختبار الحالي ورقم إصداره.

مفتاح الاختبار
PUT
/api/v1/quizzes/{quizId}

استبدل الاختبار كله في حفظ واحد. أرسل If-Match حتى لا تمحو عملًا أحدث.

مفتاح الاختبار
POST
/api/v1/quizzes/{quizId}/publish

راجع الاختبار واجعله عامًا. أرسل If-Match حتى لا تمحو عملًا أحدث.

مفتاح الاختبار

الصور

POST
/api/v1/quizzes/{quizId}/images

ارفع PNG أو JPEG أو GIF أو WebP. نخزّن WebP ثابتًا نظيفًا.

مفتاح الاختبار
POST
/api/v1/quizzes/{quizId}/images/templates

ارسم صورة سؤال من قالب، أو عاينها كـ PNG أو SVG.

مفتاح الاختبار
GET
/api/v1/quizzes/{quizId}/images/{imageId}

نزّل صورة مخزّنة. طلبات النطاق مدعومة.

مفتاح الاختبار
DELETE
/api/v1/quizzes/{quizId}/images/{imageId}

احذف صورة لا يستخدمها أي سؤال.

مفتاح الاختبار
صور الأسئلة

ملفات PDF والنشاط

POST
/api/v1/quizzes/{quizId}/activity

ابدأ أو حدّث أو أوقف إشارة «ما زال يعمل» لمدة 90 ثانية.

مفتاح الاختبار
GET
/api/v1/quizzes/{quizId}/sheet.pdf?names=Alice,Bob&class=5B&key=0

نزّل ورقة إجابات للطباعة. يمكنك إضافة أسماء وصف ومفتاح إجابات.

مفتاح الاختبار

احفظ الاختبار كاملًا

يرسل ذكاؤك الاصطناعي العنوان والوصف واللغة وكل سؤال دفعة واحدة. إرسال الاختبار الصالح نفسه مرتين آمن.

HTTP
PUT /api/v1/quizzes/qz_7KF2M9qTx3aB
Authorization: Bearer <quiz-scoped-key>
Content-Type: application/json
If-Match: "0"

{
  "title": "A quick tour of the Solar System",
  "description": "Ten friendly questions for curious adults.",
  "language": "en-gb",
  "questions": [
    {
      "prompt": "Which planet has the shortest year?",
      "choices": ["Mercury", "Venus", "Earth", "Mars"],
      "correctChoiceIndex": 0,
      "explanation": "Mercury orbits the Sun in about 88 Earth days."
    }
  ]
}

قواعد الأسئلة

  • كل سؤال يحتاج صياغة واضحة وخيارين إلى ستة خيارات غير فارغة.
  • الحدود: العنوان 140 حرفًا، الوصف 1,000، 1–100 سؤال، الصياغة 500، كل خيار 240، الشرح 1,000.
  • correctChoiceIndex هو فهرس الخيار الصحيح بدءًا من الصفر.
  • ترتيب الأسئلة هو ترتيب المصفوفة — الأول في القائمة هو السؤال 1.
  • أرسل أحدث رقم إصدار في ترويسة If-Match حتى لا يمحو حفظان بعضهما.

انشر عندما يبدو صحيحًا

النشر يراجع الاختبار مرة أخرى ويعطيك رابطًا عامًا ثابتًا. إن نقص شيء، أصلحه، احفظ من جديد، ثم انشر.

HTTP
POST /api/v1/quizzes/qz_7KF2M9qTx3aB/publish
Authorization: Bearer <quiz-scoped-key>
If-Match: "1"