Crear sticky note en Miro, con una API
Agrega una sticky note a un board y la devuelve con su id. Sin position va al centro del board; dentro de un frame (parent.id), la posición cuenta desde el frame.
- Identificador
- miro_create_sticky_note
La llamada
POST https://connect.reportei.com/api/tools/miro_create_sticky_note/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"board_id": "<board_id>"
}
}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ámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| board_id | string | Sí | Id of the board, from List boards, or the part after /board/ in the URL of the board, which usually ends with an equals sign. |
| data | object | No | Text and shape of the sticky note. |
| style | object | No | Color and text alignment of the sticky note. |
| position | object | No | Where the center of the sticky note goes, in pixels. On the board, 0,0 is the center of the board; inside a frame, the top-left corner of the frame. |
| geometry | object | No | Size of the sticky note, in pixels. Send width or height, never both: the shape keeps the proportion. |
| parent | object | No | Frame that holds the sticky note. |
Conexiones posibles
Tu cliente conecta su cuenta de Miro una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.
OAuth con la app de tu producto
Registras la app OAuth de tu producto una sola vez, con POST /api/merchants/credentials/miro, y tu cliente autoriza la cuenta en una pantalla de consentimiento. Connect renueva el token cuando está por vencer.
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/miro_create_sticky_note. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Miro
- Listar boardsGETLista los boards que el usuario conectado puede abrir, con id, name, description, viewLink, owner, team y fechas. Paginación por offset.
- Obtener boardGETDevuelve un board: name, description, viewLink, owner, team, política de uso compartido y fechas.
- Crear boardPOSTCrea un board en el equipo de la conexión y lo devuelve con id y viewLink. En el plan gratuito un equipo puede tener solo 3 boards editables.
- Actualizar boardPATCHActualiza el nombre, la descripción o el uso compartido de un board y lo devuelve. Los campos omitidos conservan su valor.
- Listar miembros del boardGETLista los miembros de un board con id, name y role. El id es el assigneeId que piden Crear card y Actualizar card. Paginación por offset.
- Listar elementosGETLista los elementos de un board, como sticky notes, cards, textos, formas y frames, con id, type, data, position, geometry y parent.
- Obtener elementoGETDevuelve un elemento de un board, de cualquier tipo, con data, style, position, geometry y parent.
- Actualizar sticky notePATCHActualiza el texto, forma, color, posición, tamaño o frame de una sticky note y la devuelve. Los campos omitidos conservan su valor.
Mira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
