Ontwikkelaarsdocumentatie

CLI-opdrachten en configuratie

Gebruik de CLI om API-schema's te bekijken, JSON-verzoeken te versturen, via de browser aan te melden en je MCP-verbinding te configureren.

Lezen als Markdown

Beoordeeld door het SosoAPI-team · 2026-10-21

Opdrachten

Bekijk --help voor de opties die je geïnstalleerde versie ondersteunt. Zonder argumenten start sosoapi de MCP stdio-server. Voer onderstaande opdrachten apart uit; ze vormen geen shell-pipeline.

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

Authenticatie en machtigingen

Roep een API-route aan met JSON stdin

Gebruik api post voor routes op de openbare toestemmingslijst van de CLI, inclusief leesacties met HTTP POST. Bewaar de verzoekinhoud met een bestandseditor in request.json zodat de shell klanttekst niet interpreteert. Controleer http_status en antwoordinhoud; alleen afsluitcode nul bewijst geen API-succes.

Dit voorbeeld leest werkruimtecontext. Zoek vóór een schrijfhandeling het bewerkingsschema op en bevestig de bestemming die je mag gebruiken. Bewaar de teruggegeven ID en controleer het resultaat voordat je een verzoek met time-out opnieuw probeert.

{}

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

Volledige API-naslag

Omgevingsvariabelen

Stel deze variabelen in op het proces dat je MCP-server uitvoert. Optionele telemetrie bevat geen argumenten, prompts, resultaten of bestandspaden; stel SOSOAPI_TELEMETRY=0 in om dit uit te schakelen. Een aangepast API-adres vereist expliciete toestemming en de CLI verstuurt VICKY_API_KEY niet naar dat adres.

CLI-omgeving
Variabele	Effect
SOSOAPI_TOOL_PROFILE=core	Dagelijkse tools; standaard full. Verleent geen machtigingen.
SOSOAPI_OUTPUT_SCHEMAS=1	Neem uitvoerschema's op in tools/list; resultaten zijn in beide gevallen gestructureerd.
SOSOAPI_UPLOAD_ROOTS	Extra lokale mediamappen, gescheiden door : (; op Windows).
SOSOAPI_TELEMETRY=0	Schakel optionele gebruiksrapportage uit.
SOSOAPI_DEBUG=1	Toon stacktraces van CLI-fouten; controleer en verwijder gevoelige gegevens vóór delen.
VICKY_API_KEY	Persoonlijk toegangstoken voor scripts/CI; gebruik bij voorkeur OAuth voor agents.
VICKY_API_BASE_URL	Aangepaste HTTPS API-basis (localhost mag HTTP gebruiken); vereist ook SOSOAPI_ALLOW_CUSTOM_BASE_URL=1.

Omgaan met niet-vertrouwde inhoud

Reacties en gebruikersnamen kunnen instructies van andere mensen bevatten. Voor toepasselijke antwoorden voegt de CLI de labels untrusted_content en untrusted_notice en een waarschuwing op stderr toe. Ook wordt inhoud opgeschoond en ingekort, maar je agent moet deze nog steeds als gegevens behandelen en niet als bevoegdheid om te handelen.