Pular para o conteúdo

Softr

Softr

O Softr é uma plataforma no-code que permite criar portais de clientes, ferramentas internas e aplicativos web a partir do Airtable em minutos. Ele oferece APIs de gerenciamento de usuários e banco de dados para construção rápida de aplicações sem escrever código. Com a integração Softr no SquadOS, seus agentes podem criar e gerenciar bancos de dados, tabelas, campos e registros diretamente no workspace Softr da sua organização.

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

Você vai precisar dos seguintes campos:

CampoObrigatórioDescrição
api_keySimChave de API gerada no painel do Softr, usada para autenticar todas as requisições à API de banco de dados.
  1. Acesse softr.io e faça login na sua conta.
  2. Dentro do seu workspace, acesse as configurações clicando no ícone do seu perfil no canto superior direito.
  3. Navegue até Settings → API (ou Workspace Settings → API Keys).
  4. Clique em Generate API Key (ou Create new key) para criar uma chave de API.
  5. Copie o valor gerado — esse é o valor a usar no campo api_key ao conectar no SquadOS.
  1. Acesse Ferramentas no menu lateral (/admin/tools).
  2. Abra a aba Disponíveis e procure por Softr.
  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.)

SOFTR_CREATE_DATABASE

Cria um novo banco de dados em um workspace do Softr. Use quando precisar configurar um novo banco de dados para armazenar dados em um workspace específico do Softr.

NomeTipoObrigatórioDescrição
namestringSimO nome do novo banco de dados. Escolha um nome descritivo que ajude a identificar a finalidade do banco. Será exibido na interface do Softr.
descriptionstringNãoDescrição opcional do banco de dados. Forneça contexto adicional sobre a finalidade, estrutura de dados ou diretrizes de uso.
workspaceIdstringSimO ID do workspace onde o banco de dados será criado. Parâmetro obrigatório que identifica qual workspace conterá o novo banco.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SOFTR_CREATE_RECORD

Cria um novo registro em uma tabela de banco de dados do Softr. Use quando precisar adicionar novos dados a uma tabela específica no seu banco de dados Softr.

NomeTipoObrigatórioDescrição
fieldsobjectSimValores dos campos para o novo registro. É um mapeamento de IDs de campo para seus valores. Os IDs de campo são específicos do esquema da sua tabela no Softr. Exemplo: {'c63tL': 'test@example.com', 'o0JWv': 'Test User'}
table_idstringSimO identificador único da tabela onde o registro será criado.
database_idstringSimO identificador único do banco de dados onde o registro será criado.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SOFTR_CREATE_TABLE

Cria uma nova tabela dentro de um banco de dados Softr especificado. Use quando precisar adicionar uma nova estrutura de dados com campos personalizados para organizar informações.

NomeTipoObrigatórioDescrição
namestringSimO nome da nova tabela.
fieldsarraySimColeção de definições de campo para a tabela. Pelo menos um campo é obrigatório. Cada campo deve ter nome e tipo.
database_idstringSimO identificador único do banco de dados onde a tabela será criada.
descriptionstringNãoDescrição opcional da tabela para explicar sua finalidade.
primary_field_namestringNãoDefine qual campo serve como identificador primário dos registros nesta tabela. Deve corresponder ao nome de um dos campos no array fields.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SOFTR_CREATE_TABLE_FIELD

Adiciona um novo campo a uma tabela do Softr. Use quando precisar adicionar uma nova coluna a uma tabela existente, como um campo de e-mail, texto ou qualquer outro tipo de campo para armazenar dados adicionais.

NomeTipoObrigatórioDescrição
namestringSimO nome do novo campo. Será o nome de exibição mostrado na tabela. Deve ser descritivo e único dentro da tabela.
typestringSimO tipo do campo, que determina que tipo de dado pode ser armazenado. Tipos comuns: SINGLE_LINE_TEXT (texto curto), EMAIL (e-mail), NUMBER (numérico), CHECKBOX (booleano), SELECT (lista suspensa), LONG_TEXT (texto longo), URL, DATETIME, entre outros.
optionsobjectNãoOpções de configuração específicas do tipo de campo. Para SINGLE_LINE_TEXT, pode incluir restrições minLength e maxLength. Para SELECT, incluiria a lista de opções. Use objeto vazio {} se não houver opções específicas.
tableIdstringSimO identificador único da tabela onde o campo será adicionado.
databaseIdstringSimO identificador único do banco de dados que contém a tabela (formato UUID).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SOFTR_DELETE_DATABASE

