تخطَّ إلى المستندات
API

تصميم نموذج انطلاقًا من وصف

يبني المصمِّم نموذج تسجيل جديدًا انطلاقًا من وصف مكتوب ويحفظه مسودة، كما يفعل «إنشاء بالذكاء الاصطناعي» في صفحة النماذج في التطبيق.

POST/forms/design

ينفّذ الاستدعاء الحقيقي على مساحة عملك.

POST /forms/design

يبني المصمِّم نموذج تسجيل جديدًا انطلاقًا من وصف مكتوب ويحفظه مسودة، كما يفعل «إنشاء بالذكاء الاصطناعي» في صفحة النماذج في التطبيق.

مثال

يتطلب forms:write. يذكر brief ما يجب أن يسأله النموذج ويقوله، حتى 4,000 حرف. وname اختياري، ويسمّي المصمِّم النموذج حين تتركه.

curl
curl -X POST "$OE/forms/design" -H "$AUTH" -H 'content-type: application/json' -d '{  "brief": "A waitlist for our beta: email, first name and company, with a line on what joining means. A dark green button that says Join the waitlist."}'
الاستجابة
{  "object": "form",  "id": "frm_7d1f3b5a9c2e48f06b1d3f5a",  "name": "Beta waitlist",  "status": "draft",  "design": {    "notes": ["Made the company field optional, since the brief did not ask for it to be required."]  }}

الإجابة هي النموذج كاملًا، كما يعيده GET /forms/{id}، مع design.notes عمّا عدّله المصمِّم. انشره بـPOST /forms/{id}/publish.

يستهلك إجراء ذكاء اصطناعي واحدًا وقد يستغرق نصف دقيقة. التصميم الذي لا يمكن جعله صالحًا يعطي 422 invalid_form، ومساحة العمل التي تضم بالفعل أقصى عدد مسموح من النماذج تعطي 422 workspace_limit_reached، والخادم الذي لا نموذج لديه يعطي 409 ai_not_configured، ومساحة العمل التي نفدت إجراءات الذكاء الاصطناعي لديها تعطي 429 ai_quota_exceeded. ولا يُنشأ شيء في أي منها.

المرجع