Fetch item list

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

Get all published items within the specified time range Support pagination query, maximum 100 items per request Data update description: Views, likes, comments, shares, favorites update in real-time Other metrics update hourly 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)

Optional<integer>count

Number of items per page, default 10, max 100 (optional)

Optional<integer | null>cursor

Pagination cursor, don't pass for first request, use returned cursor for pagination (optional)

integerend_timerequired

End timestamp in milliseconds (required)

Optional<string>fields

Fields to return, default "metrics,review,visibility" (optional)

Optional<boolean>need_cooperation

Need cooperation info, default true (optional)

Optional<boolean>need_long_article

Include long articles, default true (optional)

Optional<integer>order_by

Sort method, supports 26 types (optional, default 1)

integerstart_timerequired

Start timestamp in milliseconds (required)

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"}

running response

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

completed response

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

failed response

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

timeout response

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

curl -X POST https://api.sandbase.ai/v1/api/douyin/creator-v2/item-list \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{\n
  "cookie": "cookie",
  "end_time": 1,
  "start_time": 1
}'

Response200 OK

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