NocoDB

Visão geral

NocoDB é uma alternativa open source ao Airtable que transforma qualquer banco de dados em uma planilha inteligente com APIs REST. Com a integração NocoDB no SquadOS, seus agentes podem gerenciar workspaces, bases, tabelas, views e registros de forma programática, além de consultar metadados de integração, notificações e informações do sistema — tudo sem precisar abrir a interface web.

• Documentação na Composio: docs.composio.dev/toolkits/nocodb

Autenticação

Esta ferramenta utiliza chave de API (API_KEY) para conectar.

Você vai precisar dos seguintes campos:

Campo	Obrigatório	Descrição
api_key	Sim	Token de API gerado no painel do NocoDB, usado para autenticar todas as requisições à instância.

Como obter a credencial

1. Acesse a sua instância NocoDB (cloud em app.nocodb.com ou auto-hospedada) e faça login.
2. Clique no avatar ou no nome do seu usuário no canto inferior esquerdo para abrir as configurações de conta.
3. Navegue até Team & Auth → API Tokens (em versões mais recentes, pode estar em Settings → API Tokens).
4. Clique em Add New Token, dê um nome descritivo (ex.: squados) e confirme.
5. Copie o token gerado — esse é o valor a usar no campo api_key ao conectar no SquadOS.

Dica

Crie um token dedicado para o SquadOS. Assim, você pode revogá-lo individualmente se necessário sem afetar outras integrações que usam a mesma conta.

Como conectar no SquadOS

1. Acesse Ferramentas no menu lateral (/admin/tools).
2. Abra a aba Disponíveis e procure por NocoDB.
3. Clique no card para abrir o modal de detalhes e em Conectar.
4. Você é levado para a página de conexão segura hospedada pela Composio, onde informa a chave de API obtida acima.
5. 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.)

Ações disponíveis

Obter informações do usuário autenticado

NOCODB_AUTH_ME

Retorna informações do usuário autenticado, incluindo e-mail, nome, funções e detalhes do perfil. Use quando precisar verificar a autenticação ou recuperar os dados do perfil do usuário atual.

Saída

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.

Solicitar redefinição de senha

NOCODB_AUTH_PASSWORD_FORGOT

Inicia o processo de redefinição de senha enviando um e-mail de redefinição ao usuário. Use quando um usuário esqueceu a senha e precisa receber o link de redefinição por e-mail.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
email	string	Sim	Endereço de e-mail da conta de usuário registrada. Deve estar em formato de e-mail válido.

Saída

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.

Encerrar sessão do usuário

NOCODB_AUTH_SIGNOUT

Encerra a sessão do usuário autenticado e limpa o token de atualização do banco de dados e do cookie. Use quando precisar invalidar a sessão de autenticação de um usuário e desconectá-lo da aplicação NocoDB.

Saída

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 metadados de ordenação

NOCODB_DB_TABLE_SORT_GET

Recupera a configuração de ordenação pelo ID no NocoDB. Use quando precisar obter detalhes sobre como os dados estão ordenados em uma view específica.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
sort_id	string	Sim	Identificador único da configuração de ordenação a recuperar.

Saída

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 coluna de view

NOCODB_DB_VIEW_COLUMN_UPDATE

Atualiza a configuração de uma coluna em uma view. Use quando precisar alterar a visibilidade, ordem ou largura de uma coluna em uma view específica.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
show	boolean	Não	Se a coluna deve ser exibida ou ocultada na view. Defina como true para exibir, false para ocultar.
order	integer	Não	Ordem de exibição da coluna na view. Números menores aparecem primeiro.
width	string	Não	Largura da coluna quando exibida na view. Deve ser uma string com sufixo px (ex.: 200px).
viewId	string	Sim	Identificador único da view que contém a coluna. Uma string alfanumérica com prefixo vw ou v.
columnId	string	Sim	Identificador único da configuração de coluna de view a atualizar. Uma string alfanumérica com prefixo nc. Este é o ID de coluna de view da lista de colunas da view, não o ID do campo da tabela.

Saída

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 view

NOCODB_DB_VIEW_DELETE

Exclui uma view de uma tabela NocoDB. Use quando precisar remover permanentemente uma view. Esta ação não pode ser desfeita.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
viewId	string	Sim	ID único da view a excluir. Uma string alfanumérica com prefixo v (ex.: vw_wtdg2meyig5l4q) com comprimento máximo de 20 caracteres.

Saída

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 linha de view de tabela

NOCODB_DB_VIEW_ROW_DELETE

Exclui uma linha específica de uma view de tabela no NocoDB. Use quando precisar remover um único registro de uma view.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
orgs	string	Não	Identificador da organização. Padrão: noco se não especificado.
rowId	string	Sim	Identificador único da linha a ser excluída.
baseName	string	Sim	Nome da base/projeto que contém a tabela.
viewName	string	Sim	Nome da view da qual excluir a linha.
tableName	string	Sim	Nome da tabela que contém a linha a excluir.

