O que você precisa saber
- As ferramentas somente leitura podem ser chamadas a qualquer momento, sem risco.
create_formcria um formulário novo a cada chamada. Se o retorno se perder, procure o formulário comlist_formsantes de tentar de novo.save_form_draftepublish_formalteram dados salvos, mas repetir uma chamada idêntica não muda mais nada.- Todas as ferramentas atuam na organização do usuário conectado. Os IDs de formulário vêm de
list_formsou decreate_form. - Quando uma chamada falha, a ferramenta retorna um erro com
codeemessage. Os códigos estão em Limites e erros. - As listas retornam uma página de resultados e um
next_cursor. Envie esse valor comocursorpara buscar a próxima página; na última, ele vem null.
Ferramentas
A referência técnica a seguir é gerada a partir do código e está em inglês, como os assistentes de IA a leem.
read_docs
Read trulyform’s docs for building forms, as Markdown. Call without a page for the list of pages; start with building-a-form. A page may name one section, such as question-types#file_upload.
Somente leitura.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page |
string | Não | A page name, optionally with a section after #: index, connect, tools, building-a-form, form-definition, question-types, logic, calculations-and-piping, design, examples, validation, responses. A docs URL works too. Leave it out to list the pages. |
list_forms
List forms in your organization, newest IDs first. Returns draft revisions and publication status. Follow next_cursor to retrieve another page.
Somente leitura.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
cursor |
string | Não | The next_cursor from the previous page. Omit for the first page. |
limit |
integer | Não | Maximum records to return, from 1 to 50. |
get_form
Read the complete current draft definition, revision, validation issues, and publication information. Read this before save_form_draft; a saved draft may differ from the published version.
Somente leitura.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
form_id |
string | Sim | Form UUID returned by list_forms or create_form. |
list_field_types
List every question kind with its settings, logic operators, answer shape and a ready-to-edit template, plus the rich-text shape and definition limits. Pass id_count to get fresh UUIDv7 identifiers for new questions, choices, rows, rules and calculations.
Somente leitura.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id_count |
integer | Não | How many fresh UUIDv7 identifiers to return in ids, from 0 to 200. |
create_form
Create an unpublished form in your organization and return its full initial draft. Optionally provide its name, then edit with save_form_draft. Each call creates a new form: inspect list_forms before retrying if a reply is lost.
Cria dados novos. Não repita a chamada sem conferir antes.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name |
string | Não | Optional name of the new unpublished form. |
save_form_draft
Replace a form’s entire draft definition and name, preserving draft history. Read get_form first and use its draft_revision as base_revision. Send a new UUIDv7 mutation_id per edit; retries must reuse the exact same payload and ID. Existing publication stays unchanged. Re-read and reconcile on draft_conflict. read_docs explains the definition format and every error.
Altera dados salvos. Repetir a mesma chamada não muda o resultado.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
form_id |
string | Sim | Form UUID returned by list_forms or create_form. |
base_revision |
integer | Sim | Current draft_revision from get_form. |
mutation_id |
string | Sim | New UUIDv7 per edit. Reuse only for an identical retry. |
name |
string | Sim | Complete form name. An empty string uses Untitled form. |
definition |
object | Sim | Complete draft definition object from get_form, including unchanged properties; not a partial patch. |
publish_form
Publish the exact reviewed draft revision for new respondents. Only call when the user requests publication. Rejects stale revisions and invalid drafts; previously saved responses keep their original version. Republishing identical content creates no duplicate version. A closed form stays closed.
Altera dados salvos. Repetir a mesma chamada não muda o resultado.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
form_id |
string | Sim | Form UUID returned by list_forms or create_form. |
revision |
integer | Sim | Exact draft revision the user reviewed and wants to publish. |
list_responses
List response IDs, status, version, and timestamps for a form, newest IDs first. Use get_response for answers. Partial responses require the organization’s existing plan entitlement; otherwise only completed responses are returned. Follow next_cursor for another page.
Somente leitura.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
form_id |
string | Sim | Form UUID returned by list_forms or create_form. |
cursor |
string | Não | The next_cursor from the previous page. Omit for the first page. |
limit |
integer | Não | Maximum records to return, from 1 to 50. |
status |
string | Não | Optional response status. Started responses need a plan that includes partial responses. |
get_response
Read one private response with resolved question labels, display answers, active-path indicators, calculations, and file names/sizes. Uses the response’s original published version. Only retrieve answers needed for the user’s request. Partial responses require the existing plan entitlement. No respondent credentials, metadata, or download links are returned.
Somente leitura.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
form_id |
string | Sim | Form UUID returned by list_forms or create_form. |
response_id |
string | Sim | Response UUID returned by list_responses for this form. |
form_stats
Count currently stored completed responses and, when your plan permits partial responses, started responses. Started means an existing incomplete response, not a page visit. Deleted responses are excluded. These are response counts, not unique visitors, billing usage, or conversion analytics.
Somente leitura.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
form_id |
string | Sim | Form UUID returned by list_forms or create_form. |