Exclui um banco de dados específico pelo seu ID no Softr. Use quando precisar remover um banco de dados. O banco deve estar vazio a menos que o parâmetro force seja definido como true. Esta operação é irreversível.

NomeTipoObrigatórioDescrição
forcebooleanNãoSe true, exclui o banco de dados mesmo que contenha tabelas ou registros. Se false (padrão), a exclusão falhará se o banco não estiver vazio. Use com cautela, pois a operação é irreversível.
database_idstringSimO identificador único do banco de dados a excluir.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SOFTR_DELETE_RECORD

Exclui um registro de uma tabela de banco de dados do Softr. Use quando precisar remover permanentemente um registro específico.

NomeTipoObrigatórioDescrição
table_idstringSimO identificador único da tabela que contém o registro.
record_idstringSimO identificador único do registro a excluir.
database_idstringSimO identificador único do banco de dados que contém a tabela.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SOFTR_DELETE_TABLE

Exclui uma tabela específica pelo seu ID de um banco de dados. Use quando precisar remover uma tabela. A tabela deve estar vazia a menos que o parâmetro force seja definido como true.

NomeTipoObrigatórioDescrição
forcebooleanNãoSe true, exclui a tabela mesmo que contenha registros. Se false (padrão), a exclusão falha se a tabela não estiver vazia.
table_idstringSimO identificador único da tabela a excluir.
database_idstringSimO identificador único do banco de dados.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SOFTR_DELETE_TABLE_FIELD

Exclui um campo de uma tabela de banco de dados do Softr. Use quando precisar remover um campo de uma tabela. Retorna confirmação de sucesso ao concluir.

NomeTipoObrigatórioDescrição
field_idstringSimO identificador único do campo a excluir.
table_idstringSimO identificador único da tabela.
database_idstringSimO identificador único do banco de dados.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SOFTR_GET_DATABASE

Recupera os detalhes de um banco de dados específico pelo seu ID. Use quando precisar buscar informações sobre um banco de dados específico no Softr.

NomeTipoObrigatórioDescrição
database_idstringSimO identificador único do banco de dados a recuperar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SOFTR_GET_DATABASES

Recupera todos os bancos de dados disponíveis no workspace. Use quando precisar listar ou descobrir os bancos de dados disponíveis para operações subsequentes.

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero máximo de bancos de dados a retornar por requisição. Por padrão retorna todos se não especificado.
offsetintegerNãoNúmero de bancos de dados a pular para paginação. Padrão: 0.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SOFTR_GET_RECORD

Recupera um único registro pelo seu ID de uma tabela de banco de dados do Softr. Use quando precisar buscar informações detalhadas sobre um registro específico.

NomeTipoObrigatórioDescrição
tableIdstringSimO identificador único da tabela.
recordIdstringSimO identificador único do registro a recuperar.
databaseIdstringSimO identificador único do banco de dados.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SOFTR_GET_RECORDS

Recupera uma lista paginada de registros de uma tabela do Softr. Use quando precisar buscar registros de uma tabela específica com parâmetros de paginação opcionais.

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero máximo de registros a retornar por requisição. Padrão: 10.
offsetintegerNãoNúmero de registros a pular para paginação. Padrão: 0.
tableIdstringSimO identificador único da tabela.
databaseIdstringSimO identificador único do banco de dados.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SOFTR_GET_TABLE

Recupera os detalhes de uma tabela específica pelo seu ID. Use quando precisar inspecionar a estrutura, os campos ou metadados de uma tabela.

NomeTipoObrigatórioDescrição
table_idstringSimO identificador único da tabela a recuperar.
database_idstringSimO identificador único do banco de dados que contém a tabela.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SOFTR_GET_TABLE_FIELD

Recupera um campo específico de uma tabela do Softr pelo ID do campo. Use quando precisar de informações detalhadas de configuração sobre um campo de tabela, incluindo seu tipo, opções e metadados.

NomeTipoObrigatórioDescrição
fieldIdstringSimO identificador do campo.
tableIdstringSimO identificador da tabela.
databaseIdstringSimO identificador do banco de dados (formato UUID).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SOFTR_GET_TABLES

