Postman

Visão geral

Postman é uma plataforma de API completa para criação, teste e gerenciamento de APIs, com recursos poderosos de colaboração em equipe. Com a integração Postman no SquadOS, seus agentes podem automatizar todo o ciclo de vida de APIs: criar coleções e requisições, gerenciar ambientes e variáveis, configurar servidores mock, executar monitores e importar/exportar especificações OpenAPI.

• Site oficial: https://www.postman.com/
• Documentação na Composio: docs.composio.dev/toolkits/postman

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 da sua conta Postman, usada para autenticar todas as requisições à API do Postman.

Como obter a credencial

1. Acesse postman.com e faça login na sua conta.
2. Clique no seu avatar no canto superior direito e selecione Settings (Configurações).
3. Na seção API keys, clique em Generate API Key (Gerar chave de API).
4. Dê um nome descritivo para a chave (ex.: “SquadOS”) e confirme.
5. Copie a chave gerada — ela é exibida apenas uma vez.

Dica

A chave de API do Postman dá acesso completo à sua conta. Crie uma chave exclusiva para o SquadOS para poder revogá-la individualmente sem afetar outras integrações.

Como conectar no SquadOS

1. Acesse Ferramentas no menu lateral (/admin/tools).
2. Abra a aba Disponíveis e procure por Postman.
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

Nota

Esta integração expõe 135 ações no total. Abaixo estão as principais; a lista completa está na documentação da Composio.

Criar uma coleção

POSTMAN_CREATE_A_COLLECTION

Cria uma nova coleção Postman em um workspace específico ou no workspace padrão. Use quando precisar criar uma coleção com especificação de workspace.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
workspace	string	Não	ID do workspace onde a coleção será criada. Se não informado, a coleção é criada no workspace padrão do usuário.
collection	object	Sim	Objeto da coleção contendo info (nome, descrição, schema) e array de itens (requisições/pastas).

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.

Criar uma requisição na coleção

POSTMAN_CREATE_A_REQUEST

Cria uma nova requisição em uma coleção Postman. Use quando precisar adicionar uma requisição a uma coleção existente com método, URL, cabeçalhos e corpo especificados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome da requisição a criar.
request	object	Sim	Objeto da requisição contendo método, URL, cabeçalhos, corpo e outros detalhes no formato Postman Collection Format.
collection_id	string	Sim	Identificador único da coleção onde a requisição será criada.

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.

Criar uma pasta

POSTMAN_CREATE_A_FOLDER

Cria uma pasta em uma coleção Postman. Use quando precisar organizar requisições criando uma nova pasta dentro de uma coleção.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome da pasta a criar.
description	string	Não	Descrição opcional da pasta explicando seu propósito.
collection_id	string	Sim	Identificador único da coleção onde a pasta será criada.

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.

Criar um ambiente

POSTMAN_CREATE_AN_ENVIRONMENT

Cria um novo ambiente em um workspace Postman. Use quando precisar criar um novo ambiente com variáveis para diferentes configurações (desenvolvimento, produção, teste, etc.).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
environment	object	Sim	Objeto de ambiente contendo nome e array opcional de variáveis de ambiente.
workspace_id	string	Sim	ID do workspace onde o ambiente será criado.

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.

Criar um workspace

POSTMAN_CREATE_A_WORKSPACE

Cria um novo workspace no Postman com nome, tipo (personal, team, private ou public) e descrição opcional.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
workspace	object	Sim	Objeto do workspace contendo nome, tipo e descrição opcional.

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.

Criar uma API

POSTMAN_CREATE_AN_API

Cria uma nova API no Postman com nome, resumo e descrição em um workspace.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
api	object	Sim	Objeto da API contendo nome, resumo e descrição.
workspace_id	string	Sim	ID do workspace onde a API será criada.

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.

Criar um servidor mock

POSTMAN_CREATE_A_MOCK_SERVER

Cria um novo servidor mock em uma coleção Postman para simular endpoints de API em testes ou desenvolvimento.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
mock	object	Sim	Configuração do servidor mock contendo nome, UID da coleção, UID opcional do ambiente e configuração de privacidade.
workspace	string	Não	ID do workspace onde o servidor mock será criado.

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.

Criar um monitor

POSTMAN_CREATE_A_MONITOR

