Visão geral
O Forma recebe Submissions por um POST e mostra tudo no Studio. Você não hospeda nada aqui: a tela é sua, o endpoint é nosso.
Os cinco termos
A interface e a API usam as mesmas palavras, sempre com esse sentido. Vale ler uma vez.
- Workspace
- A conta que é dona dos Forms e lê as Submissions.
- Form
- Uma superfície de ingest. Tem uma API key, um kind e uma lista ordenada de Fields.
- Field
- Um espaço nomeado num Form. A key é a propriedade no JSON; o nome é o que aparece no Studio.
- Submission
- Um payload JSON recebido por um Form, mais origin, user-agent e hora.
- Studio
- A interface onde um Workspace cria Forms e lê Submissions.
Começar
Crie um Form no Studio. Ele nasce com uma API key frm_… e um endpoint. Depois é só postar. Surveys públicos também falam WebMCP — ver WebMCP.
import { Forma } from "@forma/sdk";
const forma = new Forma({ apiKey: "frm_..." });
await forma.submit({
email: "ana@acme.com",
message: "O botão some no mobile",
rating: 4,
});Resposta 201 com { "ok": true, "id": "…" }. A Submission aparece no Studio na hora.
Os dois kinds
O kind decide quem monta a tela, e não muda depois de criar.
feedback
O seu código monta a tela
Você já sabe o que enviar. Os Fields existem para validar o payload.
survey
O Forma monta a tela
O cliente lê os Fields com forma.form() e renderiza. Ganha página pública.
Um Form survey também recebe POST direto. O kind não fecha o ingest — só decide se o Forma sabe desenhar a tela. A página pública registra tools WebMCP.