Listar linhas no Superhuman Docs, por uma API
Lista as linhas de uma tabela ou view, da mais antiga para a mais nova salvo se sortBy disser o contrário, com id, name e os valores indexados pelo id da coluna. Os dados podem atrasar alguns segundos.
- Identificador
- coda_list_rows
A chamada
POST https://connect.reportei.com/api/tools/coda_list_rows/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"docId": "<docId>",
"tableIdOrName": "<tableIdOrName>"
}
}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 |
|---|---|---|---|
| docId | string | Sim | Id of the doc, from List docs. |
| tableIdOrName | string | Sim | Id of the table or view, from List tables. A name also works, but names change. |
| query | string | Não | Filter on one column: the column id from List columns, or its name in double quotes, then a colon and a JSON value, such as "Status":"Done" or c-tuVwxYz:42. Text values go in double quotes. |
| sortBy | string | Não | createdAt, the default, brings the oldest first; updatedAt orders by the last edit; natural follows the order shown in the table and returns only visible rows.Valores: createdAt, natural, updatedAt |
| useColumnNames | boolean | Não | true keys the values by column name instead of id. |
| valueFormat | string | Não | simple, the default, returns plain values, with lists as comma-separated text; simpleWithArrays returns lists as arrays; rich adds Markdown to text and structure to currency, lookup, image, person and link values.Valores: simple, simpleWithArrays, rich |
| visibleOnly | boolean | Não | true returns only the visible rows and columns. |
| limit | integer | Não | Rows per page. The default is 25. |
| pageToken | string | Não | The nextPageToken of the previous response. |
Conexões possíveis
O seu cliente conecta a conta do Superhuman Docs 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.
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/coda_list_rows. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Superhuman Docs
- Listar docsGETLista os docs que o usuário pode acessar e já abriu ao menos uma vez, do mais recente ao mais antigo, com id, name, owner, workspace e browserLink. Envie nextPageToken como pageToken para a próxima página.
- Criar docPOSTCria um doc, vazio ou como cópia de outro, na pasta My docs do workspace mais antigo do usuário. Exige o papel Doc Maker no workspace.
- Listar páginasGETLista as páginas de um doc com id, name, subtitle, parent e children. Envie nextPageToken como pageToken para a próxima página.
- Listar conteúdo da páginaGETDevolve o conteúdo de uma página como texto simples, elemento por elemento. Envie nextPageToken como pageToken para a próxima parte.
- Criar páginaPOSTCria uma página em um doc, ou uma subpágina, com conteúdo em Markdown ou HTML. A alteração entra na fila e aparece em alguns segundos; a resposta traz o id da página.
- Atualizar páginaPUTRenomeia uma página ou adiciona conteúdo a ela, no fim, no início ou substituindo tudo. A alteração entra na fila e aparece em alguns segundos.
- Listar tabelasGETLista as tabelas e views de um doc com id, name, type e a página pai. Linhas só são gravadas em tabelas, não em views.
- Listar colunasGETLista as colunas de uma tabela com id, name e format. Os ids das colunas vão nas cells de Criar linhas e Atualizar linha e na query de Listar linhas.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
