Documentation développeur
Commandes et configuration CLI
Utilisez la CLI pour examiner les schémas API, envoyer des requêtes JSON, vous connecter dans le navigateur et configurer votre connexion MCP.
Lire en MarkdownVérifié par l’équipe SosoAPI ·
Commandes
Consultez --help pour les options prises en charge par la version installée. Sans arguments, sosoapi démarre le serveur MCP stdio. Exécutez les commandes ci-dessous séparément ; ce n’est pas un pipeline 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 logoutnpx sosoapi connect threads
npx sosoapi connect instagram --no-opennpx sosoapi api contract --summary
npx sosoapi api contract --route /studio-api/scheduled-posts/
npx sosoapi api contractAppeler une route API avec du JSON sur stdin
Utilisez api post pour les routes de la liste publique autorisée de la CLI, y compris les lectures en HTTP POST. Enregistrez le corps dans request.json avec un éditeur pour éviter l’interprétation du texte client par le shell. Vérifiez http_status et le corps de réponse ; un code de sortie nul seul ne prouve pas la réussite API.
Cet exemple lit le contexte de l’espace. Avant une écriture, consultez le schéma et confirmez la destination autorisée. Enregistrez l’identifiant renvoyé et vérifiez le résultat avant de réessayer une requête expirée.
{}npx sosoapi api post /identity-api/workspace/list < request.jsonVariables d’environnement
Définissez ces variables dans le processus exécutant le serveur MCP. La télémétrie facultative exclut arguments, prompts, résultats et chemins de fichiers ; SOSOAPI_TELEMETRY=0 la désactive. Une adresse API personnalisée nécessite un accord explicite et la CLI n’y enverra pas VICKY_API_KEY.
| Variable | Effet |
|---|---|
| SOSOAPI_TOOL_PROFILE=core | Outils courants ; full par défaut. N’accorde aucune autorisation. |
| SOSOAPI_OUTPUT_SCHEMAS=1 | Inclure les schémas de sortie dans tools/list ; les résultats sont structurés dans les deux cas. |
| SOSOAPI_UPLOAD_ROOTS | Dossiers locaux de médias supplémentaires, séparés par : (; sous Windows). |
| SOSOAPI_TELEMETRY=0 | Désactiver les rapports d’utilisation facultatifs. |
| SOSOAPI_DEBUG=1 | Afficher les traces de pile des échecs CLI ; vérifier et expurger avant partage. |
| VICKY_API_KEY | Jeton d’accès personnel pour scripts/CI ; préférer OAuth pour les agents. |
| VICKY_API_BASE_URL | Base API HTTPS personnalisée (localhost peut utiliser HTTP) ; nécessite aussi SOSOAPI_ALLOW_CUSTOM_BASE_URL=1. |
Traitement du contenu non fiable
Les commentaires et noms d’utilisateur peuvent contenir des instructions écrites par d’autres. Pour les réponses couvertes, la CLI ajoute untrusted_content et untrusted_notice ainsi qu’un avertissement sur stderr. Elle assainit et tronque aussi le contenu, mais votre agent doit toujours le traiter comme des données plutôt que comme une autorisation d’agir.