Skip to content

Get WeChat Channels Collection Videos

POST/v1/api/wechat-channels/v2/collection-videos

Given a collection `topic_id` (from `fetch_user_collections`), return the video list inside that collection. Each video carries a `media` object (`url` / `url_token` / `decode_key`) ready for download and decryption. Supports pagination for more videos. Price: $0.01 per request ⏱️ Due to WeChat server latency, this endpoint responds slowly; please set your client request timeout to 30 seconds — a timeout that is too small may result in being billed without receiving the response. ⚠️ Large-integer ID precision: IDs such as `id` / `topic_id` in the response are 64-bit big integers beyond JavaScript's safe-integer range (2^53-1). Always receive / pass such IDs as strings (parse JSON with json-bigint or read them as text), never through JS `Number`. Swagger UI rounds the trailing digits of huge integers in its docs view — this is expected and does not affect the actual data returned by the API.

Request body

Call this sync operation at its vendor-qualified URL. The model identity is encoded in the path; only operation-specific input fields belong in the request body.

Optional<string | null>last_buffer

Optional pagination cursor (base64), **leave empty for the first page**; when `down_continue` is truthy, pass the previous page's `last_buffer`.

Optional<boolean>raw

Optional, default True. True=raw response; False=simplified parsed structure (recommended for media download).

Optional<string | null>topic

Collection name (optional, improves hit rate)

stringtopic_idrequired

Collection ID (numeric, from topic_id of fetch_user_collections)

Length: 0 to 32. Pattern: ^[0-9]+$

Optional<integer>topic_type

Optional, collection type, default 16 (align with the collection's `topic_type` from `fetch_user_collections`).

Range: 0 to 1000

Optional<string | null>username

Optional, creator finder username (`v2_…@finder` format), improves hit rate.

Response Schema

A synchronous completed response contains exactly one outputs item with only data. Failed and timeout responses contain error and never outputs.

stringidrequired

Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.

stringstatusrequired

Current public run status.

Allowed values: pending, running, completed, failed, timeout

stringmodelrequired

Public SandBase model name used for this run.

Optional<array<object>>outputs

Present only for completed runs. Contains exactly one item whose only field is data.

Optional<object | array>outputs[0].data

Operation-specific business payload. This reference uses an empty object when no safe example can be confirmed.

Optional<object>error

Present only for failed or timeout runs. Contains a public error type and sanitized message.

Optional<string>error.type

Stable public error category.

Optional<string>error.message

Sanitized error message safe to show to clients.

Optional<object>usage

Usage details when available.

API capabilities

array<string>capability_tagsrequired

Capabilities declared by the API registry.

Default: api, wechat-channels

stringexecution_moderequired

Execution mode declared by the API registry.

Default: sync

pending response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"pending","model":"wechat-channels/v2/collection-videos"}

running response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"running","model":"wechat-channels/v2/collection-videos"}

completed response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"completed","model":"wechat-channels/v2/collection-videos","outputs":[{"data":{}}]}

failed response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"failed","model":"wechat-channels/v2/collection-videos","error":{"type":"upstream_error","message":"upstream request failed"}}

timeout response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"timeout","model":"wechat-channels/v2/collection-videos","error":{"type":"upstream_error","message":"upstream request failed"}}