واجهة المطوّرين API

أنشئ مهام معالجة المستندات، وتابع تقدّمها، ونزّل النتائج عبر واجهة API قياسية.

Add to Agent

استخدم HumanPen من Claude Code أو Codex أو Cursor أو أي وكيل برمجي. تستهلك الطرق الثلاث الرصيد نفسه.

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

التعليمة
Install the HumanPen skill by following the instructions at https://humanpen.net/install/skill-install.md

كل طريقة تتطلب مفتاح API.

الحصول على مفتاح API

نظرة عامة

واجهة HumanPen API مصمّمة للتكامل من جانب الخادم. يمكنك رفع مستند وإنشاء مهمة معالجة غير متزامنة في طلب واحد، ثم الاستعلام عن التقدّم وتنزيل النتيجة القابلة للتحرير عبر رابط مؤقت.

المسار الأساسي لـ API
https://api.humanpen.net/v1
صيغة الاستجابة
تُعيد واجهات الأعمال بنية JSON موحّدة؛ وتُعيد واجهات المحتوى بيانات ثنائية. يستخدم مخطط OpenAPI صيغة JSON القياسية.

المصادقة

أنشئ مفتاحاً من قسم "مفاتيح API"، وأرسله كـ Bearer Token في ترويسة Authorization مع كل طلب محمي. يمكنك إعادة نسخ المفتاح الكامل من قائمة المفاتيح في أي وقت.

HTTP
Authorization: Bearer hp_xxx

مفاتيح API مخصصة للخدمات الخلفية فقط. لا تضعها في المتصفح أو تطبيقات الهاتف أو المستودعات العامة أو سجلات العميل.

أنشئ مهمتك الأولى

أرسل المستند وإعدادات المعالجة في طلب واحد، ثم استعلم عن التقدّم باستخدام معرّف المهمة المُعاد.

curl -X POST "https://api.humanpen.net/v1/jobs/humanize" \
  -H "Authorization: Bearer $HP_API_KEY" \
  -F "file=@paper.docx" \
  -F "turnitin_file=@turnitin-report.pdf" \
  -F "strategy=balanced" \
  -F "additional_instructions=Keep terminology and citations unchanged."

مرجع الواجهات

تُعرض الواجهات الأساسية بترتيب الاستدعاء. وسّع أي واجهة لعرض المعاملات وجسم الطلب وأنواع الحقول والحقول المطلوبة واستجابات النجاح ورموز الخطأ.

جارٍ قراءة مخطط OpenAPI...

موارد مرجعية

OpenAPI هو العقد الهيكلي الوحيد للواجهات؛ docs.md هو دليل التكامل الكامل القابل للقراءة، وllms.txt هو فهرس مختصر يساعد الوكلاء على اكتشاف هذه الموارد.

الاستجابات واستكشاف الأخطاء

تتضمن استجابات JSON للنجاح والفشل حقول code وmessage وdata ثابتة؛ وتظل رموز حالة HTTP تصف نتيجة الطلب.

X-Request-ID

تتضمن كل استجابة معرّف طلب. أرفقه عند التواصل مع الدعم لربط سجلات API وقائمة الانتظار وعمال المعالجة (worker).