ドキュメント本文へスキップ
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 アクションを 1 回使い、最大 30 秒ほどかかります。有効にできないデザインは 422 invalid_form、すでに上限までフォームがあるワークスペースは 422 workspace_limit_reached、モデルのないサーバーは 409 ai_not_configured、AI アクションを使い切ったワークスペースは 429 ai_quota_exceeded です。どの場合も何も作成されません。

リファレンス