Airtable
Visão geral
Seção intitulada “Visão geral”O Airtable combina a facilidade de uma planilha com o poder de um banco de dados, permitindo que equipes organizem projetos, rastreiem tarefas e colaborem com visualizações personalizáveis, automações e integrações para gerenciamento de dados. Com a integração no SquadOS, seus agentes podem criar e manipular bases, tabelas, campos e registros do Airtable de forma programática, tornando-o um hub de dados dinâmico para qualquer fluxo de trabalho.
- Site oficial: https://airtable.com/
- Documentação na Composio: docs.composio.dev/toolkits/airtable
Autenticação
Seção intitulada “Autenticação”Esta ferramenta utiliza OAuth 2.0 (OAUTH2) ou chave de API (API_KEY) para conectar.
Você vai precisar dos seguintes campos (modo OAuth 2.0 personalizado):
| Campo | Obrigatório | Descrição |
|---|---|---|
client_id | Sim | Client ID do app OAuth registrado no portal de desenvolvedores do Airtable. |
client_secret | Sim | Client Secret do app OAuth registrado no portal de desenvolvedores do Airtable. |
Como obter a credencial
Seção intitulada “Como obter a credencial”Opção A — OAuth 2.0 (recomendado)
Seção intitulada “Opção A — OAuth 2.0 (recomendado)”- Acesse o Portal de Desenvolvedores do Airtable e faça login com sua conta Airtable.
- Selecione OAuth integrations no menu lateral e clique em + New OAuth Integration.
- Preencha nome, descrição e (opcionalmente) URL do site do app. Salve.
- Após salvar, o Airtable exibe seu Client ID e Client Secret — guarde-os em local seguro.
- Na seção Redirect URLs do app, adicione exatamente a URL de callback da Composio:
https://backend.composio.dev/api/v3/toolkits/auth/callback(sem barra no final, protocolohttps).
Opção B — Chave de API pessoal
Seção intitulada “Opção B — Chave de API pessoal”- Acesse airtable.com/create/tokens e clique em Create new token.
- Dê um nome ao token, selecione os escopos necessários (ex.:
data.records:read,data.records:write,schema.bases:read) e as bases a que o token terá acesso. - Clique em Create token e copie o valor exibido — ele só é mostrado uma vez.
Como conectar no SquadOS
Seção intitulada “Como conectar no SquadOS”- Acesse Ferramentas no menu lateral (
/admin/tools). - Abra a aba Disponíveis e procure por
Airtable. - Clique no card para abrir o modal de detalhes e em Conectar.
- Você é levado para a página de conexão segura hospedada pela Composio, onde autoriza o acesso (OAuth) ou informa as credenciais obtidas acima.
- Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)
Perguntas frequentes
Seção intitulada “Perguntas frequentes”Como configurar credenciais OAuth personalizadas para o Airtable?
Seção intitulada “Como configurar credenciais OAuth personalizadas para o Airtable?”Para um guia passo a passo sobre como criar e configurar suas próprias credenciais OAuth do Airtable com a Composio, consulte How to create OAuth credentials for Airtable.
Ações disponíveis
Seção intitulada “Ações disponíveis”Criar base
Seção intitulada “Criar base”AIRTABLE_CREATE_BASE
Cria uma nova base no Airtable com tabelas e campos especificados dentro de um workspace.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome da nova base do Airtable, visível na interface. |
tables | array | Sim | Configurações das tabelas a criar na nova base; cada tabela precisa de ‘name’ e ‘fields’. Deve ser um array de objetos de tabela, não um JSON serializado. O primeiro campo de cada tabela não pode ser ‘singleSelect’ pois se torna o campo primário. Opções de campos select devem incluir ‘id’ e ‘name’ para cada escolha. Os tipos ‘formula’, ‘rollup’, ‘count’, ‘lookup’, ‘multipleLookupValues’, ‘autoNumber’, ‘createdTime’ e ‘lastModifiedTime’ não são suportados na criação de bases. Para campos ‘dateTime’, as opções exigem ‘dateFormat’ (com name: ‘local’|‘friendly’|‘us’|‘european’|‘iso’) e ‘timeFormat’ (com name: ‘12hour’|‘24hour’); ‘timeZone’ assume ‘utc’ se não especificado. |
workspaceId | string | Sim | ID do workspace onde a base será criada. DEVE começar com o prefixo ‘wsp’ (ex.: ‘wspXXXXXXXXXXXXXX’). Erro comum: não use IDs de usuário (prefixo usr), IDs de base (prefixo app) ou outros IDs do Airtable — somente IDs de workspace funcionam aqui. Obtenha o ID nas configurações do workspace ou via API List Bases. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar comentário
Seção intitulada “Criar comentário”AIRTABLE_CREATE_COMMENT
Cria um comentário em um registro específico do Airtable. Use para adicionar comentários a registros, mencionar colaboradores com a sintaxe @[userId] ou criar respostas em threads. Suporta parentCommentId opcional para conversas encadeadas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
text | string | Sim | Conteúdo do comentário. Para mencionar um usuário, use o formato @[userId] (ex.: @[usrGISFlfA7l5F7kY6]). |
baseId | string | Sim | Identificador único da base do Airtable. Geralmente começa com ‘app’. |
recordId | string | Sim | Identificador único do registro no qual o comentário será criado. Geralmente começa com ‘rec’. |
tableIdOrName | string | Sim | Identificador único (geralmente começando com ‘tbl’) ou nome da tabela dentro da base. |
parentCommentId | string | Não | ID do comentário pai para criar respostas encadeadas. Se fornecido, este comentário será uma resposta ao comentário pai especificado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar campo
Seção intitulada “Criar campo”AIRTABLE_CREATE_FIELD
Cria um novo campo dentro de uma tabela especificada em uma base do Airtable.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | OBRIGATÓRIO. Nome do novo campo. Os nomes de campo devem ser únicos dentro de uma tabela. |
type | string | Não | Tipo do novo campo. Se não fornecido, usa ‘singleLineText’ como padrão. Tipos criáveis via API: ‘singleLineText’, ‘multilineText’, ‘richText’, ‘singleSelect’, ‘multipleSelects’, ‘checkbox’, ‘number’, ‘percent’, ‘currency’, ‘date’, ‘dateTime’, ‘duration’, ‘phoneNumber’, ‘email’, ‘url’, ‘multipleAttachments’, ‘barcode’, ‘rating’, ‘multipleRecordLinks’, ‘createdBy’, ‘lastModifiedBy’, ‘externalSyncSource’. Para campos de anexo, use ‘multipleAttachments’ (o legado ‘attachment’ é convertido automaticamente). Não podem ser criados via API: ‘formula’, ‘rollup’, ‘count’, ‘lookup’, ‘multipleLookupValues’, ‘autoNumber’, ‘createdTime’, ‘lastModifiedTime’, ‘button’. |
baseId | string | Sim | OBRIGATÓRIO. Identificador único da base onde o campo será criado. Formato: ‘appXXXXXXXXXXXXXXX’ (17 caracteres começando com ‘app’). |
options | object | Não | Configuração específica do tipo para o novo campo. Obrigatório para ‘multipleRecordLinks’ (deve incluir ‘linkedTableId’ — ID ou nome da tabela a vincular). Também obrigatório para: ‘number’/‘percent’ (‘precision’), ‘currency’ (‘precision’ e ‘symbol’), ‘checkbox’ (‘color’ e ‘icon’), ‘date’ (‘dateFormat’), ‘dateTime’ (‘dateFormat’, ‘timeFormat’, ‘timeZone’), ‘rating’ (‘max’, ‘color’ e ‘icon’). Para ‘singleSelect’ e ‘multipleSelects’, o array ‘choices’ deve conter objetos com ‘name’ (obrigatório) e opcionalmente ‘color’. Não inclua ‘id’ ao criar novas opções — a API as gera automaticamente. |
description | string | Não | Descrição opcional para o novo campo, fornecendo contexto ou instruções de uso. |
tableIdOrName | string | Sim | ID ou nome da tabela dentro da base onde o campo será criado. IDs de tabela começam com ‘tbl’ seguido de 14 caracteres. Nomes de tabela diferenciam maiúsculas/minúsculas. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar múltiplos registros (Descontinuado)
Seção intitulada “Criar múltiplos registros (Descontinuado)”AIRTABLE_CREATE_MULTIPLE_RECORDS
DESCONTINUADO: Use AIRTABLE_CREATE_RECORDS em seu lugar. Cria múltiplos registros em uma tabela do Airtable.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
baseId | string | Sim | Identificador único da base do Airtable (ex.: ‘appXXXXXXXXXXXXXX’). |
records | array | Sim | Lista de objetos de registro a criar. Cada registro deve ter uma chave ‘fields’ contendo um dicionário mapeando nomes de campos a valores. Os nomes de campo diferenciam maiúsculas/minúsculas. A API do Airtable limita a criação a 10 registros por requisição; mais de 10 são automaticamente divididos em lotes. |
typecast | boolean | Não | Se verdadeiro, o Airtable realizará conversão automática de tipos. Padrão: false. |
tableIdOrName | string | Sim | ID da tabela (ex.: ‘tblXXXXXXXXXXXXXX’) ou nome da tabela (ex.: ‘Tasks’). |
returnFieldsByFieldId | boolean | Não | Se verdadeiro, os objetos de campo retornados usarão IDs de campo como chaves em vez de nomes. Padrão: false. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar um registro (Descontinuado)
Seção intitulada “Criar um registro (Descontinuado)”AIRTABLE_CREATE_RECORD
DESCONTINUADO: Use CreateRecords em seu lugar. Cria um novo registro em uma tabela do Airtable; os valores dos campos devem estar em conformidade com os tipos de coluna da tabela.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
baseId | string | Sim | Identificador único da base do Airtable (ex.: ‘appXXXXXXXXXXXXXX’). Use AIRTABLE_LIST_BASES para encontrar IDs disponíveis. |
fields | object | Não | Dicionário de nomes (ou IDs) de campos e seus valores para o novo registro. Nomes de campo devem corresponder exatamente ao esquema da tabela (diferenciam maiúsculas/minúsculas). IMPORTANTE: Use AIRTABLE_GET_BASE_SCHEMA com o baseId específico para descobrir nomes, IDs e tipos de campo válidos antes de criar registros. |
typecast | boolean | Não | Quando verdadeiro, habilita conversão automática de dados de strings para os tipos de campo apropriados. Padrão: false. |
tableIdOrName | string | Sim | ID da tabela (ex.: ‘tblXXXXXXXXXXXXXX’) ou nome da tabela (ex.: ‘Tasks’). |
returnFieldsByFieldId | boolean | Não | Se verdadeiro, os objetos de campo retornados usarão IDs de campo como chaves. Padrão: false. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar registro a partir de linguagem natural
Seção intitulada “Criar registro a partir de linguagem natural”AIRTABLE_CREATE_RECORD_FROM_NATURAL_LANGUAGE
Cria um novo registro em uma tabela do Airtable a partir de uma descrição em linguagem natural. Busca o esquema da tabela, usa um LLM para gerar o payload correto de campos e cria o registro com typecast habilitado para conversão automática de tipos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
baseId | string | Sim | Identificador único da base do Airtable, geralmente começando com ‘app’. |
nl_query | string | Sim | Descrição em linguagem natural do registro a criar. Exemplo: ‘Add a task called Fix Login Bug, status In Progress, priority High, due date 2025-03-15’. |
typecast | boolean | Não | Se verdadeiro, o Airtable converterá automaticamente valores de string para os tipos apropriados. Habilitado por padrão. |
tableIdOrName | string | Sim | Identificador único (geralmente começando com ‘tbl’) ou nome da tabela dentro da base especificada. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar registros
Seção intitulada “Criar registros”AIRTABLE_CREATE_RECORDS
Cria múltiplos registros (até 10) em uma tabela do Airtable. Use quando precisar adicionar novas linhas a uma tabela com valores de campos. Limite de taxa: 5 requisições por segundo por base.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
baseId | string | Sim | Identificador único da base do Airtable. Formato: ‘app’ seguido de caracteres alfanuméricos (ex.: ‘appHPvgqYXl3LNHXq’). |
records | array | Sim | Array de objetos de registro a criar. Cada objeto deve conter uma propriedade ‘fields’ com os valores das células. Máximo de 10 registros por requisição. |
typecast | boolean | Não | Se verdadeiro, o Airtable realizará conversão automática de dados de strings para o tipo de célula apropriado. Padrão: false. |
tableIdOrName | string | Sim | Identificador único ou nome da tabela onde os registros serão criados. IDs de tabela são recomendados para maior estabilidade. Formato: ‘tbl’ seguido de caracteres alfanuméricos. |
returnFieldsByFieldId | boolean | Não | Se verdadeiro, os objetos de campo retornados usarão IDs de campo como chaves. Padrão: false. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar tabela
Seção intitulada “Criar tabela”AIRTABLE_CREATE_TABLE
Cria uma nova tabela dentro de uma base existente do Airtable, permitindo definir nome, descrição e estrutura de campos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome desejado para a nova tabela. |
fields | array | Sim | Lista de configurações de campos para a nova tabela. Cada item deve incluir ‘name’ (string) e ‘type’ (string). IMPORTANTE: O primeiro campo torna-se o campo primário. Tipos válidos para campo primário: singleLineText, number, email, url, phoneNumber, date, dateTime, currency, percent, barcode, richText, multilineText, duration. Tipos calculados (formula, rollup, count, lookup, etc.) não podem ser criados via API. |
base_id | string | Sim | Identificador único da base onde a nova tabela será criada. |
if_exists | string | Não | Opções para lidar com nomes de tabela duplicados: “error”, “skip” ou “return_existing”. |
description | string | Não | Descrição textual opcional para a nova tabela. |
reorder_message | string | Não | Campo interno usado para rastrear mensagens de reordenação de campos. Preenchido automaticamente. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir comentário
Seção intitulada “Excluir comentário”AIRTABLE_DELETE_COMMENT
Exclui um comentário de um registro em uma tabela do Airtable. Usuários não administradores só podem excluir seus próprios comentários; administradores Enterprise podem excluir qualquer comentário.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
baseId | string | Sim | Identificador único da base do Airtable de onde o comentário será excluído. |
recordId | string | Sim | Identificador único do registro dentro da tabela especificada de onde o comentário será excluído. |
rowCommentId | string | Sim | Identificador único do comentário a ser excluído do registro especificado. |
tableIdOrName | string | Sim | Identificador único (ID) ou nome da tabela dentro da base que contém o registro e o comentário. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir múltiplos registros
Seção intitulada “Excluir múltiplos registros”AIRTABLE_DELETE_MULTIPLE_RECORDS
Exclui até 10 registros especificados de uma tabela dentro de uma base do Airtable. Use quando precisar remover múltiplos registros em uma única operação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
baseId | string | Sim | Identificador único da base do Airtable que contém os registros a excluir. |
recordIds | array | Sim | Lista de identificadores únicos dos registros a excluir. |
tableIdOrName | string | Sim | Identificador único (ex.: ‘tbluIzIsxPIM2V3Y4’) ou nome (ex.: ‘Marketing Leads’) da tabela dentro da base de onde os registros serão excluídos. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir registro
Seção intitulada “Excluir registro”AIRTABLE_DELETE_RECORD
Exclui permanentemente um registro específico de uma tabela existente dentro de uma base do Airtable.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
baseId | string | Sim | Identificador único da base do Airtable, geralmente começando com ‘app’. |
recordId | string | Sim | Identificador único do registro a excluir, geralmente começando com ‘rec’. |
tableIdOrName | string | Sim | Identificador único (geralmente começando com ‘tbl’) ou nome da tabela dentro da base especificada. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter esquema da base
Seção intitulada “Obter esquema da base”AIRTABLE_GET_BASE_SCHEMA
Recupera o esquema detalhado de uma base do Airtable, incluindo tabelas, campos, tipos de campo e configurações, usando o baseId.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
baseId | string | Sim | Identificador único da base do Airtable. Geralmente começa com ‘app’ seguido de caracteres alfanuméricos. Pode ser encontrado na URL ao visualizar a base. |
include | array | Não | Lista opcional de campos adicionais a incluir no objeto de visualizações da resposta. Atualmente suporta apenas o valor ‘visibleFieldIds’ (para visualizações do tipo ‘grid’). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter registro
Seção intitulada “Obter registro”AIRTABLE_GET_RECORD
Recupera um registro específico de uma tabela do Airtable pelo ID do registro. Requer um ID de registro válido e conhecido, obtido ao listar registros ou de outra chamada de API — esta ação não pesquisa nem lista registros. Valores de campo vazios não são retornados na resposta.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
baseId | string | Sim | ID da base do Airtable. |
recordId | string | Sim | ID do registro a recuperar. Deve ser um ID de registro real obtido de listagens ou outra chamada de API. Formato: começa com ‘rec’ seguido de exatamente 14 caracteres alfanuméricos (ex.: ‘rec4YsVV8cU6V4EiT’). |
timeZone | string | Não | Fuso horário para formatação de datas quando cellFormat=‘string’. Usa o formato IANA (ex.: ‘America/New_York’, ‘Europe/London’, ‘UTC’). |
cellFormat | string | Não | Controla a formatação dos valores de célula: ‘json’ para tipos nativos, ‘string’ para todos os valores como strings. |
userLocale | string | Não | Localidade do usuário para formatação de datas quando cellFormat=‘string’. Usa o formato de tag de idioma BCP 47 (ex.: ‘en-us’, ‘de-de’). |
tableIdOrName | string | Sim | ID ou nome da tabela. |
returnFieldsByFieldId | boolean | Não | Se verdadeiro, as chaves de campo na resposta são IDs de campo; caso contrário, nomes de campo. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter informações do usuário
Seção intitulada “Obter informações do usuário”AIRTABLE_GET_USER_INFO
Recupera informações — como ID e escopos de permissão — do usuário do Airtable atualmente autenticado, a partir do endpoint /meta/whoami.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar bases
Seção intitulada “Listar bases”AIRTABLE_LIST_BASES
Recupera todas as bases do Airtable acessíveis ao usuário autenticado, podendo incluir um campo ‘offset’ para paginação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
offset | string | Não | Token de paginação para recuperar a próxima página de resultados. Valor opaco retornado no campo ‘offset’ de uma resposta anterior de listagem de bases. Não construa nem modifique este valor. Presente apenas quando há mais de 1.000 bases. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar comentários
Seção intitulada “Listar comentários”AIRTABLE_LIST_COMMENTS
Lista comentários em um registro específico do Airtable, com suporte a paginação para threads com muitos comentários.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
baseId | string | Sim | Identificador único da base do Airtable de onde os comentários serão listados. |
offset | string | Não | Token de paginação para recuperar a próxima página de comentários. Obtido da resposta anterior. |
pageSize | integer | Não | Número de comentários a retornar por página. Deve ser menor ou igual a 100. Padrão: 100. |
recordId | string | Sim | Identificador único do registro cujos comentários serão listados. |
tableIdOrName | string | Sim | Identificador único ou nome da tabela dentro da base especificada que contém o registro. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar registros
Seção intitulada “Listar registros”AIRTABLE_LIST_RECORDS
Lista registros de uma tabela do Airtable com filtragem, ordenação e paginação. Use quando precisar recuperar múltiplos registros de uma tabela com parâmetros de consulta opcionais.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
sort | array | Não | Array de objetos de ordenação a aplicar aos registros. Cada objeto especifica um campo e uma direção. IMPORTANTE: Não é possível ordenar por campos de metadados do sistema como ‘createdTime’ ou ‘lastModifiedTime’. |
view | string | Não | Nome ou ID de uma visualização para filtrar e ordenar registros. Nomes de visualização diferenciam maiúsculas/minúsculas. IDs de visualização (formato: ‘viwXXXXXXXXXXXXXX’) são mais confiáveis. |
baseId | string | Sim | ID da base do Airtable. Deve começar com ‘app’ seguido de 14 caracteres. |
fields | array | Não | Array de nomes ou IDs de campos a incluir na resposta. Se não especificado ou se [’*’] for passado, todos os campos são retornados. Nomes de campo diferenciam maiúsculas/minúsculas. |
offset | string | Não | Cursor de paginação opaco retornado no campo ‘offset’ de uma resposta anterior de listagem. Não construa, modifique nem decodifique este valor. Omita para a primeira página de resultados. |
pageSize | integer | Não | Número de registros a retornar por página. Deve estar entre 1 e 100. Padrão: 100. |
timeZone | string | Não | Fuso horário para formatação de campos de data e hora. Obrigatório quando cellFormat é ‘string’. |
cellFormat | string | Não | Formato para valores de célula. ‘json’ retorna valores JSON estruturados (padrão), ‘string’ retorna representações simples em string. |
maxRecords | integer | Não | Número máximo total de registros a retornar em todas as páginas. Se não especificado, todos os registros correspondentes à consulta são retornados. |
userLocale | string | Não | Localidade do usuário para formatação de valores de célula (ex.: ‘en-US’, ‘fr-FR’). |
tableIdOrName | string | Sim | ID ou nome da tabela dentro da base. Nomes de tabela diferenciam maiúsculas/minúsculas. |
recordMetadata | array | Não | Array de strings especificando metadados adicionais a incluir. Atualmente suporta ‘commentCount’ para incluir contagens de comentários nos registros. |
filterByFormula | string | Não | Fórmula do Airtable para filtrar registros. Nomes de campo ficam entre chaves (ex.: {status} para o campo “status”) e diferenciam maiúsculas/minúsculas; strings entre aspas. Para datas, use funções como IS_AFTER(), IS_BEFORE() e IS_SAME() em vez de comparação direta. Use AIRTABLE_GET_BASE_SCHEMA para verificar nomes exatos dos campos antes de usar em fórmulas. |
returnFieldsByFieldId | boolean | Não | Se verdadeiro, as chaves de campo na resposta serão IDs de campo em vez de nomes. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar comentário
Seção intitulada “Atualizar comentário”AIRTABLE_UPDATE_COMMENT
Atualiza um comentário existente em um registro específico do Airtable. Use para modificar o texto do comentário ou atualizar menções de usuários com a sintaxe @[userId]. Usuários de API só podem atualizar comentários que criaram.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
text | string | Sim | Texto atualizado do comentário. Para mencionar um usuário, use o formato @[userId] (ex.: @[usrGISFlfA7l5F7kY6]). |
baseId | string | Sim | Identificador único da base do Airtable. Geralmente começa com ‘app’. |
recordId | string | Sim | Identificador único do registro que contém o comentário. Geralmente começa com ‘rec’. |
rowCommentId | string | Sim | Identificador único do comentário a atualizar. Geralmente começa com ‘com’. |
tableIdOrName | string | Sim | Identificador único (geralmente começando com ‘tbl’) ou nome da tabela dentro da base. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar campo
Seção intitulada “Atualizar campo”AIRTABLE_UPDATE_FIELD
Atualiza o nome ou a descrição de um campo em uma tabela do Airtable. Use para modificar metadados de campo sem alterar o tipo ou as opções do campo. Pelo menos um entre ‘name’ ou ‘description’ deve ser fornecido.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Não | Novo nome para o campo. Pelo menos um entre ‘name’ ou ‘description’ deve ser fornecido. |
baseId | string | Sim | Identificador único da base do Airtable que contém o campo. |
fieldId | string | Sim | ID do campo a atualizar. IMPORTANTE: diferente dos endpoints da API de dados, a API de Metadados requer IDs de campo — nomes de campo não são suportados. IDs de campo começam com ‘fld’ seguido de 14 caracteres alfanuméricos. Use AIRTABLE_GET_BASE_SCHEMA para encontrar IDs de campo. |
tableId | string | Sim | ID da tabela que contém o campo a atualizar. IMPORTANTE: a API de Metadados requer IDs de tabela — nomes de tabela não são suportados. IDs de tabela começam com ‘tbl’ seguido de 14 caracteres alfanuméricos. |
description | string | Não | Nova descrição para o campo. Não deve exceder 20.000 caracteres. Pelo menos um entre ‘name’ ou ‘description’ deve ser fornecido. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar múltiplos registros
Seção intitulada “Atualizar múltiplos registros”AIRTABLE_UPDATE_MULTIPLE_RECORDS
Atualiza até 10 registros em uma tabela do Airtable com modificações seletivas de campos. Use quando precisar modificar múltiplos registros existentes ou realizar operações de upsert. As atualizações não são atômicas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
baseId | string | Sim | ID da base do Airtable que contém a tabela. |
records | array | Sim | Lista de registros a atualizar. A API do Airtable limita atualizações a no máximo 10 registros por requisição. Para mais registros, divida em múltiplas requisições de 10 ou menos. |
typecast | boolean | Não | Se verdadeiro, o Airtable tenta conversão automática de dados de strings (ex.: ‘123’ para 123). |
performUpsert | object | Não | Configuração para comportamento de upsert ao atualizar registros. |
tableIdOrName | string | Sim | ID ou nome da tabela dentro da base onde os registros serão atualizados. |
returnFieldsByFieldId | boolean | Não | Se verdadeiro, retorna valores de campo com chaves por ID de campo em vez de nome. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar múltiplos registros (PUT)
Seção intitulada “Atualizar múltiplos registros (PUT)”AIRTABLE_UPDATE_MULTIPLE_RECORDS_PUT
Atualiza destrutivamente múltiplos registros no Airtable usando PUT, limpando campos não especificados. Use quando precisar substituir completamente os dados de um registro ou realizar operações de upsert. Suporta até 10 registros por requisição.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
baseId | string | Sim | ID da base do Airtable que contém a tabela. |
records | array | Sim | Array de até 10 objetos de registro a atualizar. PUT atualiza destrutivamente os registros, limpando campos não especificados. |
typecast | boolean | Não | Se verdadeiro, o Airtable tentará converter valores de string para os valores de célula apropriados. |
performUpsert | object | Não | Configuração para comportamento de upsert. |
tableIdOrName | string | Sim | ID ou nome da tabela dentro da base onde os registros serão atualizados. |
returnFieldsByFieldId | boolean | Não | Se verdadeiro, retorna o objeto de campos com chave por ID de campo em vez de nome. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar registro
Seção intitulada “Atualizar registro”AIRTABLE_UPDATE_RECORD
Modifica campos especificados de um registro existente em uma base e tabela do Airtable; a base, a tabela e o registro devem existir.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
baseId | string | Sim | Identificador único da base do Airtable que contém o registro a atualizar. |
fields | object | Sim | Campos a atualizar. Chaves são nomes de campo (diferenciam maiúsculas/minúsculas) ou IDs (fldXXXX recomendado). Apenas os campos especificados são modificados. Strings vazias são convertidas para nulo. Use AIRTABLE_GET_BASE_SCHEMA para nomes/IDs exatos. Campos de data requerem formato ‘YYYY-MM-DD’; campos de data-hora requerem ISO 8601. |
recordId | string | Sim | Identificador único do registro a atualizar. DEVE estar no formato de ID de registro do Airtable: exatamente 17 caracteres começando com ‘rec’ seguido de 14 caracteres alfanuméricos (ex.: ‘recABC123def456G’). |
typecast | boolean | Não | Habilita conversão automática de dados e criação de opções de seleção. CRÍTICO PARA CAMPOS SELECT: quando falso (padrão), o Airtable rejeita atualizações em campos select se o valor não for uma opção existente. Quando verdadeiro, cria automaticamente novas opções e converte strings para tipos apropriados. |
tableIdOrName | string | Sim | Identificador único (ID) ou nome da tabela dentro da base que contém o registro a atualizar. |
returnFieldsByFieldId | boolean | Não | Se verdadeiro, as chaves de campo na resposta são IDs de campo em vez de nomes. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar registro (PUT)
Seção intitulada “Atualizar registro (PUT)”AIRTABLE_UPDATE_RECORD_PUT
Atualiza um registro existente em uma base do Airtable usando o método PUT. Use quando quiser substituir todos os valores de campo, limpando campos não especificados. Para atualizações parciais que preservam campos não especificados, use a ação de atualização baseada em PATCH.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
baseId | string | Sim | Identificador único da base do Airtable que contém o registro a atualizar. |
fields | object | Sim | Especifica os campos a atualizar. Chaves são nomes ou IDs de campos; valores são o novo conteúdo. O método PUT limpa todos os valores de célula não especificados (atualização destrutiva). Strings vazias são convertidas automaticamente para nulo. Para campos Date: use o formato ‘YYYY-MM-DD’. Para campos DateTime: use ISO 8601 (ex.: ‘2026-01-02T10:30:00.000Z’). |
recordId | string | Sim | Identificador único do registro a atualizar dentro da tabela especificada. |
typecast | boolean | Não | Quando verdadeiro, habilita conversão automática de dados de strings para os tipos de campo apropriados. Padrão: false. |
tableIdOrName | string | Sim | Identificador único (ID) ou nome da tabela dentro da base que contém o registro a atualizar. |
returnFieldsByFieldId | boolean | Não | Se verdadeiro, as chaves de campo na resposta são IDs de campo em vez de nomes. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar tabela
Seção intitulada “Atualizar tabela”AIRTABLE_UPDATE_TABLE
Atualiza o nome, a descrição e/ou as configurações de dependência de data de uma tabela no Airtable. Use para modificar metadados de tabela sem alterar os campos ou visualizações. Pelo menos um entre ‘name’, ‘description’ ou ‘dateDependencySettings’ deve ser fornecido.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Não | Novo nome para a tabela. Deve ser não vazio se fornecido. Pelo menos um entre ‘name’, ‘description’ ou ‘dateDependencySettings’ deve ser fornecido. |
baseId | string | Sim | Identificador único da base do Airtable que contém a tabela a atualizar. |
description | string | Não | Nova descrição para a tabela. Não deve exceder 20.000 caracteres. |
tableIdOrName | string | Sim | Identificador único ou nome da tabela a atualizar. |
dateDependencySettings | object | Não | Configuração para agendamento de tarefas baseado em datas em tabelas do Airtable. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Fazer upload de anexo
Seção intitulada “Fazer upload de anexo”AIRTABLE_UPLOAD_ATTACHMENT
Faz upload de um arquivo como anexo em um campo especificado de um registro do Airtable. Use quando precisar adicionar um arquivo a um campo de anexo. O arquivo deve ser fornecido como uma string codificada em base64.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
file | string | Sim | Conteúdo do arquivo codificado como string base64. |
baseId | string | Sim | Identificador único da base do Airtable que contém o registro. |
filename | string | Sim | Nome do arquivo incluindo sua extensão (ex.: ‘test.txt’, ‘document.pdf’, ‘image.jpg’). |
recordId | string | Sim | Identificador único do registro ao qual o anexo será carregado. |
contentType | string | Sim | Tipo MIME do arquivo sendo carregado (ex.: ‘text/plain’, ‘image/jpeg’, ‘application/pdf’). |
attachmentFieldIdOrName | string | Sim | ID (ex.: ‘fldXXXXXXXXXXXXXX’) ou nome do campo de anexo onde o arquivo será carregado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |