Obter página no Notion, por uma API
Devolve as propriedades de uma página. O conteúdo não está incluído: leia com Obter markdown da página.
- Identificador
- notion_retrieve_page
A chamada
POST https://connect.reportei.com/api/tools/notion_retrieve_page/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"page_id": "<page_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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| page_id | string | Sim | Id of the page, from Search or List data source pages, or the 32-character id at the end of the page URL. |
| filter_properties | array | Não | Names or ids of the properties to return, from Get data source. Omit it to return all of them. |
Conexões possíveis
O seu cliente conecta a conta do Notion uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
OAuth com o app do seu produto
Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/notion, 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/notion_retrieve_page. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Notion
- BuscarPOSTBusca pelo título as páginas e data sources compartilhados com a conexão. Devolve has_more e next_cursor para a página seguinte.
- Criar páginaPOSTCria uma página sob uma página ou data source compartilhado com a conexão. Envie o conteúdo como Markdown em markdown, ou como blocos em children, nunca os dois.
- Atualizar páginaPATCHAtualiza as propriedades, o ícone ou a capa de uma página, ou a move para a lixeira e de volta com in_trash. Propriedades omitidas mantêm o valor.
- Obter markdown da páginaGETDevolve o conteúdo de uma página como Markdown no campo markdown. Em páginas muito grandes, truncated é true e unknown_block_ids lista as partes deixadas de fora.
- Atualizar markdown da páginaPATCHEdita o conteúdo de uma página com Markdown: o tipo update_content aplica edições de busca e substituição, e replace_content reescreve a página inteira.
- Criar blocosPATCHAdiciona blocos de conteúdo a uma página, ou a um bloco que aceita filhos, no fim salvo se position disser o contrário. Até 100 blocos por chamada.
- Obter databaseGETDevolve um database com título, parent e data_sources, o id e o name de cada data source nele.
- Obter data sourceGETDevolve o schema de um data source: nome, id, tipo e opções de cada propriedade. Leia antes de criar, atualizar ou filtrar páginas nele.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
