SuperAPI AI Directory

linkfox-shopee-store-livestream

Coding & development

View repository

Updated 10-16 00:00

About this skill

Shopee Livestream

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 see references/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 variable SESSION_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 --inline to 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 configured LINKFOXAGENT_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

  1. Run python scripts/check_auth_dependency.py;exit code 42 → first install linkfox-shopee-store-auth。
  2. 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.

API Documentation
add_item_list references/apis/add-item-list.md
apply_item_set references/apis/apply-item-set.md
ban_user_comment references/apis/ban-user-comment.md
create_session references/apis/create-session.md
delete_item_list references/apis/delete-item-list.md
delete_show_item references/apis/delete-show-item.md
end_session references/apis/end-session.md
get_item_count references/apis/get-item-count.md
get_item_list references/apis/get-item-list.md
get_item_set_item_list references/apis/get-item-set-item-list.md
get_item_set_list references/apis/get-item-set-list.md
get_latest_comment_list references/apis/get-latest-comment-list.md
get_like_item_list references/apis/get-like-item-list.md
get_recent_item_list references/apis/get-recent-item-list.md
get_session_detail references/apis/get-session-detail.md
get_session_item_metric references/apis/get-session-item-metric.md
get_session_metric references/apis/get-session-metric.md
get_show_item references/apis/get-show-item.md
post_comment references/apis/post-comment.md
start_session references/apis/start-session.md
unban_user_comment references/apis/unban-user-comment.md
update_item_list references/apis/update-item-list.md
update_session references/apis/update-session.md
update_show_item references/apis/update-show-item.md
upload_image references/apis/upload-image.md

Module overview / Feedback see references/api.md。

Usage Scenarios

1. Create and start streaming

  1. upload_image.py Upload cover/materials
  2. create_session.py Create session
  3. add_item_list.py Add product
  4. start_session.py Start livestream

2. Management during livestream

  1. update_show_item.py Switch displayed product
  2. get_latest_comment_list.py / post_comment.py Comment interaction
  3. get_session_metric.py View 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.