Skip to content

Creator Search Insights

POST/v1/api/tiktok/app-v3/creator-search-insights

Get creator search insights data, used to understand trending search topics and creative inspiration

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

Category filters, separated by comma, options: Gaming, Fashion, Tourism, Science, Food, Sports

Default: ""

Optional<string>creator_source

Creator source, default "general_search"

Default: general_search

Optional<boolean>force_refresh

Force refresh, default False

Default: false

Optional<string>language_filters

Language filters, separated by comma, options: id, de, en, es, fr, pt, vi, tr, ar, th, ja, ko

Default: en

Optional<integer>limit

Number per page, default 20

Default: 20

Optional<integer>offset

Pagination offset, default 0

Default: 0

Optional<string>tab

Tab type, options:

Default: all

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/creator-search-insights"}

running response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"running","model":"tiktok/app-v3/creator-search-insights"}

completed response

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

failed response

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

timeout response

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