תיעוד למפתחים

פקודות והגדרות CLI

השתמשו ב-CLI לבדיקת סכמות API, לשליחת בקשות JSON, לכניסה דרך הדפדפן ולהגדרת חיבור ה-MCP שלכם.

נבדק על ידי צוות SosoAPI · 2026-10-21

פקודות

בדקו ב--help אילו דגלים הגרסה המותקנת שלכם תומכת בהם. ללא ארגומנטים, sosoapi מפעיל את שרת MCP stdio. הריצו את הפקודות שלהלן בנפרד; הן אינן צינור פקודות 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

אימות והרשאות

קריאה לנתיב API עם JSON דרך stdin

השתמשו ב-api post לנתיבים ברשימת ההרשאה הציבורית של ה-CLI, כולל קריאות שמשתמשות ב-HTTP POST. שמרו את גוף הבקשה ב-request.json בעורך קבצים כדי שטקסט לקוח לא יתפרש על ידי ה-shell. בדקו http_status ואת גוף התגובה; קוד יציאה אפס לבדו אינו מוכיח הצלחת API.

הדוגמה קוראת את הקשר סביבת העבודה. לפני שליחת כתיבה, בדקו את סכמת הפעולה ואשרו את היעד שאתם מורשים להשתמש בו. שמרו את המזהה שהוחזר ובדקו את התוצאה לפני ניסיון חוזר לבקשה שחרגה מזמן ההמתנה.

{}

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

תיעוד API מלא

משתני סביבה

הגדירו את המשתנים האלה בתהליך שמריץ את שרת ה-MCP שלכם. טלמטריה אופציונלית אינה כוללת ארגומנטים, הנחיות, תוצאות ונתיבי קבצים; הגדירו SOSOAPI_TELEMETRY=0 כדי לכבות אותה. שימוש בכתובת API מותאמת דורש הסכמה מפורשת, וה-CLI לא ישלח VICKY_API_KEY לכתובת הזו.

סביבת CLI
משתנה	השפעה
SOSOAPI_TOOL_PROFILE=core	כלים יומיומיים; ברירת המחדל היא full. אינו מעניק הרשאות.
SOSOAPI_OUTPUT_SCHEMAS=1	הכללת סכמות פלט ב-tools/list; התוצאות מובנות בכל מקרה.
SOSOAPI_UPLOAD_ROOTS	תיקיות שורש נוספות למדיה מקומית, מופרדות ב-: ‏(; ב-Windows).
SOSOAPI_TELEMETRY=0	כיבוי דיווח שימוש אופציונלי.
SOSOAPI_DEBUG=1	הדפסת עקבות מחסנית של כשלי CLI; בדקו והסירו מידע רגיש לפני שיתוף.
VICKY_API_KEY	אסימון גישה אישי לסקריפטים/CI; העדיפו OAuth לסוכנים.
VICKY_API_BASE_URL	כתובת בסיס API מותאמת ב-HTTPS ‏(localhost יכול להשתמש ב-HTTP); נדרש גם SOSOAPI_ALLOW_CUSTOM_BASE_URL=1.

טיפול בתוכן לא מהימן

תגובות ושמות משתמשים עשויים להכיל הוראות שאנשים אחרים כתבו. לתגובות המכוסות, ה-CLI מוסיף תוויות untrusted_content ו-untrusted_notice ואזהרה ב-stderr. הוא גם מסנן וקוטע תוכן, אבל הסוכן עדיין חייב להתייחס אליו כנתונים ולא כסמכות לבצע פעולה.