المطورون / الوكلاء

إضافة صفحة ويب أو موقع إلى وكيل

POST https://api.echonova.ai/v1/agents/{agentId}/knowledge/web

تُضيف صفحة https عامة، أو موقعًا يُزحف منها (حتى 3 روابط في العمق و50 صفحة)، إلى قاعدة معرفة مساحة العمل وإلى هذا الوكيل. تُقرأ في الخلفية ولا تُعاد قراءتها وفق جدول زمني؛ وتعرض `GET /v1/agents/{agentId}/knowledge` حالتها. إذا كان الرصيد فارغًا تردّ الواجهة بالرمز 402. بحد أقصى 20 طلبًا في الدقيقة لكل مفتاح. يحتاج المفتاح إلى النطاق `agents:write`. تستهلك الفهرسة رصيد مساحة العمل، ولا تُحتسب ضمن حد رصيد مفتاح الواجهة.

Headers

Authorization string مطلوب

كلمة ⁦Bearer⁩ ثم مسافة ثم مفتاح ⁦API⁩ الذي يبدأ بـ ⁦ek_⁩. أنشئ المفاتيح في البوابة من المطورون، ثم مفاتيح واجهة برمجة التطبيقات.

معاملات المسار

agentId string مطلوب

معرّف الوكيل كما أعادته `GET /v1/agents`.

متن الطلب

application/json

url string مطلوب

رابط https عام. تُرفض العناوين الخاصة وعناوين loopback وlink-local، والروابط التي تحمل اسم مستخدم أو كلمة مرور.

حتى 2000 حرفًا
name string اختياري

اسم المصدر. اتركه فارغًا لاستخدام الرابط.

حتى 200 حرفًا
type string اختياري

`single_url` يقرأ صفحة واحدة؛ و`website` يتبع الروابط منها.

single_url أو websiteالافتراضي single_url
depth integer اختياري

للموقع: كم مستوى من الروابط يُتبع.

من 1 إلى 3
maxUrls integer اختياري

للموقع: أكبر عدد من الصفحات تُقرأ.

من 1 إلى 50

الاستجابة

200 application/json كل استجابة تستخدم هذا الغلاف.

data object

النتيجة.

success boolean

قيمته ⁦true⁩ عند نجاح الطلب.

statusCode integer

يكرر رمز حالة ⁦HTTP⁩.

errorMessage string or null

قيمته ⁦null⁩ عند النجاح.

الأخطاء

الغلاف نفسه، مع ⁦success⁩ بقيمة ⁦false⁩ و ⁦data⁩ بقيمة ⁦null⁩. كل الأخطاء

POST /v1/agents/{agentId}/knowledge/web

curl -X POST "https://api.echonova.ai/v1/agents/{agentId}/knowledge/web" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/faq"}'

{
  "data": {
    "id": "6653a1b2c3d4e5f6a7b8c9d0",
    "name": "Price list",
    "kind": "file",
    "status": "ready"
  },
  "success": true,
  "statusCode": 200,
  "errorMessage": null
}