WeChat Get User Collections
## Purpose Get the collections listed on a WeChat Channels creator's homepage. This returns collection information, not the videos within each collection. ## Inputs Provide a `request_body` object containing: - `username` (required): the creator's finder username, in `v2_…@finder` format. It must be 10–256 characters and match `^v2_[0-9a-fA-F]+@finder$`; a display name cannot be used instead. - `raw` (optional boolean, default `true`): `true` returns the full raw structure; `false` returns a simplified structure. ## Results With `raw=false`, `data.username` identifies the creator, `data.count` is the total collection count, and `data.collections[]` contains: - `topic_id`: collection ID, usable for a separate collection-video lookup. - `name` and `desc`: collection name and description; the description may be empty. - `cover_url`: collection cover image URL. - `feed_count`: number of videos in the collection. - `topic_type`: collection type, usable with the collection ID for a separate video lookup. With `raw=true`, the corresponding fields are `data.collectionCount` and `data.collectionInfo[]`, with item fields `collectionTopicId`, `collectionName`, `collectionDesc`, `coverImgUrl`, `feedCount`, and `collectionTopicType`. `collectionTopicIdStr` provides a string alias for the ID. Raw data may also contain `lastUpdateTime`, `readCount`, and `categoryId`. `data.lastBuffer` is a collection-list pagination cursor, usually empty; this tool has no pagination input. ## Usage notes - Collection IDs may exceed JavaScript's safe-integer limit. Use lossless JSON parsing and preserve IDs as exact strings; use `collectionTopicIdStr` when available. Do not pass large IDs through JavaScript `Number`. - Responses can be slow. A 30-second client request timeout is recommended.
Pricing
| Condition | Charge |
|---|---|
| Each call | 20.65 credits/call |
The fixed fee is 20.65 credits per call. Charges are per query. A successful query is billed even if it returns no results.
Parameters
Optional parameters use the platform defaults when omitted.
| Parameter | Type | Required | Description | Default |
|---|---|---|---|---|
request_body | object | Yes | 用于获取微信视频号创作者主页合集列表的请求体对象。username 为必填的创作者 finder username(v2_…@finder 格式);raw 为可选布尔值,默认 true,true 返回原始响应,false 返回精简解析结构。 | — |
request_body.raw | boolean | No | True=原始响应;False=精简解析结构/True=raw response; False=simplified parsed structure | true |
request_body.username | string | Yes | 视频号 finder username(v2_…@finder 格式)/WeChat Channels finder username (v2_…@finder format) | — |
Invocation example
Parameter templateGenerated from the parameter configuration. Replace the sample values before use.
/agent-api/v1/tool/executeX-Api-Keycurl --request POST \
--url 'https://agentearth.ai/agent-api/v1/tool/execute?tool_name=ae_wechat_get_user_collections' \
--header "X-Api-Key: $AGENTEARTH_API_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
"params": {
"request_body": {
"username": "v2_060000231003b20faec8c6e4811dc1d4c602ee30b0771bbcf220c67926bb76ab7702ac335a53@finder"
}
}
}'No response example available yet.






