Crear formulario en Tally, con una API

Crea un formulario a partir de sus bloques y devuelve id, name, workspace y status. El formulario va al workspace predeterminado salvo que se envíe workspaceId.

Identificador
tally_create_form

La llamada

POST https://connect.reportei.com/api/tools/tally_create_form/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "status": "BLANK",
    "blocks": []
  }
}

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
statusstringSíPUBLISHED puts the form live, DRAFT keeps the changes unpublished. Deleting is not done here.Valores: BLANK, DRAFT, PUBLISHED
blocksarraySíBlocks of the form, in order. A question is a TITLE block with groupType QUESTION and the question in payload.html, followed by its input block, like INPUT_TEXT, INPUT_EMAIL or TEXTAREA, whose groupType repeats the type. The form title is a FORM_TITLE block with groupType TEXT and the title in payload.html.
workspaceIdstringNoWorkspace of the form: an id from List workspaces.
folderIdstringNoFolder of the form, inside that workspace: a folder id from List workspaces. Folders need the Pro plan.
settingsobjectNoForm settings. Other Tally settings, like the respondent email and the data retention, also go here.

Conexiones posibles

Tu cliente conecta su cuenta de Tally una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

Clave de API

Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/tally_create_form. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Tally

Ver las 12 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.