Recupera todas as tabelas dentro de um banco de dados Softr especificado. Use quando precisar listar ou explorar as tabelas disponíveis em um banco de dados.

NomeTipoObrigatórioDescrição
databaseIdstringSimO identificador único do banco de dados do qual recuperar as tabelas.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SOFTR_GET_TABLE_VIEWS

Recupera todas as visualizações de uma tabela especificada em um banco de dados Softr. Use quando precisar listar ou inspecionar as visualizações disponíveis para uma tabela.

NomeTipoObrigatórioDescrição
table_idstringSimO identificador único da tabela cujas visualizações serão recuperadas.
database_idstringSimO identificador único do banco de dados que contém a tabela.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SOFTR_SEARCH_RECORDS

Pesquisa registros em uma tabela de banco de dados do Softr com filtragem e paginação. Use quando precisar recuperar registros de uma tabela específica, opcionalmente filtrados por valores de campo e paginados para grandes conjuntos de resultados.

NomeTipoObrigatórioDescrição
filterobjectNãoCondições de filtro para pesquisa de registros. A estrutura varia com base no esquema da tabela e nos requisitos de filtro.
pagingobjectNãoOpções de paginação para a pesquisa de registros.
table_idstringSimO identificador único da tabela onde pesquisar registros.
database_idstringSimO identificador único do banco de dados que contém a tabela.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SOFTR_UPDATE_DATABASE

Atualiza o nome e/ou a descrição de um banco de dados existente. Use quando precisar modificar os metadados de um banco de dados após a criação.

NomeTipoObrigatórioDescrição
namestringNãoO novo nome para o banco de dados.
database_idstringSimO identificador único do banco de dados a atualizar.
descriptionstringNãoA nova descrição para o banco de dados.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SOFTR_UPDATE_RECORD

Atualiza os valores de campo de um registro existente em uma tabela do Softr. Use quando precisar modificar campos específicos de um registro fornecendo o ID do banco de dados, ID da tabela, ID do registro e os novos valores dos campos.

NomeTipoObrigatórioDescrição
fieldsobjectSimMapeamento de IDs de campo para seus novos valores. Os IDs de campo são identificadores únicos de cada coluna na tabela (ex.: 'o0JWv'). Os valores podem ser strings, números, booleanos ou outros tipos dependendo do tipo do campo no esquema da tabela Softr.
table_idstringSimO identificador único da tabela que contém o registro.
record_idstringSimO identificador único do registro a atualizar.
database_idstringSimO identificador único do banco de dados que contém a tabela.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SOFTR_UPDATE_TABLE

Atualiza o nome e/ou a descrição de uma tabela no banco de dados Softr. Use quando precisar modificar os metadados de uma tabela. Para modificar campos, use os endpoints específicos de campo.

NomeTipoObrigatórioDescrição
namestringSimO nome da tabela (obrigatório pela API).
table_idstringSimO identificador único da tabela.
database_idstringSimO identificador único do banco de dados.
descriptionstringNãoA nova descrição da tabela.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SOFTR_UPDATE_TABLE_FIELD

Atualiza um campo existente em uma tabela do Softr. Use quando precisar modificar o nome, o tipo ou as opções de configuração de um campo. Atenção: a API exige os campos type e options mesmo que você esteja atualizando apenas o nome.

NomeTipoObrigatórioDescrição
namestringNãoO novo nome do campo. Se não informado, o nome do campo permanece inalterado.
typestringSimO tipo do campo. Deve ser informado mesmo sem alteração de tipo. Tipos comuns: SINGLE_LINE_TEXT (texto), EMAIL (e-mail com validação), NUMBER (numérico), CHECKBOX (booleano), SELECT (lista suspensa), LONG_TEXT (texto multilinha).
optionsobjectSimOpções de configuração específicas do tipo de campo. Para SINGLE_LINE_TEXT: {minLength: 0, maxLength: 1024}. Para NUMBER: {precision: 2}. Para SELECT: {choices: ['Opção1', 'Opção2']}. A estrutura varia por tipo de campo.
field_idstringSimO identificador único do campo a atualizar.
table_idstringSimO identificador único da tabela.
database_idstringSimO identificador único do banco de dados.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.