Softr
Visão geral
Seção intitulada “Visão geral”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.
- Site oficial: https://www.softr.io/
- Documentação na Composio: docs.composio.dev/toolkits/softr
Autenticação
Seção intitulada “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 | Chave de API gerada no painel do Softr, usada para autenticar todas as requisições à API de banco de dados. |
Como obter a credencial
Seção intitulada “Como obter a credencial”- Acesse softr.io e faça login na sua conta.
- Dentro do seu workspace, acesse as configurações clicando no ícone do seu perfil no canto superior direito.
- Navegue até Settings → API (ou Workspace Settings → API Keys).
- Clique em Generate API Key (ou Create new key) para criar uma chave de API.
- Copie o valor gerado — esse é o valor a usar no campo
api_keyao conectar no SquadOS.
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
Softr. - 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 informa a chave de API obtida 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.)
Ações disponíveis
Seção intitulada “Ações disponíveis”Criar banco de dados
Seção intitulada “Criar banco de dados”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | O nome do novo banco de dados. Escolha um nome descritivo que ajude a identificar a finalidade do banco. Será exibido na interface do Softr. |
description | string | Não | Descrição opcional do banco de dados. Forneça contexto adicional sobre a finalidade, estrutura de dados ou diretrizes de uso. |
workspaceId | string | Sim | O ID do workspace onde o banco de dados será criado. Parâmetro obrigatório que identifica qual workspace conterá o novo banco. |
| 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
Seção intitulada “Criar registro”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
fields | object | Sim | Valores 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_id | string | Sim | O identificador único da tabela onde o registro será criado. |
database_id | string | Sim | O identificador único do banco de dados onde o registro será criado. |
| 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”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | O nome da nova tabela. |
fields | array | Sim | Coleção de definições de campo para a tabela. Pelo menos um campo é obrigatório. Cada campo deve ter nome e tipo. |
database_id | string | Sim | O identificador único do banco de dados onde a tabela será criada. |
description | string | Não | Descrição opcional da tabela para explicar sua finalidade. |
primary_field_name | string | Não | Define qual campo serve como identificador primário dos registros nesta tabela. Deve corresponder ao nome de um dos campos no array fields. |
| 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 de tabela
Seção intitulada “Criar campo de tabela”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | O nome do novo campo. Será o nome de exibição mostrado na tabela. Deve ser descritivo e único dentro da tabela. |
type | string | Sim | O 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. |
options | object | Não | Opçõ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. |
tableId | string | Sim | O identificador único da tabela onde o campo será adicionado. |
databaseId | string | Sim | O identificador único do banco de dados que contém a tabela (formato UUID). |
| 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 banco de dados
Seção intitulada “Excluir banco de dados”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
force | boolean | Não | Se 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_id | string | Sim | O identificador único do banco de dados a excluir. |
| 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”SOFTR_DELETE_RECORD
Exclui um registro de uma tabela de banco de dados do Softr. Use quando precisar remover permanentemente um registro específico.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
table_id | string | Sim | O identificador único da tabela que contém o registro. |
record_id | string | Sim | O identificador único do registro a excluir. |
database_id | string | Sim | O identificador único do banco de dados que contém a tabela. |
| 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 tabela
Seção intitulada “Excluir tabela”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
force | boolean | Não | Se true, exclui a tabela mesmo que contenha registros. Se false (padrão), a exclusão falha se a tabela não estiver vazia. |
table_id | string | Sim | O identificador único da tabela a excluir. |
database_id | string | Sim | O identificador único do banco de dados. |
| 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 campo de tabela
Seção intitulada “Excluir campo de tabela”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
field_id | string | Sim | O identificador único do campo a excluir. |
table_id | string | Sim | O identificador único da tabela. |
database_id | string | Sim | O identificador único do banco de dados. |
| 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 banco de dados
Seção intitulada “Obter banco de dados”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
database_id | string | Sim | O identificador único do banco de dados a recuperar. |
| 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 bancos de dados
Seção intitulada “Listar bancos de dados”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | Não | Número máximo de bancos de dados a retornar por requisição. Por padrão retorna todos se não especificado. |
offset | integer | Não | Número de bancos de dados a pular para paginação. Padrão: 0. |
| 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”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tableId | string | Sim | O identificador único da tabela. |
recordId | string | Sim | O identificador único do registro a recuperar. |
databaseId | string | Sim | O identificador único do banco de dados. |
| 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 da tabela
Seção intitulada “Listar registros da tabela”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | Não | Número máximo de registros a retornar por requisição. Padrão: 10. |
offset | integer | Não | Número de registros a pular para paginação. Padrão: 0. |
tableId | string | Sim | O identificador único da tabela. |
databaseId | string | Sim | O identificador único do banco de dados. |
| 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 tabela
Seção intitulada “Obter tabela”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
table_id | string | Sim | O identificador único da tabela a recuperar. |
database_id | string | Sim | O identificador único do banco de dados que contém a tabela. |
| 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 campo de tabela
Seção intitulada “Obter campo de tabela”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
fieldId | string | Sim | O identificador do campo. |
tableId | string | Sim | O identificador da tabela. |
databaseId | string | Sim | O identificador do banco de dados (formato UUID). |
| 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 tabelas
Seção intitulada “Listar tabelas”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
databaseId | string | Sim | O identificador único do banco de dados do qual recuperar as tabelas. |
| 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 visualizações de tabela
Seção intitulada “Listar visualizações de tabela”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
table_id | string | Sim | O identificador único da tabela cujas visualizações serão recuperadas. |
database_id | string | Sim | O identificador único do banco de dados que contém a tabela. |
| 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. |
Pesquisar registros
Seção intitulada “Pesquisar registros”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
filter | object | Não | Condições de filtro para pesquisa de registros. A estrutura varia com base no esquema da tabela e nos requisitos de filtro. |
paging | object | Não | Opções de paginação para a pesquisa de registros. |
table_id | string | Sim | O identificador único da tabela onde pesquisar registros. |
database_id | string | Sim | O identificador único do banco de dados que contém a tabela. |
| 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 banco de dados
Seção intitulada “Atualizar banco de dados”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Não | O novo nome para o banco de dados. |
database_id | string | Sim | O identificador único do banco de dados a atualizar. |
description | string | Não | A nova descrição para o banco de dados. |
| 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”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
fields | object | Sim | Mapeamento 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_id | string | Sim | O identificador único da tabela que contém o registro. |
record_id | string | Sim | O identificador único do registro a atualizar. |
database_id | string | Sim | O identificador único do banco de dados que contém a tabela. |
| 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”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | O nome da tabela (obrigatório pela API). |
table_id | string | Sim | O identificador único da tabela. |
database_id | string | Sim | O identificador único do banco de dados. |
description | string | Não | A nova descrição da tabela. |
| 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 de tabela
Seção intitulada “Atualizar campo de tabela”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Não | O novo nome do campo. Se não informado, o nome do campo permanece inalterado. |
type | string | Sim | O 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). |
options | object | Sim | Opçõ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_id | string | Sim | O identificador único do campo a atualizar. |
table_id | string | Sim | O identificador único da tabela. |
database_id | string | Sim | O identificador único do banco de dados. |
| 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. |