Criar sticky note no Miro, por uma API

Adiciona uma sticky note a um board e a devolve com seu id. Sem position ela vai para o centro do board; dentro de um frame (parent.id), a posição conta a partir do frame.

Identificador
miro_create_sticky_note

A chamada

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>"
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
board_idstringSimId of the board, from List boards, or the part after /board/ in the URL of the board, which usually ends with an equals sign.
dataobjectNãoText and shape of the sticky note.
styleobjectNãoColor and text alignment of the sticky note.
positionobjectNãoWhere 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.
geometryobjectNãoSize of the sticky note, in pixels. Send width or height, never both: the shape keeps the proportion.
parentobjectNãoFrame that holds the sticky note.

Conexões possíveis

O seu cliente conecta a conta do Miro uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

OAuth com o app do seu produto

Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/miro, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/miro_create_sticky_note. Ele vira a definição de tool do seu agente sem conversão.

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.