Skip to content

Download item list

POST/v1/api/douyin/creator-v2/item-list-download

Export detailed data of top 1000 items within the specified time range Support filtering export content by genre types This API is for batch export, not suitable for real-time queries Export tasks are processed asynchronously, need to wait for server to generate file This API requires users to provide valid Douyin Creator Platform Cookie Use POST method, Cookie is transmitted in request body, more secure

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.

stringcookierequired

User's Douyin Creator Platform Cookie (required, transmitted in request body)

integermax_cursorrequired

Max cursor, i.e., end timestamp in milliseconds (required)

integermin_cursorrequired

Min cursor, i.e., start timestamp in milliseconds (required)

Optional<boolean>need_long_article

Include long articles, default true (optional)

Optional<array<integer>>type_filters

Genre type filter list, default all [1,2,3,4,5,8] (optional)

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, douyin

stringexecution_moderequired

Execution mode declared by the API registry.

Default: sync

pending response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"pending","model":"douyin/creator-v2/item-list-download"}

running response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"running","model":"douyin/creator-v2/item-list-download"}

completed response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"completed","model":"douyin/creator-v2/item-list-download","outputs":[{"data":{}}]}

failed response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"failed","model":"douyin/creator-v2/item-list-download","error":{"type":"upstream_error","message":"upstream request failed"}}

timeout response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"timeout","model":"douyin/creator-v2/item-list-download","error":{"type":"upstream_error","message":"upstream request failed"}}