Cria um novo monitor em um workspace específico para executar uma coleção em um agendamento usando expressões cron.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
monitor	object	Sim	Objeto de configuração do monitor contendo nome, coleção, agendamento e ambiente opcional.
workspace	string	Sim	ID do workspace onde o monitor será criado.

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.

Criar um schema de API

POSTMAN_CREATE_A_SCHEMA

Cria um schema para uma API no Postman (OpenAPI, GraphQL, Protocol Buffers, etc.). O schema pode ser composto de um ou múltiplos arquivos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
type	string	Sim	Tipo do schema a criar. Valores comuns: openapi:3, openapi:2, proto, graphql.
files	array	Sim	Lista de arquivos que compõem o schema. Cada arquivo deve ter path e conteúdo.
api_id	string	Sim	Identificador único (UUID) da API para a qual criar o schema.

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.

Criar uma especificação

POSTMAN_CREATE_A_SPEC

Cria uma especificação de API no Postman. Suporta vários tipos, incluindo OpenAPI 3.0, OpenAPI 3.1 e AsyncAPI 2.0.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome da especificação de API a criar.
type	string	Sim	Tipo da especificação. Valores comuns: OPENAPI:3.0, OPENAPI:3.1, ASYNCAPI:2.0.
files	array	Sim	Array de arquivos para a especificação. Cada arquivo deve ter as propriedades path e content.
workspace_id	string	Sim	ID do workspace onde a especificação será criada.

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 todas as coleções

POSTMAN_GET_ALL_COLLECTIONS2

Obtém todas as coleções acessíveis ao usuário autenticado, incluindo coleções assinadas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
limit	integer	Não	Número máximo de coleções a retornar por página.
cursor	string	Não	Cursor para paginação. Passe o valor nextCursor de uma resposta anterior para buscar a próxima página.
workspace	string	Não	ID de workspace opcional para filtrar coleções.

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 todos os ambientes

POSTMAN_GET_ALL_ENVIRONMENTS

Obtém todos os ambientes acessíveis ao usuário autenticado, com filtragem opcional por workspace.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
limit	integer	Não	Número máximo de ambientes a retornar por página.
cursor	string	Não	Cursor para paginação.
workspace	string	Não	Filtra por ID de workspace.

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 todos os workspaces

POSTMAN_GET_ALL_WORKSPACES

Obtém todos os workspaces acessíveis ao usuário autenticado, com filtragem opcional por tipo.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
type	string	Não	Filtra por tipo de workspace: personal, team ou public.

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 detalhes de um workspace

POSTMAN_GET_A_WORKSPACE

Obtém informações detalhadas de um workspace específico, incluindo todas as coleções, ambientes, APIs, mocks e monitores.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
workspace_id	string	Sim	Identificador único do workspace a consultar.

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 uma API

POSTMAN_GET_AN_API

Obtém informações detalhadas de uma API específica no Postman, incluindo nome, descrição, versões e schemas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
api_id	string	Sim	Identificador único da API a consultar.

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 todas as APIs

POSTMAN_GET_ALL_APIS

Obtém todas as APIs acessíveis ao usuário autenticado, com filtragem opcional por workspace.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
limit	integer	Não	Número máximo de APIs a retornar por página.
cursor	string	Não	Cursor para paginação.
workspace	string	Não	Filtra por ID de workspace.

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 um ambiente

POSTMAN_GET_AN_ENVIRONMENT

Obtém informações detalhadas de um ambiente específico, incluindo nome, ID, proprietário e todas as variáveis de ambiente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
environment_id	string	Sim	Identificador único (ID ou UID) do ambiente a consultar.

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 uma coleção (parcial)

POSTMAN_UPDATE_PART_OF_A_COLLECTION

Atualiza propriedades específicas de uma coleção como nome, descrição, autenticação, variáveis ou eventos. Use quando precisar atualizar parcialmente uma coleção sem substituir toda a estrutura.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
collection	object	Sim	Objeto da coleção contendo as propriedades a atualizar. Pode incluir info (com nome, descrição), auth, variables ou events.
collection_id	string	Sim	Identificador único (ID ou UID) da coleção a atualizar.

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 um ambiente

POSTMAN_UPDATE_AN_ENVIRONMENT

