مرجع API — كل نقاط النهاية
القائمة الكاملة لنقاط نهاية GetVibe API مع الطريقة والمسار والوصف ونوع المصادقة. النقاط مجمّعة حسب الفئة. عنوان الأساس لـ/v1/* هو https://getvibeapi.com/v1؛ ولـ/api/* هو https://getvibeapi.com.
يتوفر مواصفة OpenAPI 3.0 قابلة للقراءة آليًا على /api/openapi — استوردها في Postman أو Swagger UI أو أي أداة متوافقة مع OpenAPI.
الكتالوجات العامة
/api/catalog و/api/media-catalog متاحة دون مفتاح — استخدمها لواجهات المتاجر وحسابات الأسعار واكتشاف النماذج قبل التسجيل.المحادثة والإكمالات
| الطريقة | النقطة الطرفية | الوصف | المصادقة |
|---|---|---|---|
| POST | /v1/chat/completions | نقطة نهاية دردشة متوافقة مع OpenAI. | Bearer |
| POST | /v1/messages | نقطة نهاية بصيغة Anthropic Messages. المسار الخاص بـ Claude Code وAnthropic SDK. | x-api-key / Bearer |
| POST | /v1/responses | OpenAI Responses API. المسار الخاص بـ Codex CLI (wire_api = "responses"). | Bearer |
| POST | /v1/messages/count_tokens | نقطة نهاية تجريبية لعدّ الرموز خاصة بـ Anthropic SDK / Claude Code (تقدير، وليس مُرمِّزًا دقيقًا). | x-api-key / Bearer |
النماذج والأسعار
| الطريقة | النقطة الطرفية | الوصف | المصادقة |
|---|---|---|---|
| GET | /v1/models | النماذج المتاحة مع النوع والوسائط ونقاط النهاية. الوسائط عند الطلب: ?type=image أو ?all=true أو /v1/models/all؛ ونموذج واحد: /v1/models/{id}. | Bearer |
| GET | /v1/pricing | المصدر البرمجي المعياري للأسعار لنماذج النصوص، بما في ذلك التجاوزات المباشرة من المشغّل. | Bearer |
| POST | /v1/embeddings | تضمينات النصوص لأغراض البحث وRAG والعنقدة. | Bearer |
| POST | /v1/decisions | قيّم أسئلة محدّدة بالاسم مقابل حالة (نص->قرارات). ليست نقطة طرفية للمحادثة؛ وتُفوتر على رموز الإدخال فقط. | Bearer |
الوسائط
| الطريقة | النقطة الطرفية | الوصف | المصادقة |
|---|---|---|---|
| POST | /api/media/generate | توليد الوسائط غير المتزامن (صورة/فيديو/صوت/موسيقى/3d). يعيد jobId لتتبّع الحالة. | Bearer |
| GET | /api/media/jobs/{id} | استعلم عن حالة مهمة توليد وسائط غير متزامنة. | Bearer |
| GET | /api/media/file/{id}/{idx} | رابط وكيل موقّع لنتيجة (HMAC في وسيط الاستعلام sig). بدون مفتاح — للتضمين في <img>/<video>. | sig (HMAC) |
| GET | /api/media-catalog | الفهرس العام لنماذج الوسائط: النوع، المتغيرات، المعاملات، fromRub، المحاور. | public |
الفوترة والاستخدام
| الطريقة | النقطة الطرفية | الوصف | المصادقة |
|---|---|---|---|
| GET | /v1/balance | الرصيد المدفوع مسبقًا المتبقي بالدولار الأمريكي. | Bearer |
| GET | /v1/generations | سجلّ الاستخدام مع route / address_as (المسار العام) وrequest_id والترقيم الصفحي. | Bearer |
| GET | /v1/generations/{id} | مدخل واحد من سجل الاستخدام بالمعرّف (من استجابة /v1/generations أو الترويسة x-pv-generation-id). | Bearer |
| GET | /v1/usage | إحصاءات استخدام لكل مفتاح مع حقلي route و address_as. | Bearer |
| GET | /api/key/usage | ملخص لكل مفتاح: الرصيد، وإنفاق اليوم/الشهر، وعدد الطلبات. | Bearer / x-api-key |
التوجيه
| الطريقة | النقطة الطرفية | الوصف | المصادقة |
|---|---|---|---|
| ANY | x-getvibe-route / x-getvibe-model | ترويسات الاستجابة لعملاء الكشف/التصحيح الموثوقين فقط: الحقلان العامان :alias و address_as للمسار الفائز. | response headers |
المقامات
| الطريقة | النقطة الطرفية | الوصف | المصادقة |
|---|---|---|---|
| GET | /v1/keys | قائمة مفاتيح API الخاصة بالحساب. | Bearer |
| POST | /v1/keys | غير متاح عبر API. أنشئ المفاتيح وأدرها في لوحة التحكم فقط (قسم Keys). | — (UI only) |
الدعم
| الطريقة | النقطة الطرفية | الوصف | المصادقة |
|---|---|---|---|
| POST | /v1/tickets | افتح تذكرة دعم (JSON أو multipart مع لقطات شاشة). مفتاح API أو جلسة لوحة التحكم. | Bearer |
| GET | /v1/tickets | اعرض تذاكرك، الأحدث أولًا، مع ترقيم مؤشر (cursor). | Bearer |
| GET | /v1/tickets/{id} | حالة التذكرة والمحادثة الكاملة مع ردود الدعم. | Bearer |
| POST | /v1/tickets/{id}/messages | أضف رسالة متابعة إلى تذكرتك. | Bearer |
| POST | /v1/tickets/{id}/close | أغلق تذكرتك. | Bearer |
| POST | /v1/technical-feedback | اسم بديل قديم لـ POST /v1/tickets للتقارير الفنية؛ بالحقول نفسها كما في السابق. | Bearer |
الـ webhooks
| الطريقة | النقطة الطرفية | الوصف | المصادقة |
|---|---|---|---|
| GET | /api/webhooks | عناوين Webhook الحالية (mediaWebhookUrl، balanceWebhookUrl). لجلسة لوحة التحكم فقط. | session (dashboard) |
| PATCH | /api/webhooks | عيّن أو امسح mediaWebhookUrl / balanceWebhookUrl. جلسة لوحة التحكم فقط. | session (dashboard) |
الفهارس العامة
| الطريقة | النقطة الطرفية | الوصف | المصادقة |
|---|---|---|---|
| GET | /api/catalog | الفهرس العام لنماذج النصوص (دون مصادقة). يستخدمه الموقع لواجهة المتجر. | public |
| GET | /api/media-catalog | الفهرس العام لنماذج الوسائط (الأنواع، الأسعار لكل وحدة، المعاملات، المحاور). | public |