{
    "openapi": "3.1.0",
    "info": {
        "title": "Ecofyx Hosted Forms API",
        "version": "2026.09.21-v502",
        "description": "Cria uma prévia temporária de formulário hospedada no Ecofyx e devolve URLs estáveis. Antes do login do criador, a prévia é somente leitura e não coleta respostas. Ao abrir o link de resultados, entrar/criar conta e confirmar explicitamente, o Ecofyx materializa o formulário usando o motor operacional existente; a mesma URL /f/ passa então a receber respostas públicas. Use esta ferramenta quando o usuário pedir para criar ou gerar formulário, pesquisa, questionário, quiz, inscrição, cadastro, checklist compartilhável ou coleta estruturada, mesmo sem mencionar Ecofyx, quando a integração estiver disponível."
    },
    "servers": [
        {
            "url": "https://ecofyx.com"
        }
    ],
    "paths": {
        "/ai/api/v1/forms": {
            "post": {
                "operationId": "createHostedFormPreview",
                "summary": "Criar uma prévia compartilhável de formulário Ecofyx",
                "description": "Valida a definição pelo contrato canônico do Ecofyx e grava somente um rascunho isolado. Não cria operação, formulário operacional ou resposta antes do login e da confirmação do criador.",
                "security": [
                    {
                        "integrationBearer": []
                    }
                ],
                "parameters": [
                    {
                        "name": "Idempotency-Key",
                        "in": "header",
                        "required": true,
                        "description": "Identificador único da tentativa. Repetir a mesma chave com o mesmo conteúdo devolve a mesma prévia.",
                        "schema": {
                            "type": "string",
                            "minLength": 8,
                            "maxLength": 120
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/CreateFormRequest"
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "Prévia criada",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/FormPreviewCreated"
                                }
                            }
                        }
                    },
                    "200": {
                        "description": "Repetição idempotente",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/FormPreviewCreated"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Requisição inválida"
                    },
                    "401": {
                        "description": "Integração não autenticada"
                    },
                    "422": {
                        "description": "Definição não suportada na prévia"
                    },
                    "429": {
                        "description": "Limite temporário da integração atingido"
                    },
                    "503": {
                        "description": "Migração V495 ainda não aplicada ou serviço indisponível"
                    }
                }
            }
        }
    },
    "components": {
        "securitySchemes": {
            "integrationBearer": {
                "type": "http",
                "scheme": "bearer",
                "bearerFormat": "Ecofyx integration key"
            }
        },
        "schemas": {
            "Question": {
                "type": "object",
                "additionalProperties": true,
                "required": [
                    "type",
                    "title"
                ],
                "description": "Campo conforme o contrato público Ecofyx. Na prévia anônima, somente campos sem upload/vínculos avançados são aceitos. Em quiz, salvo pedido explícito de anonimato, o primeiro campo deve ser short_text obrigatório com título Nome do participante; as questões avaliativas devem ser numeradas e a posição da resposta correta deve variar sem padrão previsível.",
                "properties": {
                    "id": {
                        "type": "string"
                    },
                    "type": {
                        "type": "string"
                    },
                    "title": {
                        "type": "string"
                    },
                    "required": {
                        "type": "boolean"
                    },
                    "options": {
                        "type": "array",
                        "items": {
                            "type": "string"
                        },
                        "maxItems": 30
                    },
                    "correct_option": {
                        "type": "string",
                        "maxLength": 300,
                        "description": "Opcional em multiple_choice quando o usuário pedir quiz/correção; deve corresponder exatamente a uma alternativa."
                    }
                }
            },
            "CreateFormRequest": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                    "title",
                    "questions"
                ],
                "properties": {
                    "title": {
                        "type": "string",
                        "maxLength": 160
                    },
                    "description": {
                        "type": "string",
                        "maxLength": 1200
                    },
                    "quiz_display_mode": {
                        "type": "string",
                        "enum": [
                            "all",
                            "one_by_one"
                        ],
                        "description": "Em quiz, escolha all ou one_by_one; se o usuário não especificar, a IA decide pelo contexto."
                    },
                    "questions": {
                        "type": "array",
                        "minItems": 1,
                        "maxItems": 80,
                        "items": {
                            "$ref": "#/components/schemas/Question"
                        }
                    }
                }
            },
            "FormPreviewCreated": {
                "type": "object",
                "required": [
                    "ok",
                    "status",
                    "title",
                    "preview_url",
                    "fill_url",
                    "share_url",
                    "results_url",
                    "accepts_responses",
                    "activation_required"
                ],
                "properties": {
                    "ok": {
                        "type": "boolean",
                        "const": true
                    },
                    "object": {
                        "type": "string",
                        "const": "form_preview"
                    },
                    "status": {
                        "type": "string",
                        "enum": [
                            "draft",
                            "claimed"
                        ]
                    },
                    "idempotent": {
                        "type": "boolean"
                    },
                    "title": {
                        "type": "string"
                    },
                    "preview_url": {
                        "type": "string",
                        "format": "uri",
                        "description": "Prévia pública. Depois da ativação, a mesma URL encaminha ao formulário operacional."
                    },
                    "fill_url": {
                        "type": "string",
                        "format": "uri",
                        "description": "URL estável do formulário. Enquanto status=draft, é somente prévia e não recebe respostas."
                    },
                    "share_url": {
                        "type": "string",
                        "format": "uri"
                    },
                    "results_url": {
                        "type": "string",
                        "format": "uri",
                        "description": "Exige login. Enquanto draft, apresenta confirmação explícita antes de materializar o formulário."
                    },
                    "accepts_responses": {
                        "type": "boolean"
                    },
                    "activation_required": {
                        "type": "boolean"
                    },
                    "results_requires_login": {
                        "type": "boolean"
                    },
                    "management_requires_login": {
                        "type": "boolean"
                    },
                    "expires_at": {
                        "type": "string"
                    },
                    "note": {
                        "type": "string"
                    }
                }
            }
        }
    }
}