Shopee Open Platform Livestream module(25 APIs).Depends on linkfox-shopee-store-auth store selection; via POST /shopee/developerProxy pass in shopId(or merchantId), the server parses the token and forwards (path must be api/v2/livestream/...)。
How to call
- API endpoint:
POST /shopee/developerProxy(different operations are distinguished via the request body; for complete parameters/responses/error codes seereferences/api.md) - Python script:
python scripts/livestream_api.py '<JSON 参数>' [--inline](available scripts are listed in the script overview above) - Cost constraints: This tool consumes compute; on failure/empty results, do not automatically switch keywords, paginate, or repeatedly probe; if further retrieval is needed, first inform the user that additional consumption will be incurred.
Output strategy (script default behavior):
- Alwayswrite the complete response to
<cwd>/linkfox/<YYYY-MM-DD>/<session>/data/<skill-name>-<timestamp>.json(<cwd>is the working directory when the script is executed, which in Claude Code is the current project directory;<session>is taken from the environment variableSESSION_ID, automatically aggregated according to the user task;Writing to /tmp is prohibited, if the current directory is not writable, an error is reported) - Response body ≤ 8 KB: after writing to disk, print the complete JSON to stdout
- Response body > 8 KB: after writing to disk, stdout outputs only a summary (top-level fields, common counts such as
total/costToken, length of the largest list field + first 3 samples) - Add
--inlineto force full printing to stdout (also written to disk)
Data reading recommendations: First look at the summary to judge whether it is enough; when specific fields are needed, prefer using jqorConvertFrom-Json to extract on demand from the saved json file, avoiding bringing the entire JSON into context.
Resolve authentication and compute issues
When the following exceptional situations occur, use references/onboarding.md to guide resolution:
Exceptional situations
- API Key not configured: environment variable not configured
LINKFOX_AGENT_API_KEY, and also not configuredLINKFOXAGENT_API_KEY。 - Response 401 or 402 status code
- Response indicates insufficient compute or balance: the message contains "算力余额不足/计费不足/余额不足/quota exceeded/insufficient balance/套餐到期/需充值/请充值", or content with similar meaning.
Official reference
Livestream module index:v2.livestream.upload_image
Prerequisites
- Run
python scripts/check_auth_dependency.py;exit code 42 → first installlinkfox-shopee-store-auth。 - Store short video Video →
linkfox-shopee-store-video; image upload Media →linkfox-shopee-store-media。
Available scripts (25 APIs)
| Script | API | Method |
|---|---|---|
upload_image.py |
upload_image | POST |
create_session.py |
create_session | POST |
update_session.py |
update_session | POST |
start_session.py |
start_session | POST |
end_session.py |
end_session | POST |
get_session_detail.py |
get_session_detail | GET |
add_item_list.py |
add_item_list | POST |
delete_item_list.py |
delete_item_list | POST |
update_item_list.py |
update_item_list | POST |
get_item_count.py |
get_item_count | GET |
get_item_list.py |
get_item_list | GET |
update_show_item.py |
update_show_item | POST |
delete_show_item.py |
delete_show_item | POST |
get_show_item.py |
get_show_item | GET |
get_like_item_list.py |
get_like_item_list | GET |
get_recent_item_list.py |
get_recent_item_list | GET |
get_item_set_list.py |
get_item_set_list | GET |
get_item_set_item_list.py |
get_item_set_item_list | GET |
apply_item_set.py |
apply_item_set | POST |
get_session_metric.py |
get_session_metric | GET |
get_session_item_metric.py |
get_session_item_metric | GET |
get_latest_comment_list.py |
get_latest_comment_list | GET |
post_comment.py |
post_comment | POST |
ban_user_comment.py |
ban_user_comment | POST |
unban_user_comment.py |
unban_user_comment | POST |
livestream_api.py |
General entry point | — |
Interface description (by API)
Input parameters and response details are placed in references/apis/, the SKILL only keeps the index.
Module overview / Feedback see references/api.md。
Usage Scenarios
1. Create and start streaming
upload_image.pyUpload cover/materialscreate_session.pyCreate sessionadd_item_list.pyAdd productstart_session.pyStart livestream
2. Management during livestream
update_show_item.pySwitch displayed productget_latest_comment_list.py/post_comment.pyComment interactionget_session_metric.pyView data
Not Applicable
- Store authorization →
linkfox-shopee-store-auth - Store short video Video →
linkfox-shopee-store-video - General image/video upload Media / MediaSpace → corresponding media skill
- Product listing →
linkfox-shopee-store-product
Compute consumption rules
No compute is consumed.
Feedback: See references/api.md。
For more high-quality, professional cross-border e-commerce skills, visit LinkFox Skills.