दस्तावेज़ पर जाएँ
API

ब्रीफ़ से फ़ॉर्म डिज़ाइन करें

डिज़ाइनर लिखित ब्रीफ़ से एक नया साइन-अप फ़ॉर्म बनाता है और उसे ड्राफ़्ट के रूप में सहेजता है, जैसा ऐप के फ़ॉर्म पेज पर "AI से बनाएँ" करता है।

POST/forms/design

असली कॉल आपके वर्कस्पेस पर चलाता है।

POST /forms/design

डिज़ाइनर लिखित ब्रीफ़ से एक नया साइन-अप फ़ॉर्म बनाता है और उसे ड्राफ़्ट के रूप में सहेजता है, जैसा ऐप के फ़ॉर्म पेज पर "AI से बनाएँ" करता है।

उदाहरण

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 से प्रकाशित करें।

इसमें एक AI ऐक्शन लगता है और आधा मिनट तक लग सकता है। जो डिज़ाइन मान्य नहीं बनाया जा सकता वह 422 invalid_form है, जिस वर्कस्पेस में पहले से अधिकतम फ़ॉर्म हैं वह 422 workspace_limit_reached, बिना मॉडल वाला सर्वर 409 ai_not_configured, और जिस वर्कस्पेस के AI ऐक्शन खत्म हो गए वह 429 ai_quota_exceeded। इनमें से किसी में कुछ नहीं बनता।

संदर्भ