Atualiza propriedades específicas de um ambiente usando operações JSON Patch (RFC 6902). Use quando precisar modificar nome ou variáveis sem substituir o ambiente inteiro.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
operations	array	Sim	Array de operações JSON Patch a aplicar ao ambiente. Cada operação modifica um campo específico no formato RFC 6902.
environment_id	string	Sim	Identificador único (ID ou UID) do ambiente a atualizar.

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

POSTMAN_UPDATE_A_WORKSPACE

Atualiza um workspace existente no Postman. Use quando precisar modificar o nome, tipo ou descrição de um workspace. O campo type é obrigatório em todas as atualizações.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
workspace	object	Sim	Objeto do workspace contendo os campos a atualizar. O campo type é obrigatório; name e description são opcionais.
workspace_id	string	Sim	Identificador único do workspace a atualizar.

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 uma coleção

POSTMAN_DELETE_A_COLLECTION

Exclui permanentemente uma coleção do Postman. Use quando precisar remover uma coleção que não é mais necessária.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
collection_id	string	Sim	Identificador único (UID ou ID) da coleção 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.

Excluir um ambiente

POSTMAN_DELETE_AN_ENVIRONMENT

Exclui permanentemente um ambiente no Postman. Use quando precisar remover um ambiente que não é mais necessário.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
environment_id	string	Sim	ID ou UID do ambiente 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.

Importar especificação OpenAPI

POSTMAN_IMPORT_OPENAPI

Importa uma especificação OpenAPI para o Postman como uma nova coleção em um workspace específico.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
type	string	Sim	Tipo de entrada: use string para fornecer a especificação como string JSON/YAML.
input	string	Sim	Conteúdo da especificação OpenAPI como string JSON ou YAML. Deve ser uma especificação OpenAPI 3.0+ válida.
workspace	string	Sim	Identificador único do workspace onde a especificação OpenAPI será importada.

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.

Gerar coleção a partir de especificação

POSTMAN_GENERATE_A_COLLECTION_FROM_SPEC

Gera uma coleção Postman a partir de uma especificação OpenAPI 2.0, 3.0 ou 3.1. A operação é assíncrona e retorna um ID de tarefa para acompanhar o status.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome para a coleção gerada.
options	object	Não	Opções de configuração para a geração da coleção a partir da especificação.
spec_id	string	Sim	Identificador único da especificação de API a partir da qual gerar a coleção.
element_type	string	Não	Tipo de elemento a gerar. Use collection para geração de coleçã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.

Transformar coleção para OpenAPI

POSTMAN_TRANSFORM_COLLECTION_TO_OPENAPI

Transforma uma coleção Postman existente em uma definição OpenAPI 3.0.3 em formato string. Use quando precisar converter uma coleção para o formato OpenAPI para documentação ou interoperabilidade.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
collection_id	string	Sim	Identificador único da coleção a transformar no formato OpenAPI.

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.

Executar um monitor

POSTMAN_RUN_A_MONITOR

Dispara a execução imediata de um monitor e retorna os resultados. Use quando precisar executar manualmente um monitor fora dos seus agendamentos regulares.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
monitor_id	string	Sim	Identificador único (ID ou UID) do monitor a executar.

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.

Criar um pull request

POSTMAN_CREATE_A_PULL_REQUEST

Cria um pull request para mesclar um fork de coleção em sua coleção pai. A coleção fork deve existir antes de criar o pull request.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
title	string	Sim	Título do pull request. Deve resumir as alterações propostas.
reviewers	array	Não	Array de IDs de usuários ou grupos que devem revisar o pull request.
description	string	Não	Descrição detalhada das alterações no pull request.
collection_uid	string	Sim	UID da coleção fork a partir da qual criar o pull request. Formato: {owner}-{collectionId}.
destination_id	string	Sim	UID da coleção de destino (pai) onde as alterações serão mescladas. Formato: {owner}-{collectionId}.

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 usuário autenticado

POSTMAN_GET_AUTHENTICATED_USER

Obtém informações sobre o usuário autenticado, incluindo ID de usuário, nome de usuário e endereço de e-mail.

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 todos os monitores

POSTMAN_GET_ALL_MONITORS

Obtém todos os monitores acessíveis ao usuário autenticado, com filtragem opcional por workspace.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
limit	integer	Não	Número máximo de monitores a retornar por página. Padrão: 25.
cursor	string	Não	Cursor para paginação.
workspace	string	Não	Filtra por ID de workspace.

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.