Saltar para a documentação
API

Conceber um formulário a partir de uma descrição

Um designer cria um novo formulário de inscrição a partir de uma descrição escrita e guarda-o como rascunho, como faz Criar com IA na página Formulários da app.

POST/forms/design

Executa a chamada real no seu espaço de trabalho.

POST /forms/design

Um designer cria um novo formulário de inscrição a partir de uma descrição escrita e guarda-o como rascunho, como faz Criar com IA na página Formulários da app.

Exemplo

Requer forms:write. brief diz o que o formulário deve perguntar e dizer, até 4.000 caracteres. name é opcional, e o designer dá nome ao formulário quando o omite.

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."}'
Resposta
{  "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."]  }}

A resposta é o formulário inteiro, tal como GET /forms/{id} o devolve, com design.notes sobre o que o designer ajustou. Publique-o com POST /forms/{id}/publish.

Gasta uma ação de IA e pode demorar até meio minuto. Um design que não pode ser tornado válido dá 422 invalid_form, um espaço de trabalho que já tem tantos formulários quantos pode dá 422 workspace_limit_reached, um servidor sem modelo dá 409 ai_not_configured, e um espaço de trabalho sem ações de IA dá 429 ai_quota_exceeded. Em nenhum deles é criado nada.

Referência