المراجعة العامة لـ API
On this page
Curriculo API هو RESTful API في https://api.curriculo.me/public الذي يمنح الوصول البرمجي إلى نفس السيرة الذاتية والتقييم واللغة ومحركات المقابلة التي تعمل داخل منتج Curriculo. الطلبات هي JSON أو multipart/form-data؛ الإجابات هي JSON.
جديداً في Curriculo؟ ابدأ بـ Quickstart: إنشاء حساب وإصدار مفتاح وإجراء مكالمة واحدة.
الشروط المسبقة
- حساب المطور Console
- مفتاح API تم إنشاؤه في Console → مفتاح API
إدارة التطبيقات المتاحة
| API | العملية | ما الذي تفعله | السعر |
|---|---|---|---|
| أبحاث | POST /parse/ | قراءة السيرة الذاتية (PDF أو DOCX) إلى JSON المهيكلة. | $0.01 لكل طلب |
| تقييم | POST /evaluate/ | تقدير السيرة الذاتية مقابل وظيفة: الملاءمة، تحليل الملاءمة، الفجوات. | $0.01 لكل طلب |
| الوظائف | POST /jobs/ | اختيارياً تسجيل وصف الوظيفة مرة واحدة وإعادة استخدامها job_id. | مجاناً |
| ترجمة | POST /translate/ | ترجمة السلاسل أو وثائق PDF و DOCX. | $0.01 لكل طلب (انظر أسعار ) |
| اكتشاف اللغة | POST /detect-language/ | رمز ISO 639-1 لنص واحد أو ما يصل إلى 200. | $0.001 لكل طلب |
| ملخص المقابلة | POST /summary/ | أبرز العلامات والمهارات وتوصية بتوظيف من نسخة أو تسجيل. | $0.01، زائد $0.002 للدقيقة لتسجيلات |
| نقل | POST /transcribe/ | نسخة من تسجيل، لا ملخص. | $0.002 للدقيقة |
| بسرعة | POST /prompt/ | إنشاء، تحرير، ترجمة أو استجواب السيرة الذاتية المرتبطة بطاقة الاعتماد الخاصة بك. -ممتاز . | $0.01 لكل طلب |
| مقابلة الفحص | POST /screening-interview | استضافة، مسجلة مقابلات العرض مع ردات المكالمات الموقعة. | $0.02 لكل دعوة مرسلة |
مهام الخلفية
تشغيل البحث والتقييم والإجمالي والنسخ والترجمة أيضاً في الخلفية: POST /{op}/async يجيب على 202 مع task_id في وقت واحد، وتجمع النتيجة مع GET /{op}/tasks/{task_id} أو تتلقىها عن طريق الاتصال الموقع. انظر معالجة الخلفية والردود.
الطرق
تعمل العمليات المزامنة في نهاية المرحلة المتأخرة (/parse/). يتم توثيق مسارات المهام الخلفية (/parse/async،/parse/tasks/{task_id}) ومسارات التفتيش (/screening-interview) دون واحدة.
للحصول على المواصفات الكاملة ، انظر OpenAPI وثيقة، أو تصفحها في Swagger UI أو ReDoc.
التصديق
| الرأس | القيمة | المطلوب |
|---|---|---|
Authorization | Bearer key_<id>_<secret>، مفتاحك للقناة API | نعم |
Content-Type | application/json أو multipart/form-data، اعتماداً على العملية | نعم، بناء على طلبات مع جثة |
مفاتيح الكونسول واحدة تسمح بكل عملية، على الفور. لا توجد أوراق اعتماد لكل نقطة نهاية، لا توجد نطاقات ولا شيء يمكنه تمكينها. انظر مؤكدة .
لا يوجد عنوان نسخة API. يتم نسخة السطح عن طريق المسار، وتغيرات إضافية (حقول اخيارية جديدة، عمليات جديدة) السفن دون كسر المكالمات القائمة.
القاعدة URL
https://api.curriculo.me/publicتوجيه عميلك إلى تلك القاعدة وإضافة مسار العملية، على سبيل المثال https://api.curriculo.me/public/parse/.
- شهادة واحدة في كل مكان مفتاح واحد للقناة يصدّق كل عملية.
- الحدود التي تطبق لكل مفتاح، بحيث لا يمكن لتكامل ضجيج واحد لا تنفق ميزانية أخرى.
- الطلبات الفاشلة لا تتقاضى أبداً A
4xxأو5xxلا يكلفك شيئا.
إنتاج هو البيئة المنشورة الوحيدة.
صيغة الطلب والرد
انظر طلبات وردود. النسخة القصيرة:
/parse/,/evaluate/,/prompt/و أخذ/transcribe/multipart/form-data./detect-language/و أخذ/jobs/application/json./translate/و/summary/تأخذapplication/json، أوmultipart/form-dataلإرسال المستندات أو التسجيلات.- وثيقة واحدة يمكن أن تصل إلى 10 MB. جسم الطلب يمكن أن يصل إلى 12 MB ، باستثناء
/summary/، الذي يقبل تسجيلات تصل إلى 100 MB. - أرسل شيئا واحدا، احصل على شيء ذلك الشيء. أرسل عدة، الحصول على النتائج في ترتيب المدخلات.
التجميع
لا توجد نقطة نهاية منفصلة للشحنة: القائمة هي الشحنة. ما يصل إلى 10 وثائق لكل طلب للتحليل والتقييم، وما يصل إلى 200 نصوص للترجمة واكتشاف اللغة. انظر: Batching.
حدود أسعار
| الحد | القيمة |
|---|---|
| لكل مفتاح API | 600 طلب في الدقيقة |
| لكل عنوان IP | 2000 طلب في الدقيقة |
| العمل الثقيل (التحليل والتقييم والإجراءات الملخصة) | 3 عمليات في وقت واحد، مشتركة عبر الخدمة؛ طلبات إضافية في صف |
| تطلب توقيت | 300 ثانية |
الأخطاء
الأخطاء هي JSON وتحمل حالة HTTP التي تهم. كل استجابة تحمل عنوان X-Curriculo-Request-Id للإقتباس لدعم. انظر الأخطاء.
إدارة حسابك
يتم إدارة المفاتيح والاستخدام والفواتير في Developer Console. مفتاحكِ API يعمل في توظيف الأشخاص لا يمكنها عمداً صياغة المفاتيح أو تغيير الفواتير، لذا لا يمكن أبداً أن تتحول المفتاح المتسرب إلى مراقبة الحساب.
الخطوات التالية
- Quickstart: حساب، مفتاح، أول مكالمة في ثلاث خطوات.
- معالجة الخلفية والردود: عمل طويل دون الحفاظ على اتصال مفتوح.
- SDKs العميل: توليد العميل المختطم من مواصفات OpenAPI.
- API الإشارة: كل حقل لكل عملية.
Updated