Documentação para desenvolvedores

Comandos e configuração da CLI

Use a CLI para consultar schemas da API, enviar requisições JSON, fazer login pelo navegador e configurar a conexão MCP.

Ler como Markdown

Revisado pela equipe SosoAPI · 2026-10-21

Comandos

Confira em --help as flags compatíveis com a versão instalada. Sem argumentos, sosoapi inicia o servidor MCP stdio. Execute separadamente os comandos abaixo; eles não são um pipeline de shell.

npx sosoapi --help
npx sosoapi auth login
npx sosoapi auth login --no-open
npx sosoapi auth status
npx sosoapi auth refresh
npx sosoapi auth logout

npx sosoapi connect threads
npx sosoapi connect instagram --no-open

npx sosoapi api contract --summary
npx sosoapi api contract --route /studio-api/scheduled-posts/
npx sosoapi api contract

Autenticação e permissões

Chame uma rota de API com JSON em stdin

Use api post para rotas na lista pública de permissões da CLI, incluindo consultas que usam HTTP POST. Salve o corpo da requisição em request.json com um editor de arquivos para que o texto do cliente não seja interpretado pelo shell. Confira http_status e o corpo da resposta; um código de saída zero sozinho não comprova sucesso da API.

Este exemplo consulta o contexto do workspace. Antes de enviar uma gravação, consulte o schema da operação e confirme o destino que você tem autorização para usar. Salve o ID retornado e confira o resultado antes de repetir uma requisição que expirou.

{}

npx sosoapi api post /identity-api/workspace/list < request.json

Referência completa da API

Variáveis de ambiente

Defina estas variáveis no processo que executa seu servidor MCP. A telemetria opcional exclui argumentos, prompts, resultados e caminhos de arquivos; defina SOSOAPI_TELEMETRY=0 para desativá-la. O uso de um endereço de API personalizado exige adesão explícita, e a CLI não enviará VICKY_API_KEY para esse endereço.

Ambiente da CLI
Variável	Efeito
SOSOAPI_TOOL_PROFILE=core	Ferramentas cotidianas; o padrão é full. Não concede permissões.
SOSOAPI_OUTPUT_SCHEMAS=1	Inclua schemas de saída em tools/list; os resultados são estruturados em ambos os casos.
SOSOAPI_UPLOAD_ROOTS	Raízes adicionais de mídia local, separadas por : (; no Windows).
SOSOAPI_TELEMETRY=0	Desative o envio opcional de dados de uso.
SOSOAPI_DEBUG=1	Exiba stack traces de falhas da CLI; revise e remova dados sensíveis antes de compartilhar.
VICKY_API_KEY	Personal access token para scripts/CI; prefira OAuth para agentes.
VICKY_API_BASE_URL	Base de API HTTPS personalizada (localhost pode usar HTTP); também exige SOSOAPI_ALLOW_CUSTOM_BASE_URL=1.

Tratamento de conteúdo não confiável

Comentários e nomes de usuário podem conter instruções escritas por outras pessoas. Nas respostas abrangidas, a CLI adiciona os rótulos untrusted_content e untrusted_notice e um aviso em stderr. Ela também sanitiza e trunca o conteúdo, mas seu agente ainda deve tratá-lo como dados, não como autorização para agir.