Saída

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 de integração

NOCODB_INTEGRATIONS_INFO

Recupera metadados de uma integração NocoDB específica por tipo e subtipo. Use quando precisar obter o schema de configuração de integração, informações de exibição ou capacidades disponíveis para uma integração.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
type	string	Sim	Categoria/tipo da integração (ex.: Database, ai). Especifica a classificação do tipo de integração.
subType	string	Sim	Variante específica dentro do tipo de integração. Para bancos de dados: pg (PostgreSQL), mysql2 (MySQL), sqlite3 (SQLite), snowflake, databricks. Para IA: openai, etc.

Saída

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 integrações

NOCODB_INTEGRATIONS_LIST

Recupera todas as integrações disponíveis no NocoDB. Use quando precisar listar todas as integrações, incluindo tipos de IA, autenticação, sincronização e nó de fluxo de trabalho.

Saída

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.

Armazenar configuração de integração

NOCODB_INTEGRATION_STORE

Armazena a configuração de uma integração NocoDB. Use quando precisar salvar ou atualizar configurações de integração como chaves de API, modelos ou outros parâmetros.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
config	object	Sim	Objeto de configuração contendo definições da integração, como chaves de API, modelos e outros parâmetros específicos do tipo de integração.
integrationId	string	Sim	Identificador único da integração para armazenar a configuração.

Saída

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 workspaces

NOCODB_LIST_WORKSPACES

Lista todos os workspaces acessíveis ao usuário autenticado. Use quando precisar descobrir o workspace_id antes de operações em bases, principalmente relevante para o NocoDB Cloud ou implantações com múltiplos workspaces.

Saída

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 notificação

NOCODB_NOTIFICATION_DELETE

Exclui uma notificação do usuário autenticado. Use quando precisar remover uma notificação. Esta operação realiza uma exclusão lógica (soft-delete).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
notificationId	string	Sim	Identificador único da notificação a excluir. Uma string alfanumérica que identifica exclusivamente uma notificação específica do usuário autenticado.

Saída

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 notificações

NOCODB_NOTIFICATION_LIST

Recupera registros de notificações paginados para o usuário autenticado. Use quando precisar listar notificações com filtragem opcional por status de leitura e suporte a paginação. Retorna apenas notificações que não foram excluídas logicamente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
limit	integer	Não	Número máximo de notificações a retornar por requisição. Padrão: 10 se não especificado.
isRead	boolean	Não	Filtra notificações por status de leitura. Passe true para notificações lidas, false para não lidas. Se omitido, retorna todas as notificações.
offset	integer	Não	Número de notificações a pular para paginação. Padrão: 0 se não especificado.

Saída

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.

Verificar notificações por polling

NOCODB_NOTIFICATION_POLL

Verifica notificações usando mecanismo de long-polling. Use quando precisar checar novas notificações para o usuário autenticado. A conexão é mantida por até 30 segundos; se nenhuma notificação chegar, retorna status refresh e o cliente deve fazer novo polling.

Saída

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 status de plugin

NOCODB_PLUGIN_STATUS

Verifica se um plugin NocoDB está ativo ou não. Use quando precisar verificar o status operacional de um plugin específico pelo seu identificador.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
pluginId	string	Sim	Identificador único do plugin para verificar o status (ex.: S3, SES, Backblaze, Vultr, OvhCloud, LinodeObjectStorage, UpcloudObjectStorage, Minio, GCS, Spaces, Scaleway).

Saída

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 dados agrupados de view pública compartilhada

NOCODB_PUBLIC_GROUPED_DATA_LIST

Recupera dados agrupados de uma view NocoDB compartilhada publicamente. Use quando precisar acessar registros agrupados de uma view pública compartilhada sem autenticação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
sort	string	Não	Ordem de classificação para os dados agrupados. Formato: nomeColuna para crescente, -nomeColuna para decrescente.
limit	integer	Não	Número máximo de registros agrupados a retornar. Usado para paginação.
where	string	Não	Condição de filtro a aplicar nos dados em formato codificado como URL.
offset	integer	Não	Número de registros a pular antes de começar a retornar resultados. Usado para paginação.
columnId	string	Sim	Identificador único da coluna para agrupar os dados.
sharedViewUuid	string	Sim	Identificador único (UUID) da view pública compartilhada da qual recuperar dados agrupados.

Saída

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.

Enviar anexos por URL

NOCODB_STORAGE_UPLOAD_BY_URL

Envia anexos a partir de URLs remotas para o armazenamento NocoDB. Use quando precisar importar arquivos de URLs externas ou migrar anexos de outras plataformas como o Airtable. O servidor busca os arquivos nas URLs fornecidas e os armazena no storage configurado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
path	string	Não	Caminho/escopo de armazenamento para os arquivos enviados.
attachments	array	Sim	Array de objetos de anexo a enviar a partir de URLs. Cada objeto deve conter pelo menos um campo url.

Saída

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 schema de tabela

NOCODB_TABLE_READ

