Skip to content

Fetch live search V1

POST/v1/api/douyin/search/live-search-v1

Fetch live stream search results from Douyin App. Returns information about live rooms including streamer profile, cover image, viewer count, and stream URLs.

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>backtrace

Backtrace for pagination, obtained from the last response

Optional<string>content_type

Content type (fixed for live stream)

Optional<integer>cursor

Pagination cursor (0 for first request)

Optional<string>filter_duration

Video duration filter

Optional<string>keyword

Search keyword, e.g., "games"

Optional<string>publish_time

Publish time filter

Optional<string>search_id

Search ID for pagination

Optional<string>sort_type

Sorting method

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/search/live-search-v1"}

running response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"running","model":"douyin/search/live-search-v1"}

completed response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"completed","model":"douyin/search/live-search-v1","outputs":[{"data":{}}]}

failed response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"failed","model":"douyin/search/live-search-v1","error":{"type":"upstream_error","message":"upstream request failed"}}

timeout response

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