Skip to content

Get user homepage video data V1

POST/v1/api/tiktok/app-v3/user-post-videos

Get user homepage video data

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<integer>count

Maximum count number

Default: 20

Optional<integer>max_cursor

Maximum cursor, used for paging, the first page is 0, the second page is the max_cursor value in the first response.

Default: 0

Optional<string>region

Region, optional parameter, if not passed, the US region data will be used by default. After passing, the data of the corresponding country and region will be preferred, for example: US, GB, FR, JP, SG, VN, etc.

Default: ""

Optional<string>sec_user_id

User sec_user_id, use sec_user_id to get user video data first, if sec_user_id is empty, use unique_id to get user video data.

Default: ""

Optional<integer>sort_type

Sort type, 0-Latest, 1-Hot

Default: 0

Optional<string>unique_id

User unique_id, optional parameter, if sec_user_id is empty, use unique_id to get user video data, unique_id is also the user's username.

Default: ""

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

stringexecution_moderequired

Execution mode declared by the API registry.

Default: sync

pending response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"pending","model":"tiktok/app-v3/user-post-videos"}

running response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"running","model":"tiktok/app-v3/user-post-videos"}

completed response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"completed","model":"tiktok/app-v3/user-post-videos","outputs":[{"data":{}}]}

failed response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"failed","model":"tiktok/app-v3/user-post-videos","error":{"type":"upstream_error","message":"upstream request failed"}}

timeout response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"timeout","model":"tiktok/app-v3/user-post-videos","error":{"type":"upstream_error","message":"upstream request failed"}}