Recupera informações completas do schema de uma tabela específica. Use quando precisar entender a estrutura da tabela, definições de campos ou views disponíveis.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
base_id	string	Sim	Identificador único da base que contém a tabela.
table_id	string	Sim	Identificador único da tabela a recuperar.

Saída

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 perfil de usuário

NOCODB_USER_PROFILE_UPDATE

Atualiza as informações de perfil do usuário autenticado, incluindo nome de exibição, primeiro nome e sobrenome. Use quando precisar modificar os detalhes do perfil do usuário atual no NocoDB.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
lastname	string	Não	Sobrenome do usuário.
firstname	string	Não	Primeiro nome do usuário.
display_name	string	Não	Nome de exibição do usuário. Usado para atualizar como o nome do usuário aparece na interface.

Saída

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 metainformações agregadas

NOCODB_UTILS_AGGREGATED_META_INFO

Obtém metainformações agregadas como contagem de tabelas, views de banco de dados, views e outras estatísticas sobre a instância NocoDB. Use quando precisar de uma visão geral da estrutura de dados e métricas de uso do sistema.

Saída

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 status de saúde da aplicação

NOCODB_UTILS_APP_HEALTH

Obtém o status de saúde da aplicação NocoDB. Use quando precisar verificar se a aplicação está em execução e responsiva, tipicamente para balanceadores de carga ou sistemas de monitoramento.

Saída

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 da aplicação

NOCODB_UTILS_APP_INFO

Obtém informações abrangentes da aplicação NocoDB, incluindo configurações de autenticação, versão, limites e configuração de implantação. Use quando precisar descobrir as capacidades da aplicação, feature flags ou configuração do sistema.

Saída

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 recursos cloud

NOCODB_UTILS_CLOUD_FEATURES

Obtém os recursos do NocoDB Cloud. Use quando precisar recuperar recursos específicos da nuvem disponíveis e suas capacidades, incluindo o status de disponibilidade e informações de destaque.

Saída

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 sugestões da paleta de comandos

NOCODB_UTILS_COMMAND_PALETTE

Obtém sugestões dinâmicas da paleta de comandos com base no escopo. Use quando precisar recuperar comandos e ações disponíveis para a interface NocoDB.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
query	string	Não	Consulta de pesquisa opcional para filtrar sugestões de comandos.
scope	string	Não	Escopo opcional para filtrar as sugestões da paleta de comandos. Determina o contexto para os comandos disponíveis.

Saída

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.

Reportar erro

NOCODB_UTILS_ERROR_REPORT

Reporta erros ao sistema de rastreamento de erros do NocoDB. Use quando precisar enviar relatórios de erro incluindo tipo, mensagem, stack trace e timestamp para fins de monitoramento e depuração.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
error	string	Sim	Nome ou identificador do tipo de erro. Fornece um rótulo conciso para a categoria do erro.
stack	string	Não	Stack trace ou pilha de chamadas mostrando a sequência de chamadas de função que levou ao erro. Auxilia na depuração.
message	string	Sim	Mensagem de erro detalhada descrevendo o que deu errado. Deve ser legível por humanos e informativa.
timestamp	string	Não	Timestamp ISO 8601 indicando quando o erro ocorreu. Se não fornecido, o servidor pode usar o horário atual.

Saída

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 feed de produto

NOCODB_UTILS_FEED

Obtém o feed de produto do NocoDB a partir de fontes de redes sociais, incluindo GitHub, YouTube, Twitter e Cloud. Use quando precisar recuperar atualizações e conteúdos dos diversos canais do NocoDB. Suporta filtragem por fonte de feed e paginação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
page	integer	Não	Número da página para paginação. Deve ser maior ou igual a 1.
type	string	Não	Especifica a fonte do feed a recuperar. Valores válidos: github, youtube, twitter, cloud ou all.
per_page	integer	Não	Número de itens por página. Deve estar entre 1 e 100.

Saída

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.

Converter URL para configuração de banco de dados

NOCODB_UTILS_URL_TO_CONFIG

Converte uma URL JDBC ou URL de conexão de banco de dados em um objeto de configuração de conexão. Use quando precisar analisar e extrair parâmetros de conexão de banco de dados de uma string de URL para fins de configuração.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
url	string	Sim	URL de conexão de banco de dados em formato JDBC ou padrão (ex.: jdbc:mysql://localhost:3306/mydb?user=root&password=test, pg://user:pass@host:5432/dbname, sqlite://path/to/db.db).

Saída

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 do workspace

NOCODB_WORKSPACE_BASE_LIST

Lista todas as bases em um workspace NocoDB. Use quando precisar recuperar bases associadas a um workspace específico. Suporta paginação via parâmetros page e pageSize.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
page	integer	Não	Número da página atual para paginação. Deve ser maior ou igual a 1.
pageSize	integer	Não	Número de itens por página. Padrão: 25 se não especificado.
workspaceId	string	Sim	Identificador único do workspace do qual listar as bases.

Saída

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.