API reference · TikTok

tiktok/ads/ad-percentile

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

APISynchronousOpen model
Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run
Model IDtiktok/ads/ad-percentile
01

Input Schema

3 parameters · 1 required · 2 optional

ParameterTypeRequiredDescription
material_idstringRequired广告素材ID/Ad material ID
metricstringOptional分析指标/Analysis metric (ctr_percentile, time_attr_conversion_rate_percentile, click_cnt_percentile, time_attr_convert_cnt_percentile, show_cnt_percentile) · Default: "ctr_percentile"
period_typeintegerOptional时间范围(天)/Time period (days) · Default: 180
02

Output Schema

FieldTypeDescription
idstringUnique identifier for the generation task
statusstringTask status: pending, running, completed, failed, timeout
modelstringModel used for the generation
outputsarrayArray of output items
outputs[].urlstringURL of the generated artifact
outputs[].content_typestringMIME type (e.g. image/png, video/mp4)
errorobject | nullError details if failed, null on success
error.typestringMachine-readable error type code
error.messagestringHuman-readable error description
03

Code Examples

Ready-to-run snippets

curl -X POST https://api.sandbase.ai/v1/run \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "model": "tiktok/ads/ad-percentile",
  "metric": "ctr_percentile",
  "period_type": 180,
  "prompt": "a beautiful sunset over mountains"
}'