Increase the number of plays of the work according to the video ID

POST/v1/api/douyin/app-v3/add-video-play-count

Increase the number of plays of the work according to the video ID This interface uses guest Cookie by default. If you need to use the Cookie of the logged-in user, please pass it in the parameters. Each call to a single work increases the number of plays by 1. After about `1000` calls, Douyin will restrict it. You need to wait for a period of time (such as 2 hours) before continuing to call. This restriction is for the work, not for the interface. When browsing the work without logging in, using different IP browsers or browsing the work in the APP, the number of plays of the work will not increase. You can carry the Cookie of the Douyin web page to request this interface, but it is not guaranteed to be effective and needs to be tested by yourself. The above restrictions are based on test results, and the specific restrictions may vary, for reference only.

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.

integeraweme_typerequired

Video type, 0: Video 1: Graphic and text, can be obtained from the single work data interface.

Optional<string>cookie

Optional, use guest Cookie by default

stringitem_idrequired

Video id, alias aweme_id

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/app-v3/add-video-play-count"}

running response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"running","model":"douyin/app-v3/add-video-play-count"}

completed response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"completed","model":"douyin/app-v3/add-video-play-count","outputs":[{"data":{}}]}

failed response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"failed","model":"douyin/app-v3/add-video-play-count","error":{"type":"upstream_error","message":"upstream request failed"}}

timeout response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"timeout","model":"douyin/app-v3/add-video-play-count","error":{"type":"upstream_error","message":"upstream request failed"}}

curl -X POST https://api.sandbase.ai/v1/api/douyin/app-v3/add-video-play-count \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{\n
  "aweme_type": 1,
  "item_id": "item_id"
}'

Response200 OK

{
  "id": "f3d2e8a1-7c4b-4a12-9d2e-123456789abc",
  "status": "completed",
  "model": "douyin/app-v3/add-video-play-count",
  "outputs": [
    {
      "data": {}
    }
  ]
}