Analyze popular keywords and topics in video comments to uncover user feedback Extract main content and opinions from audience comments to understand viewer focus points Support creators in optimizing content strategy and enhancing audience engagement and connection
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.
stringitem_idrequired
Video ID, required parameter, can be obtained from video sharing links or TikTok Studio
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.
Get comment keywords analysis
/v1/api/tiktok/analytics/comment-keywordsAnalyze popular keywords and topics in video comments to uncover user feedback Extract main content and opinions from audience comments to understand viewer focus points Support creators in optimizing content strategy and enhancing audience engagement and connection
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.
item_idrequiredVideo ID, required parameter, can be obtained from video sharing links or TikTok Studio
Response Schema
A synchronous completed response contains exactly one outputs item with only data. Failed and timeout responses contain error and never outputs.
idrequiredOpaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.
statusrequiredCurrent public run status.
Allowed values: pending, running, completed, failed, timeout
modelrequiredPublic SandBase model name used for this run.
outputsPresent only for completed runs. Contains exactly one item whose only field is data.
outputs[0].dataOperation-specific business payload. This reference uses an empty object when no safe example can be confirmed.
errorPresent only for failed or timeout runs. Contains a public error type and sanitized message.
error.typeStable public error category.
error.messageSanitized error message safe to show to clients.
usageUsage details when available.
API capabilities
capability_tagsrequiredCapabilities declared by the API registry.
Default:
api, tiktokexecution_moderequiredExecution mode declared by the API registry.
Default:
syncpending response
{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"pending","model":"tiktok/analytics/comment-keywords"}
running response
{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"running","model":"tiktok/analytics/comment-keywords"}
completed response
{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"completed","model":"tiktok/analytics/comment-keywords","outputs":[{"data":{}}]}
failed response
{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"failed","model":"tiktok/analytics/comment-keywords","error":{"type":"upstream_error","message":"upstream request failed"}}
timeout response
{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"timeout","model":"tiktok/analytics/comment-keywords","error":{"type":"upstream_error","message":"upstream request failed"}}