{"openapi":"3.1.0","info":{"title":"Tikultra API","version":"1.0.0","description":"TikTok’s native mobile API behind one REST API: 180+ endpoints with their upstream paths, request signing in under a millisecond, device contexts and connected sessions for accounts you own. Priced per call; failed calls are free.","termsOfService":"https://tikultra.com/terms"},"servers":[{"url":"https://api.tikultra.com"}],"security":[{"apiKey":[]}],"tags":[{"name":"Videos & comments","description":"Videos by aweme_id or share link, comments, danmaku, transcripts and source media."},{"name":"Users & profiles","description":"Profiles, posts, stories, reposts, followers and creator audits."},{"name":"Feeds, search & Tako AI","description":"For You and persona feeds, search, vision search and the Tako assistant."},{"name":"TikTok Shop","description":"SDUI product pages, LIVE bags, sellers, showcases and reviews."},{"name":"LIVE rooms","description":"Room state, decoded chat, stream URLs, audiences and rankings."},{"name":"Series, sounds, hashtags & places","description":"Mini dramas, series, playlists, sounds, hashtags, places and templates."},{"name":"Connected sessions","description":"Publishing, profile, comments, DMs and LIVE hosting for accounts you own."},{"name":"Devices, signing & primitives","description":"Resolver, device contexts, request signing, protobuf and batch jobs."}],"paths":{"/v1/video":{"get":{"operationId":"getVideo","summary":"Get video","description":"One video by aweme_id or share URL: caption, stats, author, sound and the play stream’s codec, size and frame rate.\n\nUpstream: /aweme/v1/aweme/detail/.\n\nCost: 5 credits (standard tier). Failed calls are not charged.","tags":["Videos & comments"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/aweme/v1/aweme/detail/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/video"],"x-docs":"https://tikultra.com/docs/api/get-video","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"aweme_id":"7705852133855161377","desc":"Launch film, 1080p60 master #keyboards #desksetup","create_time":1762622512,"region":"US","author":{"uid":"6970000000000000001","unique_id":"acme","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","nickname":"Acme Studio","follower_count":128431,"verified":false},"stats":{"play_count":1482906,"digg_count":96442,"comment_count":1318,"share_count":4877,"collect_count":2210,"repost_count":614},"music":{"id":"7569924403851462401","title":"original sound - acme","author":"Acme Studio","duration_sec":31},"video":{"codec":"bytevc1","width":1080,"height":1920,"fps":60,"duration_ms":31840,"bitrate_bps":3842100,"play_url":"https://v16-webapp-prime.tiktok.com/video/tos/useast2a/tos-useast2a-pve-0068/oQ8kLmN2xR9pV/?a=1233","cover_url":"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/o8kLmN2xR9pV~tplv-tiktokx-origin.image"}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"aweme_id","in":"query","required":false,"description":"The numeric video ID.","schema":{"type":"string"},"example":"7705852133855161377"},{"name":"url","in":"query","required":false,"description":"A share link instead of an aweme_id: tiktok.com, vm.tiktok.com or vt.tiktok.com.","schema":{"type":"string"}},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/video/batch":{"post":{"operationId":"videoBatch","summary":"Batch videos","description":"Up to 50 videos in one call, billed per video.\n\nUpstream: /aweme/v1/multi/aweme/detail/.\n\nCost: 5 credits (standard tier) per item. Failed calls are not charged.","tags":["Videos & comments"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/aweme/v1/multi/aweme/detail/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/video/batch"],"x-docs":"https://tikultra.com/docs/api/video-batch","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"count":2,"items":[{"aweme_id":"7705852133855161377","desc":"Launch film, 1080p60 master #keyboards #desksetup","create_time":1762622512,"region":"US","author":{"uid":"6970000000000000001","unique_id":"acme","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","nickname":"Acme Studio","follower_count":128431,"verified":false},"stats":{"play_count":1482906,"digg_count":96442,"comment_count":1318,"share_count":4877,"collect_count":2210,"repost_count":614},"music":{"id":"7569924403851462401","title":"original sound - acme","author":"Acme Studio","duration_sec":31},"video":{"codec":"bytevc1","width":1080,"height":1920,"fps":60,"duration_ms":31840,"bitrate_bps":3842100,"play_url":"https://v16-webapp-prime.tiktok.com/video/tos/useast2a/tos-useast2a-pve-0068/oQ8kLmN2xR9pV/?a=1233","cover_url":"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/o8kLmN2xR9pV~tplv-tiktokx-origin.image"}},{"aweme_id":"7705852133855161378","desc":"Switch sound comparison: tactile vs linear","create_time":1762622512,"region":"US","author":{"uid":"6970000000000000001","unique_id":"acme","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","nickname":"Acme Studio","follower_count":128431,"verified":false},"stats":{"play_count":1482906,"digg_count":96442,"comment_count":1318,"share_count":4877,"collect_count":2210,"repost_count":614},"music":{"id":"7569924403851462401","title":"original sound - acme","author":"Acme Studio","duration_sec":31},"video":{"codec":"bytevc1","width":1080,"height":1920,"fps":60,"duration_ms":31840,"bitrate_bps":3842100,"play_url":"https://v16-webapp-prime.tiktok.com/video/tos/useast2a/tos-useast2a-pve-0068/oQ8kLmN2xR9pV/?a=1233","cover_url":"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/o8kLmN2xR9pV~tplv-tiktokx-origin.image"}}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"aweme_ids":{"type":"array","items":{"type":"string"},"description":"Up to 50 numeric video IDs."}},"required":["aweme_ids"]},"example":{"aweme_ids":["7705852133855161377","7705852133855161378"]}}}}}},"/v1/video/comments":{"get":{"operationId":"comments","summary":"Comments","description":"A page of comments on a video.\n\nUpstream: /aweme/v2/comment/list/.\n\nCost: 5 credits (standard tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Videos & comments"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/aweme/v2/comment/list/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/comments"],"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/comments","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":"20","has_more":true,"items":[{"cid":"7705860011122233344","aweme_id":"7705852133855161377","text":"Where is this keyboard from?","create_time":1762623100,"digg_count":412,"reply_comment_total":9,"comment_language":"en","user":{"uid":"6970000000000000002","unique_id":"kbfan","nickname":"KB Fan"}},{"cid":"7705860011122233345","aweme_id":"7705852133855161377","text":"That spacebar thock is unreal","create_time":1762623490,"digg_count":189,"reply_comment_total":2,"comment_language":"en","user":{"uid":"6970000000000000003","unique_id":"deskminimal","nickname":"Desk Minimal"}}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"aweme_id","in":"query","required":false,"description":"The numeric video ID.","schema":{"type":"string"},"example":"7705852133855161377"},{"name":"url","in":"query","required":false,"description":"A share link instead of an aweme_id: tiktok.com, vm.tiktok.com or vt.tiktok.com.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"name":"sort_strategy","in":"query","required":false,"description":"hot or new.","schema":{"type":"string","enum":["hot","new"]},"example":"hot"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/video/comments/replies":{"get":{"operationId":"commentReplies","summary":"Comment replies","description":"A page of replies to one comment.\n\nUpstream: /aweme/v1/comment/list/reply/.\n\nCost: 5 credits (standard tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Videos & comments"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/aweme/v1/comment/list/reply/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/comments/replies"],"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/comment-replies","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":null,"has_more":false,"items":[{"cid":"7705860099988877766","parent_cid":"7705860011122233344","aweme_id":"7705852133855161377","text":"It is our 75% gasket mount with POM plate!","create_time":1762623900,"digg_count":94,"author_pin":true,"user":{"uid":"6970000000000000001","unique_id":"acme","nickname":"Acme Studio"}}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"aweme_id","in":"query","required":true,"description":"The numeric video ID.","schema":{"type":"string"},"example":"7705852133855161377"},{"name":"comment_id","in":"query","required":true,"description":"The comment to read replies for.","schema":{"type":"string"},"example":"7705860011122233344"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/video/comments/by-ids":{"get":{"operationId":"commentsByIds","summary":"Comments by ID","description":"Look up comments by their IDs.\n\nUpstream: /tiktok/comment/status/batch_get/v1.\n\nCost: 5 credits (standard tier). Failed calls are not charged.","tags":["Videos & comments"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/tiktok/comment/status/batch_get/v1"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/comments-by-ids","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"items":[{"cid":"7705860011122233344","aweme_id":"7705852133855161377","status":1,"text":"Where is this keyboard from?","digg_count":412,"reply_comment_total":9,"user":{"unique_id":"kbfan"}}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"comment_ids","in":"query","required":true,"description":"Comma-separated comment IDs, up to 50.","schema":{"type":"string"},"example":"7705860011122233344"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/video/danmaku":{"get":{"operationId":"danmaku","summary":"Danmaku","description":"Time-coded floating “bullet” reactions viewers pin to moments in a video, with their offsets in milliseconds.\n\nUpstream: /tiktok/danmaku/get/v1, /tiktok/danmaku/list/v1.\n\nCost: 5 credits (standard tier). Failed calls are not charged.","tags":["Videos & comments"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/tiktok/danmaku/get/v1","/tiktok/danmaku/list/v1"],"x-access":"public","x-exclusive":true,"x-docs":"https://tikultra.com/docs/api/danmaku","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"aweme_id":"7705852133855161377","start_time_ms":0,"end_time_ms":30000,"items":[{"danmaku_id":"7705862000111222333","offset_ms":4120,"text":"the sound on this","digg_count":88},{"danmaku_id":"7705862000111222334","offset_ms":12840,"text":"wait for the typing test","digg_count":341}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"aweme_id","in":"query","required":true,"description":"The numeric video ID.","schema":{"type":"string"},"example":"7705852133855161377"},{"name":"start_time_ms","in":"query","required":false,"description":"Start of the window, in ms from the start of the video.","schema":{"type":"integer"},"example":"0"},{"name":"end_time_ms","in":"query","required":false,"description":"End of the window, in ms.","schema":{"type":"integer"},"example":"30000"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/video/transcript":{"get":{"operationId":"transcript","summary":"Transcript","description":"Time-aligned caption tracks for a video.\n\nUpstream: /aweme/v1/aweme/detail/.\n\nCost: 2 credits (primitive tier). Failed calls are not charged.","tags":["Videos & comments"],"x-credits":2,"x-tier":"primitive","x-upstream-paths":["/aweme/v1/aweme/detail/"],"x-access":"public","x-legacy-aliases":["/v1/tools/transcript"],"x-docs":"https://tikultra.com/docs/api/transcript","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"aweme_id":"7705852133855161377","language":"eng-US","source":"asr","duration_ms":31840,"full_text":"Here is how a gasket-mounted low-profile board sounds straight out of the box with factory-lubed switches.","segments":[{"start_ms":180,"end_ms":3640,"text":"Here is how a gasket-mounted low-profile board sounds"},{"start_ms":3640,"end_ms":7820,"text":"straight out of the box with factory-lubed switches."}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"aweme_id","in":"query","required":false,"description":"The numeric video ID.","schema":{"type":"string"},"example":"7705852133855161377"},{"name":"url","in":"query","required":false,"description":"A share link instead of an aweme_id: tiktok.com, vm.tiktok.com or vt.tiktok.com.","schema":{"type":"string"}},{"name":"lang","in":"query","required":false,"description":"Preferred caption language.","schema":{"type":"string"},"example":"en"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/video/no-watermark":{"get":{"operationId":"noWatermark","summary":"No-watermark media","description":"Source 1080p60 ByteVC1 or H.264 master URLs.\n\nUpstream: /aweme/v1/aweme/detail/.\n\nCost: 2 credits (primitive tier). Failed calls are not charged.","tags":["Videos & comments"],"x-credits":2,"x-tier":"primitive","x-upstream-paths":["/aweme/v1/aweme/detail/"],"x-access":"public","x-legacy-aliases":["/v1/tools/no-watermark"],"x-docs":"https://tikultra.com/docs/api/no-watermark","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"aweme_id":"7705852133855161377","desc":"Launch film, 1080p60 master #keyboards #desksetup","codec":"bytevc1","width":1080,"height":1920,"fps":60,"duration_ms":31840,"size_bytes":15291558,"hd_play_url":"https://v16-webapp-prime.tiktok.com/video/tos/useast2a/tos-useast2a-pve-0068/oQ8kLmN2xR9pV/?a=1233","h264_play_url":"https://v16-webapp-prime.tiktok.com/video/tos/useast2a/tos-useast2a-ve-0068c001/oM2xR9pVh264/?a=1233","music_play_url":"https://sf16-ies-music-va.tiktokcdn.com/obj/musically-maliva-obj/7569924403851462401.mp3","cover_url":"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/o8kLmN2xR9pV~tplv-tiktokx-origin.image"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"aweme_id","in":"query","required":false,"description":"The numeric video ID.","schema":{"type":"string"},"example":"7705852133855161377"},{"name":"url","in":"query","required":false,"description":"A share link instead of an aweme_id: tiktok.com, vm.tiktok.com or vt.tiktok.com.","schema":{"type":"string"}},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/video/slideshow":{"get":{"operationId":"slideshowDownloader","summary":"Slideshow media","description":"Every source image and the audio of a carousel.\n\nUpstream: /aweme/v1/aweme/detail/.\n\nCost: 2 credits (primitive tier). Failed calls are not charged.","tags":["Videos & comments"],"x-credits":2,"x-tier":"primitive","x-upstream-paths":["/aweme/v1/aweme/detail/"],"x-access":"public","x-legacy-aliases":["/v1/tools/slideshow-downloader"],"x-docs":"https://tikultra.com/docs/api/slideshow-downloader","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"aweme_id":"7705852133855161377","is_photo_mode":true,"title":"Studio desk build","image_count":3,"images":[{"index":0,"width":1440,"height":1920,"url":"https://p16-sign-va.tiktokcdn.com/tos-maliva-i-photomode-us/slide_0.webp"},{"index":1,"width":1440,"height":1920,"url":"https://p16-sign-va.tiktokcdn.com/tos-maliva-i-photomode-us/slide_1.webp"},{"index":2,"width":1440,"height":1920,"url":"https://p16-sign-va.tiktokcdn.com/tos-maliva-i-photomode-us/slide_2.webp"}],"music":{"id":"7569924403851462401","title":"original sound - acme","play_url":"https://sf16-ies-music-va.tiktokcdn.com/obj/musically-maliva-obj/7569924403851462401.mp3"}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"aweme_id","in":"query","required":false,"description":"The numeric video ID.","schema":{"type":"string"},"example":"7705852133855161377"},{"name":"url","in":"query","required":false,"description":"A share link instead of an aweme_id: tiktok.com, vm.tiktok.com or vt.tiktok.com.","schema":{"type":"string"}},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/video/duets":{"get":{"operationId":"duets","summary":"Duets and stitches","description":"Duets and stitches made from a video.\n\nUpstream: /tiktok/v1/duet/detail/.\n\nCost: 5 credits (standard tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Videos & comments"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/tiktok/v1/duet/detail/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/video/duets"],"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/duets","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":"20","has_more":true,"items":[{"aweme_id":"7705895000111222333","relation":"stitch","desc":"#stitch with @acme testing this on my mic","author":{"unique_id":"audiophile_us"},"stats":{"play_count":84210,"digg_count":7310}}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"aweme_id","in":"query","required":true,"description":"The numeric video ID.","schema":{"type":"string"},"example":"7705852133855161377"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/video/anchors":{"get":{"operationId":"videoAnchors","summary":"Video anchors","description":"Shop, CapCut, place or effect anchors on a video.\n\nUpstream: /aweme/v1/anchor/aweme/.\n\nCost: 5 credits (standard tier). Failed calls are not charged.","tags":["Videos & comments"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/aweme/v1/anchor/aweme/"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/video-anchors","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"aweme_id":"7705852133855161377","anchors":[{"type":"shop_product","id":"1729384756192837461","title":"Low-profile mechanical keyboard","url":"https://shop.tiktok.com/view/product/1729384756192837461"},{"type":"poi","id":"22535865203049849","title":"Wynwood, Miami, FL"}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"aweme_id","in":"query","required":true,"description":"The numeric video ID.","schema":{"type":"string"},"example":"7705852133855161377"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/video/upvotes":{"get":{"operationId":"upvotes","summary":"Repost annotations","description":"Public repost annotations on a post.\n\nUpstream: /tiktok/v1/upvote/batch_list/.\n\nCost: 5 credits (standard tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Videos & comments"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/tiktok/v1/upvote/batch_list/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/video/upvotes"],"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/upvotes","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":"20","has_more":true,"items":[{"user":{"uid":"6970000000000000002","unique_id":"kbfan","nickname":"KB Fan"},"text":"Best stock sound under $100","create_time":1762624200}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"aweme_id","in":"query","required":true,"description":"The numeric video ID.","schema":{"type":"string"},"example":"7705852133855161377"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/video/share-info":{"get":{"operationId":"shareInfo","summary":"Share info","description":"The short share link and share metadata of a video.\n\nUpstream: /tiktok/share/link/shorten/v1/.\n\nCost: 5 credits (standard tier). Failed calls are not charged.","tags":["Videos & comments"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/tiktok/share/link/shorten/v1/"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/share-info","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"aweme_id":"7705852133855161377","short_url":"https://vm.tiktok.com/ZMh7Kx2Qp/","canonical_url":"https://www.tiktok.com/@acme/video/7705852133855161377","share_title":"Acme Studio on TikTok","share_desc":"Launch film, 1080p60 master #keyboards #desksetup"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"aweme_id","in":"query","required":true,"description":"The numeric video ID.","schema":{"type":"string"},"example":"7705852133855161377"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/video/gifts":{"get":{"operationId":"videoGifts","summary":"Video gifts","description":"Gifts sent on a video.\n\nUpstream: /tiktok/v1/gift/list/.\n\nCost: 5 credits (standard tier). Failed calls are not charged.","tags":["Videos & comments"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/tiktok/v1/gift/list/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/video/gifts"],"x-docs":"https://tikultra.com/docs/api/video-gifts","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"aweme_id":"7705852133855161377","total_gifts":42,"total_diamonds":185,"gifts":[{"gift_id":5655,"name":"Rose","diamond_count":1,"send_count":35},{"gift_id":5879,"name":"Doughnut","diamond_count":30,"send_count":5}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"aweme_id","in":"query","required":true,"description":"The numeric video ID.","schema":{"type":"string"},"example":"7705852133855161377"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/video/forensics":{"get":{"operationId":"videoForensics","summary":"Video forensics","description":"Encoding, upload client and AI-generated content metadata.\n\nUpstream: /aweme/v1/aweme/detail/, /tiktok/inspect/item/v1.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["Videos & comments"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/aweme/v1/aweme/detail/","/tiktok/inspect/item/v1"],"x-access":"public","x-legacy-aliases":["/v1/tools/video-forensics"],"x-docs":"https://tikultra.com/docs/api/video-forensics","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"aweme_id":"7705852133855161377","snowflake_minted_utc":"2026-11-08T17:21:52Z","upload_source":"mobile_camera_import","aigc_info":{"aigc_label_type":0,"created_by_ai":false},"quality_ladder":[{"gear_name":"adapt_lowest_1080_1","codec":"bytevc1","width":1080,"height":1920,"fps":60,"bitrate_bps":3842100},{"gear_name":"normal_720_0","codec":"h264","width":720,"height":1280,"fps":30,"bitrate_bps":1620400}],"moderation_flags":{"is_ads":false,"prevent_download":false,"distribute_type":2}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"aweme_id","in":"query","required":false,"description":"The numeric video ID.","schema":{"type":"string"},"example":"7705852133855161377"},{"name":"url","in":"query","required":false,"description":"A share link instead of an aweme_id: tiktok.com, vm.tiktok.com or vt.tiktok.com.","schema":{"type":"string"}},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/video/fyp-velocity":{"get":{"operationId":"fypVelocity","summary":"FYP velocity","description":"Play, like and share velocity of a post.\n\nUpstream: /aweme/v1/aweme/detail/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["Videos & comments"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/aweme/v1/aweme/detail/"],"x-access":"public","x-legacy-aliases":["/v1/tools/fyp-velocity"],"x-docs":"https://tikultra.com/docs/api/fyp-velocity","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"aweme_id":"7705852133855161377","age_hours":18.4,"views_per_hour":80592,"likes_per_hour":5241,"shares_per_hour":265,"engagement_rate_pct":6.94,"share_to_view_pct":0.33,"viral_tier":"tier_4_breakout","outlier_multiplier":4.8}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"aweme_id","in":"query","required":false,"description":"The numeric video ID.","schema":{"type":"string"},"example":"7705852133855161377"},{"name":"url","in":"query","required":false,"description":"A share link instead of an aweme_id: tiktok.com, vm.tiktok.com or vt.tiktok.com.","schema":{"type":"string"}},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/video/comment-leads":{"get":{"operationId":"commentLeads","summary":"Comment leads","description":"Questions and purchase-intent comments, structured.\n\nUpstream: /aweme/v2/comment/list/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["Videos & comments"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/aweme/v2/comment/list/"],"x-access":"public","x-legacy-aliases":["/v1/tools/comment-leads"],"x-docs":"https://tikultra.com/docs/api/comment-leads","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"aweme_id":"7705852133855161377","scanned_comments":100,"blue_search_keywords":["low profile mechanical keyboard","acme 75 keyboard"],"leads":[{"cid":"7705860011122233344","intent":"purchase_question","score":0.96,"text":"Where is this keyboard from?","user":{"unique_id":"kbfan"},"digg_count":412},{"cid":"7705860011122233349","intent":"price_inquiry","score":0.91,"text":"Do you ship to UK and how much is the tactile version?","user":{"unique_id":"uk_dev"},"digg_count":54}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"aweme_id","in":"query","required":false,"description":"The numeric video ID.","schema":{"type":"string"},"example":"7705852133855161377"},{"name":"url","in":"query","required":false,"description":"A share link instead of an aweme_id: tiktok.com, vm.tiktok.com or vt.tiktok.com.","schema":{"type":"string"}},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/user":{"get":{"operationId":"getProfile","summary":"Get profile","description":"Profile details, counts, bio and links.\n\nUpstream: /aweme/v1/user/profile/other/, /tiktok/user/profile/other/v1.\n\nCost: 5 credits (standard tier). Failed calls are not charged.","tags":["Users & profiles"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/aweme/v1/user/profile/other/","/tiktok/user/profile/other/v1"],"x-access":"public","x-legacy-aliases":["/v1/scrape/user"],"x-docs":"https://tikultra.com/docs/api/get-profile","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"uid":"6970000000000000001","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","unique_id":"acme","nickname":"Acme Studio","signature":"Custom mechanical keyboards & acoustics · Miami","bio_url":"https://acme.example.com","region":"US","verified":false,"private_account":false,"avatar_larger":"https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/acme_1080x1080.webp","stats":{"follower_count":128431,"following_count":342,"heart_count":4829104,"video_count":186,"digg_count":1920},"commerce_user_info":{"has_showcase":true,"shop_seller_id":"7495000000000000001"}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"username","in":"query","required":false,"description":"The @username, without the @.","schema":{"type":"string"},"example":"acme"},{"name":"sec_uid","in":"query","required":false,"description":"The stable account ID used by the mobile API.","schema":{"type":"string"}},{"name":"uid","in":"query","required":false,"description":"The numeric user ID.","schema":{"type":"string"}},{"name":"url","in":"query","required":false,"description":"A profile link, such as tiktok.com/@acme.","schema":{"type":"string"}},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/user/posts":{"get":{"operationId":"profilePosts","summary":"Profile posts","description":"A page of a profile's posts.\n\nUpstream: /aweme/v1/aweme/post/.\n\nCost: 5 credits (standard tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Users & profiles"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/aweme/v1/aweme/post/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/user/posts"],"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/profile-posts","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":"1762622512000","has_more":true,"items":[{"aweme_id":"7705852133855161377","desc":"Launch film, 1080p60 master #keyboards #desksetup","create_time":1762622512,"region":"US","author":{"uid":"6970000000000000001","unique_id":"acme","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","nickname":"Acme Studio","follower_count":128431,"verified":false},"stats":{"play_count":1482906,"digg_count":96442,"comment_count":1318,"share_count":4877,"collect_count":2210,"repost_count":614},"music":{"id":"7569924403851462401","title":"original sound - acme","author":"Acme Studio","duration_sec":31},"video":{"codec":"bytevc1","width":1080,"height":1920,"fps":60,"duration_ms":31840,"bitrate_bps":3842100,"play_url":"https://v16-webapp-prime.tiktok.com/video/tos/useast2a/tos-useast2a-pve-0068/oQ8kLmN2xR9pV/?a=1233","cover_url":"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/o8kLmN2xR9pV~tplv-tiktokx-origin.image"}}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"username","in":"query","required":false,"description":"The @username, without the @.","schema":{"type":"string"},"example":"acme"},{"name":"sec_uid","in":"query","required":false,"description":"The stable account ID used by the mobile API.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"name":"sort","in":"query","required":false,"description":"latest or popular.","schema":{"type":"string","enum":["latest","popular"]},"example":"latest"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/user/with-posts":{"get":{"operationId":"profileWithPosts","summary":"Profile with posts","description":"A profile and its first page of posts in one call.\n\nUpstream: /aweme/v1/user/profile/other/, /aweme/v1/aweme/post/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["Users & profiles"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/aweme/v1/user/profile/other/","/aweme/v1/aweme/post/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/user/with-posts"],"x-docs":"https://tikultra.com/docs/api/profile-with-posts","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"user":{"uid":"6970000000000000001","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","unique_id":"acme","nickname":"Acme Studio","signature":"Custom mechanical keyboards & acoustics · Miami","bio_url":"https://acme.example.com","region":"US","verified":false,"private_account":false,"avatar_larger":"https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/acme_1080x1080.webp","stats":{"follower_count":128431,"following_count":342,"heart_count":4829104,"video_count":186,"digg_count":1920},"commerce_user_info":{"has_showcase":true,"shop_seller_id":"7495000000000000001"}},"posts":{"cursor":"1762622512000","has_more":true,"items":[{"aweme_id":"7705852133855161377","desc":"Launch film, 1080p60 master #keyboards #desksetup","create_time":1762622512,"region":"US","author":{"uid":"6970000000000000001","unique_id":"acme","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","nickname":"Acme Studio","follower_count":128431,"verified":false},"stats":{"play_count":1482906,"digg_count":96442,"comment_count":1318,"share_count":4877,"collect_count":2210,"repost_count":614},"music":{"id":"7569924403851462401","title":"original sound - acme","author":"Acme Studio","duration_sec":31},"video":{"codec":"bytevc1","width":1080,"height":1920,"fps":60,"duration_ms":31840,"bitrate_bps":3842100,"play_url":"https://v16-webapp-prime.tiktok.com/video/tos/useast2a/tos-useast2a-pve-0068/oQ8kLmN2xR9pV/?a=1233","cover_url":"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/o8kLmN2xR9pV~tplv-tiktokx-origin.image"}}]}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"username","in":"query","required":false,"description":"The @username, without the @.","schema":{"type":"string"},"example":"acme"},{"name":"sec_uid","in":"query","required":false,"description":"The stable account ID used by the mobile API.","schema":{"type":"string"}},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/user/stories":{"get":{"operationId":"stories","summary":"Stories","description":"A user's active 24-hour stories.\n\nUpstream: /tiktok/story/archive/detail/v1, /tiktok/story/archive/list/v1.\n\nCost: 5 credits (standard tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Users & profiles"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/tiktok/story/archive/detail/v1","/tiktok/story/archive/list/v1"],"x-access":"public","x-legacy-aliases":["/v1/scrape/user/stories"],"x-exclusive":true,"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/stories","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":null,"has_more":false,"items":[{"story_id":"7705870000111222333","create_time":1762870000,"expires_at":1762956400,"media":"video","view_count":18204}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"username","in":"query","required":false,"description":"The @username, without the @.","schema":{"type":"string"},"example":"acme"},{"name":"sec_uid","in":"query","required":false,"description":"The stable account ID used by the mobile API.","schema":{"type":"string"}},{"name":"uid","in":"query","required":false,"description":"The numeric user ID.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/user/stories/batch":{"post":{"operationId":"storiesBatch","summary":"Batch stories","description":"Active stories for up to 20 users at once.\n\nUpstream: /tiktok/story/archive/detail/v1.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["Users & profiles"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/tiktok/story/archive/detail/v1"],"x-access":"public","x-legacy-aliases":["/v1/scrape/user/stories/batch"],"x-docs":"https://tikultra.com/docs/api/stories-batch","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"count":2,"users":[{"username":"acme","has_active_stories":true,"stories":[{"story_id":"7705870000111222333","expires_at":1762956400}]},{"username":"kbfan","has_active_stories":false,"stories":[]}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"usernames":{"type":"array","items":{"type":"string"},"description":"Up to 20 usernames."}},"required":["usernames"]},"example":{"usernames":["acme","kbfan"]}}}}}},"/v1/user/reposts":{"get":{"operationId":"reposts","summary":"Reposts","description":"The public repost feed of a profile.\n\nUpstream: /tiktok/v1/upvote/item/list/.\n\nCost: 5 credits (standard tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Users & profiles"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/tiktok/v1/upvote/item/list/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/user/reposts"],"x-exclusive":true,"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/reposts","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":"20","has_more":true,"items":[{"aweme_id":"7705852133855161377","reposted_at":1762626012,"repost_note":"Cleanest build this year","video":{"aweme_id":"7705852133855161377","desc":"Launch film, 1080p60 master #keyboards #desksetup","create_time":1762622512,"region":"US","author":{"uid":"6970000000000000001","unique_id":"acme","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","nickname":"Acme Studio","follower_count":128431,"verified":false},"stats":{"play_count":1482906,"digg_count":96442,"comment_count":1318,"share_count":4877,"collect_count":2210,"repost_count":614},"music":{"id":"7569924403851462401","title":"original sound - acme","author":"Acme Studio","duration_sec":31},"video":{"codec":"bytevc1","width":1080,"height":1920,"fps":60,"duration_ms":31840,"bitrate_bps":3842100,"play_url":"https://v16-webapp-prime.tiktok.com/video/tos/useast2a/tos-useast2a-pve-0068/oQ8kLmN2xR9pV/?a=1233","cover_url":"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/o8kLmN2xR9pV~tplv-tiktokx-origin.image"}}}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"username","in":"query","required":false,"description":"The @username, without the @.","schema":{"type":"string"},"example":"acme"},{"name":"sec_uid","in":"query","required":false,"description":"The stable account ID used by the mobile API.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/user/favorites":{"get":{"operationId":"favorites","summary":"Favorites","description":"Videos a profile has publicly favorited.\n\nUpstream: /aweme/v1/aweme/favorite/.\n\nCost: 5 credits (standard tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Users & profiles"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/aweme/v1/aweme/favorite/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/user/favorites"],"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/favorites","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":"20","has_more":true,"items":[{"aweme_id":"7705852133855161377","desc":"Launch film, 1080p60 master #keyboards #desksetup","create_time":1762622512,"region":"US","author":{"uid":"6970000000000000001","unique_id":"acme","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","nickname":"Acme Studio","follower_count":128431,"verified":false},"stats":{"play_count":1482906,"digg_count":96442,"comment_count":1318,"share_count":4877,"collect_count":2210,"repost_count":614},"music":{"id":"7569924403851462401","title":"original sound - acme","author":"Acme Studio","duration_sec":31},"video":{"codec":"bytevc1","width":1080,"height":1920,"fps":60,"duration_ms":31840,"bitrate_bps":3842100,"play_url":"https://v16-webapp-prime.tiktok.com/video/tos/useast2a/tos-useast2a-pve-0068/oQ8kLmN2xR9pV/?a=1233","cover_url":"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/o8kLmN2xR9pV~tplv-tiktokx-origin.image"}}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"username","in":"query","required":false,"description":"The @username, without the @.","schema":{"type":"string"},"example":"acme"},{"name":"sec_uid","in":"query","required":false,"description":"The stable account ID used by the mobile API.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/user/playlists":{"get":{"operationId":"playlists","summary":"Playlists","description":"A creator's playlists.\n\nUpstream: /tiktok/v1/mix/list/.\n\nCost: 5 credits (standard tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Users & profiles"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/tiktok/v1/mix/list/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/user/playlists"],"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/playlists","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":null,"has_more":false,"items":[{"mix_id":"7705891000000000001","name":"Keyboard Sound Tests","video_count":24,"play_count":6920410}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"username","in":"query","required":false,"description":"The @username, without the @.","schema":{"type":"string"},"example":"acme"},{"name":"sec_uid","in":"query","required":false,"description":"The stable account ID used by the mobile API.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/user/followers":{"get":{"operationId":"followers","summary":"Followers","description":"A page of followers.\n\nUpstream: /aweme/v1/user/follower/list/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Users & profiles"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/aweme/v1/user/follower/list/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/user/followers"],"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/followers","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":"1762880100","has_more":true,"items":[{"uid":"6970000000000000002","sec_uid":"MS4wLjABAAAAkbfan991","unique_id":"kbfan","nickname":"KB Fan","follower_count":1420,"verified":false}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"username","in":"query","required":false,"description":"The @username, without the @.","schema":{"type":"string"},"example":"acme"},{"name":"sec_uid","in":"query","required":false,"description":"The stable account ID used by the mobile API.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/user/followings":{"get":{"operationId":"followings","summary":"Followings","description":"A page of accounts a profile follows.\n\nUpstream: /aweme/v1/user/following/list/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Users & profiles"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/aweme/v1/user/following/list/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/user/followings"],"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/followings","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":"20","has_more":true,"items":[{"uid":"6970000000000000010","sec_uid":"MS4wLjABAAAAswitchlab","unique_id":"switchlab","nickname":"Switch Lab","follower_count":89410,"verified":true}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"username","in":"query","required":false,"description":"The @username, without the @.","schema":{"type":"string"},"example":"acme"},{"name":"sec_uid","in":"query","required":false,"description":"The stable account ID used by the mobile API.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/user/followers/search":{"get":{"operationId":"followersSearch","summary":"Search followers","description":"Search within a profile's followers.\n\nUpstream: /aweme/v1/user/follower/list/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["Users & profiles"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/aweme/v1/user/follower/list/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/user/followers/search"],"x-docs":"https://tikultra.com/docs/api/followers-search","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"keyword":"studio","items":[{"uid":"6970000000000000014","unique_id":"nordic.studio","nickname":"Nordic Studio","follower_count":9320}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"username","in":"query","required":false,"description":"The @username, without the @.","schema":{"type":"string"},"example":"acme"},{"name":"sec_uid","in":"query","required":false,"description":"The stable account ID used by the mobile API.","schema":{"type":"string"}},{"name":"keyword","in":"query","required":true,"description":"What to search for.","schema":{"type":"string"},"example":"studio"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/user/followings/search":{"get":{"operationId":"followingsSearch","summary":"Search followings","description":"Search within the accounts a profile follows.\n\nUpstream: /aweme/v1/user/following/list/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["Users & profiles"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/aweme/v1/user/following/list/"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/followings-search","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"keyword":"studio","items":[{"uid":"6970000000000000015","unique_id":"keycap.studio","nickname":"Keycap Studio","follower_count":42100}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"username","in":"query","required":false,"description":"The @username, without the @.","schema":{"type":"string"},"example":"acme"},{"name":"sec_uid","in":"query","required":false,"description":"The stable account ID used by the mobile API.","schema":{"type":"string"}},{"name":"keyword","in":"query","required":true,"description":"What to search for.","schema":{"type":"string"},"example":"studio"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/user/similar":{"get":{"operationId":"similarUsers","summary":"Similar creators","description":"Creators similar to a profile.\n\nUpstream: /aweme/v1/following/page/user/recommend/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["Users & profiles"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/aweme/v1/following/page/user/recommend/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/user/similar"],"x-docs":"https://tikultra.com/docs/api/similar-users","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"items":[{"uid":"6970000000000000010","unique_id":"switchlab","nickname":"Switch Lab","follower_count":89410,"recommend_reason":"Similar audience in Tech & Gear"}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"username","in":"query","required":false,"description":"The @username, without the @.","schema":{"type":"string"},"example":"acme"},{"name":"sec_uid","in":"query","required":false,"description":"The stable account ID used by the mobile API.","schema":{"type":"string"}},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/user/collections":{"get":{"operationId":"collections","summary":"Collections","description":"A profile's public collections.\n\nUpstream: /tiktok/collection/item_archive/list/v1.\n\nCost: 5 credits (standard tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Users & profiles"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/tiktok/collection/item_archive/list/v1"],"x-access":"public","x-legacy-aliases":["/v1/scrape/user/collections"],"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/collections","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":null,"has_more":false,"items":[{"collection_id":"7705880000000000001","title":"Desk Inspiration","total_videos":18}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"username","in":"query","required":false,"description":"The @username, without the @.","schema":{"type":"string"},"example":"acme"},{"name":"sec_uid","in":"query","required":false,"description":"The stable account ID used by the mobile API.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/user/collections/videos":{"get":{"operationId":"collectionVideos","summary":"Collection videos","description":"The videos in one collection.\n\nUpstream: /tiktok/collection/item_archive/item/list/v1.\n\nCost: 5 credits (standard tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Users & profiles"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/tiktok/collection/item_archive/item/list/v1"],"x-access":"public","x-legacy-aliases":["/v1/scrape/user/collection"],"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/collection-videos","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":null,"has_more":false,"items":[{"aweme_id":"7705852133855161377","desc":"Launch film, 1080p60 master #keyboards #desksetup","create_time":1762622512,"region":"US","author":{"uid":"6970000000000000001","unique_id":"acme","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","nickname":"Acme Studio","follower_count":128431,"verified":false},"stats":{"play_count":1482906,"digg_count":96442,"comment_count":1318,"share_count":4877,"collect_count":2210,"repost_count":614},"music":{"id":"7569924403851462401","title":"original sound - acme","author":"Acme Studio","duration_sec":31},"video":{"codec":"bytevc1","width":1080,"height":1920,"fps":60,"duration_ms":31840,"bitrate_bps":3842100,"play_url":"https://v16-webapp-prime.tiktok.com/video/tos/useast2a/tos-useast2a-pve-0068/oQ8kLmN2xR9pV/?a=1233","cover_url":"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/o8kLmN2xR9pV~tplv-tiktokx-origin.image"}}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"collection_id","in":"query","required":true,"description":"The collection ID.","schema":{"type":"string"},"example":"7705880000000000001"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/user/locate-post":{"get":{"operationId":"locatePost","summary":"Locate post","description":"Find where a post sits in a profile's timeline.\n\nUpstream: /aweme/v1/post/locate/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["Users & profiles"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/aweme/v1/post/locate/"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/locate-post","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"username":"acme","target_aweme_id":"7705852133855161377","found":true,"index_in_window":0,"cursor":"1762622512000","items":[{"aweme_id":"7705852133855161377","desc":"Launch film, 1080p60 master #keyboards #desksetup","create_time":1762622512,"region":"US","author":{"uid":"6970000000000000001","unique_id":"acme","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","nickname":"Acme Studio","follower_count":128431,"verified":false},"stats":{"play_count":1482906,"digg_count":96442,"comment_count":1318,"share_count":4877,"collect_count":2210,"repost_count":614},"music":{"id":"7569924403851462401","title":"original sound - acme","author":"Acme Studio","duration_sec":31},"video":{"codec":"bytevc1","width":1080,"height":1920,"fps":60,"duration_ms":31840,"bitrate_bps":3842100,"play_url":"https://v16-webapp-prime.tiktok.com/video/tos/useast2a/tos-useast2a-pve-0068/oQ8kLmN2xR9pV/?a=1233","cover_url":"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/o8kLmN2xR9pV~tplv-tiktokx-origin.image"}}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"username","in":"query","required":false,"description":"The @username, without the @.","schema":{"type":"string"},"example":"acme"},{"name":"sec_uid","in":"query","required":false,"description":"The stable account ID used by the mobile API.","schema":{"type":"string"}},{"name":"aweme_id","in":"query","required":true,"description":"The post to find.","schema":{"type":"string"},"example":"7705852133855161377"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/user/series":{"get":{"operationId":"userSeries","summary":"Creator series","description":"A creator's paid series.\n\nUpstream: /tiktok/v1/paid_content/collection/list/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["Users & profiles"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/tiktok/v1/paid_content/collection/list/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/user/series"],"x-docs":"https://tikultra.com/docs/api/user-series","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"username":"acme","items":[{"series_id":"7705890000000000001","title":"Custom Keyboard Engineering A-Z","episode_count":12,"price_usd":"9.99","sold_count":842}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"username","in":"query","required":false,"description":"The @username, without the @.","schema":{"type":"string"},"example":"acme"},{"name":"sec_uid","in":"query","required":false,"description":"The stable account ID used by the mobile API.","schema":{"type":"string"}},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/user/audit":{"get":{"operationId":"accountAudit","summary":"Creator audit","description":"Engagement, cadence and reach diagnostics for a creator.\n\nUpstream: /aweme/v1/user/profile/other/, /aweme/v1/aweme/post/.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["Users & profiles"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/aweme/v1/user/profile/other/","/aweme/v1/aweme/post/"],"x-access":"public","x-legacy-aliases":["/v1/tools/account-audit"],"x-docs":"https://tikultra.com/docs/api/account-audit","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"user":{"uid":"6970000000000000001","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","unique_id":"acme","nickname":"Acme Studio","signature":"Custom mechanical keyboards & acoustics · Miami","bio_url":"https://acme.example.com","region":"US","verified":false,"private_account":false,"avatar_larger":"https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/acme_1080x1080.webp","stats":{"follower_count":128431,"following_count":342,"heart_count":4829104,"video_count":186,"digg_count":1920},"commerce_user_info":{"has_showcase":true,"shop_seller_id":"7495000000000000001"}},"sample_size":20,"median_views":184200,"mean_views":312900,"engagement_rate_pct":7.12,"posting_cadence_per_week":4.2,"top_outlier":{"aweme_id":"7705852133855161377","play_count":1482906,"multiplier_vs_median":8.05},"health_grade":"A"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"username","in":"query","required":false,"description":"The @username, without the @.","schema":{"type":"string"},"example":"acme"},{"name":"sec_uid","in":"query","required":false,"description":"The stable account ID used by the mobile API.","schema":{"type":"string"}},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/user/visibility":{"get":{"operationId":"visibility","summary":"Visibility check","description":"Search indexability and feed distribution diagnostics.\n\nUpstream: /aweme/v1/general/search/single/, /aweme/v1/aweme/post/.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["Users & profiles"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/aweme/v1/general/search/single/","/aweme/v1/aweme/post/"],"x-access":"public","x-legacy-aliases":["/v1/tools/shadowban-test"],"x-docs":"https://tikultra.com/docs/api/visibility","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"username":"acme","uid":"6970000000000000001","searchable_by_handle":true,"indexed_recent_posts":10,"fyp_distribution_active":true,"restricted_posts_count":0,"verdict":"healthy"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"username","in":"query","required":false,"description":"The @username, without the @.","schema":{"type":"string"},"example":"acme"},{"name":"sec_uid","in":"query","required":false,"description":"The stable account ID used by the mobile API.","schema":{"type":"string"}},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/user/compare":{"get":{"operationId":"compareUsers","summary":"Compare creators","description":"Benchmark several creators side by side.\n\nUpstream: /aweme/v1/user/profile/other/.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["Users & profiles"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/aweme/v1/user/profile/other/"],"x-access":"public","x-legacy-aliases":["/v1/tools/compare-users"],"x-docs":"https://tikultra.com/docs/api/compare-users","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"creators":[{"username":"acme","follower_count":128431,"median_views":184200,"engagement_rate_pct":7.12,"cadence_per_week":4.2},{"username":"kbfan","follower_count":1420,"median_views":3900,"engagement_rate_pct":5.4,"cadence_per_week":1.5}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"usernames","in":"query","required":true,"description":"Comma-separated usernames, up to 5.","schema":{"type":"string"},"example":"acme,kbfan"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/user/check-username":{"get":{"operationId":"checkUsername","summary":"Check username","description":"Whether a username is available, taken or reserved.\n\nUpstream: /aweme/v1/unique/id/check/.\n\nCost: 2 credits (primitive tier). Failed calls are not charged.","tags":["Users & profiles"],"x-credits":2,"x-tier":"primitive","x-upstream-paths":["/aweme/v1/unique/id/check/"],"x-access":"public","x-legacy-aliases":["/v1/tools/check-username"],"x-docs":"https://tikultra.com/docs/api/check-username","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"unique_id":"acme_labs","available":true,"status":"available","suggestions":["acme_labs_hq","acmelabs"]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"unique_id","in":"query","required":true,"description":"The handle to check, without the @.","schema":{"type":"string"},"example":"acme_labs"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/user/bulk-check":{"post":{"operationId":"bulkCheck","summary":"Bulk profile check","description":"Whether each of up to 100 usernames exists and is public.\n\nUpstream: /aweme/v1/user/profile/other/.\n\nCost: 5 credits (standard tier) per item. Failed calls are not charged.","tags":["Users & profiles"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/aweme/v1/user/profile/other/"],"x-access":"public","x-legacy-aliases":["/v1/tools/bulk-check-accounts"],"x-docs":"https://tikultra.com/docs/api/bulk-check","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"count":3,"results":[{"username":"acme","exists":true,"public":true,"uid":"6970000000000000001","follower_count":128431},{"username":"kbfan","exists":true,"public":true,"uid":"6970000000000000002","follower_count":1420},{"username":"acme_labs","exists":false,"public":false,"uid":null,"follower_count":0}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"usernames":{"type":"array","items":{"type":"string"},"description":"Up to 100 usernames."}},"required":["usernames"]},"example":{"usernames":["acme","kbfan","acme_labs"]}}}}}},"/v1/feed/persona-fyp":{"get":{"operationId":"personaFyp","summary":"Persona For You feed","description":"What the For You feed shows in one of 84 supported cities for a given niche, from a device context pinned to that city and calibrated to that topic.\n\nUpstream: /aweme/v1/feed/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Feeds, search & Tako AI"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/aweme/v1/feed/"],"x-access":"public","x-exclusive":true,"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/persona-fyp","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"region":"US","city":"miami","niche":"fitness","cursor":"2","has_more":true,"items":[{"aweme_id":"7705852133855161377","desc":"Morning run Brickell Key 5K pace #miami #fitness","author":{"unique_id":"miamirunclub"},"stats":{"play_count":612900,"digg_count":48210},"position":1}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"region","in":"query","required":true,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"name":"city","in":"query","required":false,"description":"A city in that region. See the supported cities list.","schema":{"type":"string"},"example":"miami"},{"name":"niche","in":"query","required":true,"description":"The topic the context is calibrated to.","schema":{"type":"string"},"example":"fitness"},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"10"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/feed/persona-fyp/cities":{"get":{"operationId":"personaCities","summary":"Supported persona cities","description":"All 84 supported city slugs grouped by country code.\n\nUpstream: gateway · regional city catalog.\n\nCost: Free. Failed calls are not charged.","tags":["Feeds, search & Tako AI"],"x-credits":0,"x-tier":null,"x-upstream-paths":["gateway · regional city catalog"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/persona-cities","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"total_regions":11,"total_cities":86,"regions":{"US":["miami","chicago","houston","dallas","phoenix","austin","seattle","boston","atlanta"],"GB":["london","manchester","birmingham","glasgow","edinburgh"],"DE":["berlin","munich","hamburg","cologne"],"JP":["tokyo","osaka","yokohama","nagoya"]}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/feed":{"get":{"operationId":"forYouFeed","summary":"Feeds","description":"For You, Following, STEM, Explore and Nearby feeds.\n\nUpstream: /aweme/v1/feed/, /aweme/v2/follow/feed/, /tiktok/feed/stem/v2, /tiktok/feed/explore/v1, /tiktok/feed/nearby/revamp.\n\nCost: 5 credits (standard tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Feeds, search & Tako AI"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/aweme/v1/feed/","/aweme/v2/follow/feed/","/tiktok/feed/stem/v2","/tiktok/feed/explore/v1","/tiktok/feed/nearby/revamp"],"x-access":"public","x-legacy-aliases":["/v1/scrape/feed"],"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/for-you-feed","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":"1","has_more":true,"items":[{"aweme_id":"7705852133855161377","desc":"Launch film, 1080p60 master #keyboards #desksetup","create_time":1762622512,"region":"US","author":{"uid":"6970000000000000001","unique_id":"acme","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","nickname":"Acme Studio","follower_count":128431,"verified":false},"stats":{"play_count":1482906,"digg_count":96442,"comment_count":1318,"share_count":4877,"collect_count":2210,"repost_count":614},"music":{"id":"7569924403851462401","title":"original sound - acme","author":"Acme Studio","duration_sec":31},"video":{"codec":"bytevc1","width":1080,"height":1920,"fps":60,"duration_ms":31840,"bitrate_bps":3842100,"play_url":"https://v16-webapp-prime.tiktok.com/video/tos/useast2a/tos-useast2a-pve-0068/oQ8kLmN2xR9pV/?a=1233","cover_url":"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/o8kLmN2xR9pV~tplv-tiktokx-origin.image"}}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"type","in":"query","required":true,"description":"Which feed to read.","schema":{"type":"string","enum":["foryou","following","stem","explore","nearby"]},"example":"foryou"},{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"name":"city","in":"query","required":false,"description":"A city in that region. See the supported cities list.","schema":{"type":"string"},"example":"miami"},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"10"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/feed/stories":{"get":{"operationId":"feedStories","summary":"Stories feed","description":"The stories tray at the top of the feed.\n\nUpstream: /aweme/v2/follow/feed/skylight.\n\nCost: 5 credits (standard tier). Failed calls are not charged.","tags":["Feeds, search & Tako AI"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/aweme/v2/follow/feed/skylight"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/feed-stories","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"region":"US","items":[{"uid":"6970000000000000001","unique_id":"acme","unread_count":1,"latest_story_time":1762870000}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/feed/landscape":{"get":{"operationId":"feedLandscape","summary":"Landscape feed","description":"The horizontal, full-screen video feed.\n\nUpstream: /tiktok/feed/horizontal/v2.\n\nCost: 5 credits (standard tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Feeds, search & Tako AI"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/tiktok/feed/horizontal/v2"],"x-access":"public","x-paginated":true,"x-docs":"https://tikultra.com/docs/api/feed-landscape","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":"1","has_more":true,"items":[{"aweme_id":"7705852133855161377","desc":"Launch film, 1080p60 master #keyboards #desksetup","create_time":1762622512,"region":"US","author":{"uid":"6970000000000000001","unique_id":"acme","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","nickname":"Acme Studio","follower_count":128431,"verified":false},"stats":{"play_count":1482906,"digg_count":96442,"comment_count":1318,"share_count":4877,"collect_count":2210,"repost_count":614},"music":{"id":"7569924403851462401","title":"original sound - acme","author":"Acme Studio","duration_sec":31},"video":{"codec":"bytevc1","width":1920,"height":1080,"fps":60,"duration_ms":31840,"bitrate_bps":3842100,"play_url":"https://v16-webapp-prime.tiktok.com/video/tos/useast2a/tos-useast2a-pve-0068/oQ8kLmN2xR9pV/?a=1233","cover_url":"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/o8kLmN2xR9pV~tplv-tiktokx-origin.image"}}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"10"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/search":{"get":{"operationId":"search","summary":"Search","description":"Search videos, users, LIVE, hashtags, sounds and places.\n\nUpstream: /aweme/v1/general/search/single/, /aweme/v1/search/item/, /aweme/v1/discover/search/, /aweme/v1/live/search/, /aweme/v1/challenge/search/, /aweme/v1/music/search/, /aweme/v1/search/place/.\n\nCost: 5 credits (standard tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Feeds, search & Tako AI"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/aweme/v1/general/search/single/","/aweme/v1/search/item/","/aweme/v1/discover/search/","/aweme/v1/live/search/","/aweme/v1/challenge/search/","/aweme/v1/music/search/","/aweme/v1/search/place/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/search"],"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/search","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":"20","has_more":true,"items":[{"aweme_id":"7705852133855161377","desc":"Launch film, 1080p60 master #keyboards #desksetup","create_time":1762622512,"region":"US","author":{"uid":"6970000000000000001","unique_id":"acme","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","nickname":"Acme Studio","follower_count":128431,"verified":false},"stats":{"play_count":1482906,"digg_count":96442,"comment_count":1318,"share_count":4877,"collect_count":2210,"repost_count":614},"music":{"id":"7569924403851462401","title":"original sound - acme","author":"Acme Studio","duration_sec":31},"video":{"codec":"bytevc1","width":1080,"height":1920,"fps":60,"duration_ms":31840,"bitrate_bps":3842100,"play_url":"https://v16-webapp-prime.tiktok.com/video/tos/useast2a/tos-useast2a-pve-0068/oQ8kLmN2xR9pV/?a=1233","cover_url":"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/o8kLmN2xR9pV~tplv-tiktokx-origin.image"}}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"keyword","in":"query","required":true,"description":"What to search for.","schema":{"type":"string"},"example":"keyboards"},{"name":"type","in":"query","required":false,"description":"What to search.","schema":{"type":"string","enum":["general","videos","users","live","hashtags","music","places"]},"example":"videos"},{"name":"sort_type","in":"query","required":false,"description":"0 relevance, 1 most liked.","schema":{"type":"string"},"example":"0"},{"name":"publish_time","in":"query","required":false,"description":"0 any time, 1 day, 7 week, 30 month, 90 or 180.","schema":{"type":"string"},"example":"0"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/search/suggestions":{"get":{"operationId":"searchSuggestions","summary":"Search suggestions","description":"Suggestions for a partial keyword.\n\nUpstream: /aweme/v1/search/sug/.\n\nCost: 5 credits (standard tier). Failed calls are not charged.","tags":["Feeds, search & Tako AI"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/aweme/v1/search/sug/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/search/suggestions"],"x-docs":"https://tikultra.com/docs/api/search-suggestions","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"keyword":"keyb","suggestions":[{"text":"keyboard thocky","rich_type":"trending"},{"text":"keyboard low profile","rich_type":"ecom"},{"text":"keyboard asmrsounds","rich_type":"normal"}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"keyword","in":"query","required":true,"description":"What to search for.","schema":{"type":"string"},"example":"keyb"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/vision/ecom-search":{"post":{"operationId":"visionSearch","summary":"Vision search","description":"Reverse image search across Shop products and matching videos.\n\nUpstream: /aweme/v1/search/photo/bff/ecom/, /aweme/v1/search/vision/general/.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["Feeds, search & Tako AI"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/aweme/v1/search/photo/bff/ecom/","/aweme/v1/search/vision/general/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/search/vision","/v1/scrape/ecom/photo-search"],"x-exclusive":true,"x-docs":"https://tikultra.com/docs/api/vision-search","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"mode":"both","region":"US","products":[{"product_id":"1729384756192837461","title":"Low-profile mechanical keyboard 75%","price":{"amount":"79.99","currency":"USD"},"similarity":0.94,"seller_name":"Acme Studio Shop"}],"videos":[{"aweme_id":"7705852133855161377","desc":"Launch film, 1080p60 master #keyboards #desksetup","similarity":0.88}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"image_url":{"type":"string","description":"A public URL of the image."},"image_base64":{"type":"string","description":"The image as base64 instead of a URL."},"mode":{"type":"string","enum":["both","ecom","videos"],"description":"both, ecom or videos."},"region":{"type":"string","description":"Two-letter country code for egress and storefront."}},"required":[]},"example":{"image_url":"https://example.com/product.jpg","mode":"both","region":"US"}}}}}},"/v1/tako/ask":{"post":{"operationId":"takoAsk","summary":"Tako ask","description":"Ask TikTok's in-app Tako assistant a question, optionally about one video. Returns the answer, follow-up prompts and the video IDs it cited.\n\nUpstream: /aweme/v1/tako/op/stream/.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["Feeds, search & Tako AI"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/aweme/v1/tako/op/stream/"],"x-access":"public","x-exclusive":true,"x-docs":"https://tikultra.com/docs/api/tako-ask","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"query":"Best budget mechanical keyboards?","answer":"Creators consistently highlight 75% gasket-mounted boards with pre-lubed tactile or linear switches under $90 for office and gaming setups.","follow_ups":["Which switches are quietest for an office?","Low-profile vs standard height keyboards?"],"cited_video_ids":["7705852133855161377","7705852133855161378"]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"The question."},"aweme_id":{"type":"string","description":"Ask about this video."},"region":{"type":"string","description":"Two-letter country code for egress and storefront."}},"required":["query"]},"example":{"query":"Best budget mechanical keyboards?","region":"US"}}}}}},"/v1/tako/chat":{"post":{"operationId":"takoChat","summary":"Tako chat","description":"A multi-turn conversation with Tako.\n\nUpstream: /aweme/v1/tako/op/stream/.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["Feeds, search & Tako AI"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/aweme/v1/tako/op/stream/"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/tako-chat","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"conversation_id":"tako_conv_918273645","reply":"For quiet office typing, silent linear switches with a polycarbonate or POM plate keep acoustics below 45 dB.","follow_ups":["Show sound test videos","Best keycap profile for Mac?"],"cited_video_ids":["7705852133855161377"]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"string"},"description":"The conversation so far, oldest first."},"region":{"type":"string","description":"Two-letter country code for egress and storefront."}},"required":["messages"]},"example":{"messages":[{"role":"user","content":"Best budget mechanical keyboards?"}],"region":"US"}}}}}},"/v1/tako/sug":{"get":{"operationId":"takoSug","summary":"Tako suggestions","description":"Prompts Tako suggests for a video or topic.\n\nUpstream: /aweme/v1/tako/sug/.\n\nCost: 5 credits (standard tier). Failed calls are not charged.","tags":["Feeds, search & Tako AI"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/aweme/v1/tako/sug/"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/tako-sug","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"aweme_id":"7705852133855161377","suggestions":["What switches are in this keyboard?","Where to buy this keycap set?","Compare bytevc1 vs tactile boards"]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"aweme_id","in":"query","required":false,"description":"A video to get prompts for.","schema":{"type":"string"},"example":"7705852133855161377"},{"name":"query","in":"query","required":false,"description":"Or a topic.","schema":{"type":"string"}},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/tako/conversation":{"get":{"operationId":"takoConversation","summary":"Tako conversation","description":"Messages in one of a connected account's Tako conversations.\n\nUpstream: /aweme/v1/tako/conversation/message/list/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["Feeds, search & Tako AI"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/aweme/v1/tako/conversation/message/list/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/tako-conversation","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"conversation_id":"tako_conv_918273645","messages":[{"message_id":"tako_m1","role":"user","text":"Best budget mechanical keyboards?","create_time":1762880010},{"message_id":"tako_m2","role":"assistant","text":"Creators recommend 75% gasket-mount keyboards with factory-lubed switches.","cited_video_ids":["7705852133855161377"],"create_time":1762880012}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"account_id","in":"query","required":true,"description":"A connected account, from /dash/sessions or POST /v1/account/import.","schema":{"type":"string"},"example":"acc_7Hq2"},{"name":"conversation_id","in":"query","required":true,"description":"The conversation.","schema":{"type":"string"},"example":"tako_conv_918273645"}]}},"/v1/tako/inbox":{"get":{"operationId":"takoInbox","summary":"Tako inbox","description":"A connected account's Tako inbox.\n\nUpstream: /aweme/v1/tako/inbox/message/list/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["Feeds, search & Tako AI"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/aweme/v1/tako/inbox/message/list/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/tako-inbox","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"account_id":"acc_7Hq2","conversations":[{"conversation_id":"tako_conv_918273645","title":"Mechanical keyboard recommendations","updated_at":1762880012}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"account_id","in":"query","required":true,"description":"A connected account, from /dash/sessions or POST /v1/account/import.","schema":{"type":"string"},"example":"acc_7Hq2"}]}},"/v1/tako/memory":{"get":{"operationId":"takoMemory","summary":"Tako memory","description":"What Tako remembers for a connected account.\n\nUpstream: /aweme/v1/tako/memory/list/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["Feeds, search & Tako AI"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/aweme/v1/tako/memory/list/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/tako-memory","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"account_id":"acc_7Hq2","memories":[{"memory_id":"mem_01","text":"Interested in mechanical keyboards, audio gear, and desk setups","created_at":1762500000}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"account_id","in":"query","required":true,"description":"A connected account, from /dash/sessions or POST /v1/account/import.","schema":{"type":"string"},"example":"acc_7Hq2"}]}},"/v1/creator/search-insights":{"get":{"operationId":"searchInsights","summary":"Search insights","description":"Studio search topics with content gaps.\n\nUpstream: /tiktok/v1/creator/search_insights/topics/.\n\nCost: 25 credits (premium tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Feeds, search & Tako AI"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/tiktok/v1/creator/search_insights/topics/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/creator/search-insights"],"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/search-insights","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":"20","has_more":true,"items":[{"topic_id":"7420998877665544332","keyword":"low profile mechanical keyboard","search_volume_index":94200,"growth_7d_pct":148.5,"content_gap":true,"competition_score":0.31}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"keyword","in":"query","required":true,"description":"What to search for.","schema":{"type":"string"},"example":"keyboards"},{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/creator/search-insights/detail":{"get":{"operationId":"searchInsightsDetail","summary":"Search insight detail","description":"One search topic: volume, gap and related queries.\n\nUpstream: /tiktok/v1/creator/search_insights/detail/.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["Feeds, search & Tako AI"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/tiktok/v1/creator/search_insights/detail/"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/search-insights-detail","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"topic_id":"7420998877665544332","keyword":"low profile mechanical keyboard","region":"US","search_volume_index":94200,"growth_7d_pct":148.5,"content_gap":true,"related_queries":["best low profile keyboard for mac","silent low profile switches","nuphy vs lofree sound test"],"audience_age_top":"25-34"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"topic_id","in":"query","required":true,"description":"The topic.","schema":{"type":"string"},"example":"7420998877665544332"},{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/creator/search-insights/trend":{"get":{"operationId":"searchInsightsTrend","summary":"Search insight trend","description":"Search volume over time for a topic.\n\nUpstream: /tiktok/v1/creator/search_insights/detail/.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["Feeds, search & Tako AI"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/tiktok/v1/creator/search_insights/detail/"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/search-insights-trend","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"topic_id":"7420998877665544332","region":"US","points":[{"date":"2026-11-06","value":41200},{"date":"2026-11-08","value":68900},{"date":"2026-11-10","value":94200}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"topic_id","in":"query","required":true,"description":"The topic.","schema":{"type":"string"},"example":"7420998877665544332"},{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/creator/search-insights/videos":{"get":{"operationId":"searchInsightsVideos","summary":"Search insight videos","description":"Top videos for a search topic.\n\nUpstream: /tiktok/v1/creator/search_insights/detail/.\n\nCost: 25 credits (premium tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Feeds, search & Tako AI"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/tiktok/v1/creator/search_insights/detail/"],"x-access":"public","x-paginated":true,"x-docs":"https://tikultra.com/docs/api/search-insights-videos","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":"20","has_more":true,"items":[{"aweme_id":"7705852133855161377","desc":"Launch film, 1080p60 master #keyboards #desksetup","create_time":1762622512,"region":"US","author":{"uid":"6970000000000000001","unique_id":"acme","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","nickname":"Acme Studio","follower_count":128431,"verified":false},"stats":{"play_count":1482906,"digg_count":96442,"comment_count":1318,"share_count":4877,"collect_count":2210,"repost_count":614},"music":{"id":"7569924403851462401","title":"original sound - acme","author":"Acme Studio","duration_sec":31},"video":{"codec":"bytevc1","width":1080,"height":1920,"fps":60,"duration_ms":31840,"bitrate_bps":3842100,"play_url":"https://v16-webapp-prime.tiktok.com/video/tos/useast2a/tos-useast2a-pve-0068/oQ8kLmN2xR9pV/?a=1233","cover_url":"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/o8kLmN2xR9pV~tplv-tiktokx-origin.image"}}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"topic_id","in":"query","required":true,"description":"The topic.","schema":{"type":"string"},"example":"7420998877665544332"},{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/douyin/hot":{"get":{"operationId":"douyinHot","summary":"Douyin hot list","description":"The Douyin hot search list.\n\nUpstream: /aweme/v1/hot/search/list/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["Feeds, search & Tako AI"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/aweme/v1/hot/search/list/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/douyin/hot"],"x-docs":"https://tikultra.com/docs/api/douyin-hot","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"board":"hot_search","updated_at":1762900000,"items":[{"rank":1,"word":"机械键盘客制化评测","hot_value":11482900,"label":"热"},{"rank":2,"word":"桌面改造灵感","hot_value":9241300,"label":"新"}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/douyin/search":{"get":{"operationId":"douyinSearch","summary":"Douyin hot search","description":"The Douyin hot search board for a keyword.\n\nUpstream: /aweme/v1/hot/search/list/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["Feeds, search & Tako AI"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/aweme/v1/hot/search/list/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/douyin/hot-search"],"x-docs":"https://tikultra.com/docs/api/douyin-search","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"keyword":"键盘","items":[{"rank":1,"word":"矮轴机械键盘推荐","hot_value":4821000}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"keyword","in":"query","required":true,"description":"What to search for.","schema":{"type":"string"},"example":"键盘"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/douyin/brand":{"get":{"operationId":"douyinBrand","summary":"Douyin brand board","description":"The Douyin brand board.\n\nUpstream: /aweme/v1/hot/search/list/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["Feeds, search & Tako AI"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/aweme/v1/hot/search/list/"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/douyin-brand","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"category":"digital","items":[{"rank":1,"brand_name":"Keychron","score":96.4}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"category","in":"query","required":false,"description":"Board category.","schema":{"type":"string"}},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/douyin/music":{"get":{"operationId":"douyinMusic","summary":"Douyin music board","description":"The Douyin music board.\n\nUpstream: /aweme/v1/hot/search/list/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["Feeds, search & Tako AI"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/aweme/v1/hot/search/list/"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/douyin-music","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"board":"music_hot","items":[{"rank":1,"music_id":"7410998877665544332","title":"Late Night Coding Lo-Fi","author":"Studio Beats","heat":8420190}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/shop/pdp":{"get":{"operationId":"shopPdp","summary":"Product page","description":"The full SDUI product detail page the app renders: SKUs, prices, inventory, shipping, coupons and seller stats.\n\nUpstream: /api/v2/shop/sdui_pdp/get, /api/v1/shop/item/product_info/get.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["TikTok Shop"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/api/v2/shop/sdui_pdp/get","/api/v1/shop/item/product_info/get"],"x-access":"public","x-exclusive":true,"x-docs":"https://tikultra.com/docs/api/shop-pdp","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"product_id":"1729384756192837461","title":"Low-profile mechanical keyboard 75% Aluminum","region":"US","currency":"USD","price_range":{"min":"79.99","max":"89.99","original":"109.00"},"sold_count":18204,"rating":4.8,"review_count":2941,"skus":[{"sku_id":"1729384756192837462","price":"79.99","stock":412,"props":{"switch":"Tactile Brown","color":"Space Grey"}},{"sku_id":"1729384756192837463","price":"89.99","stock":195,"props":{"switch":"Silent Linear","color":"Silver"}}],"shipping":{"free_shipping":true,"free_over":"35.00","eta_days":[3,6],"ships_from":"California, US"},"coupons":[{"code":"SAVE10","discount_text":"10% off orders over $50"}],"seller":{"seller_id":"7495000000000000001","name":"Acme Studio Shop","rating":4.8,"product_count":28,"response_rate_pct":99}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"product_id","in":"query","required":false,"description":"The TikTok Shop product ID.","schema":{"type":"string"},"example":"1729384756192837461"},{"name":"url","in":"query","required":false,"description":"A Shop product link.","schema":{"type":"string"}},{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/shop/live-bag":{"get":{"operationId":"liveBag","summary":"LIVE shopping bag","description":"Products pinned in a LIVE room, with prices and promos.\n\nUpstream: /aweme/v2/oec/live/bag/assemble, /aweme/v2/oec/live/bag/tabs_and_products.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["TikTok Shop"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/aweme/v2/oec/live/bag/assemble","/aweme/v2/oec/live/bag/tabs_and_products"],"x-access":"public","x-legacy-aliases":["/v1/scrape/ecom/live-bag"],"x-exclusive":true,"x-docs":"https://tikultra.com/docs/api/live-bag","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"room_id":"7705861000123456789","total_products":8,"pinned":{"product_id":"1729384756192837461","index":1,"title":"Low-profile mechanical keyboard 75%","price":"64.99","currency":"USD","promo":"LIVE Flash Deal · ends in 04:12"},"items":[{"product_id":"1729384756192837461","index":1,"title":"Low-profile mechanical keyboard 75%","price":"64.99","stock":120},{"product_id":"1729384756192837499","index":2,"title":"Coiled USB-C Aviator Cable","price":"19.99","stock":340}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"room_id","in":"query","required":true,"description":"The numeric LIVE room ID.","schema":{"type":"string"},"example":"7705861000123456789"},{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/shop/search":{"get":{"operationId":"shopSearch","summary":"Shop search","description":"Search Shop products by keyword.\n\nUpstream: /aweme/v1/search/single/bff/ecom/, /aweme/v1/search/pack_product/ecom/.\n\nCost: 25 credits (premium tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["TikTok Shop"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/aweme/v1/search/single/bff/ecom/","/aweme/v1/search/pack_product/ecom/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/ecom/search"],"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/shop-search","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":"20","has_more":true,"items":[{"product_id":"1729384756192837461","title":"Low-profile mechanical keyboard 75%","price":"79.99","currency":"USD","sold_count":18204,"rating":4.8,"seller_id":"7495000000000000001"}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"keyword","in":"query","required":true,"description":"What to search for.","schema":{"type":"string"},"example":"vitamin c serum"},{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/shop/seller":{"get":{"operationId":"sellerCatalog","summary":"Seller catalog","description":"A seller's storefront and catalog.\n\nUpstream: /api/shop/v1/homepage/get, /api/shop/v1/product/list.\n\nCost: 25 credits (premium tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["TikTok Shop"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/api/shop/v1/homepage/get","/api/shop/v1/product/list"],"x-access":"public","x-legacy-aliases":["/v1/scrape/ecom/shop"],"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/seller-catalog","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":"20","has_more":true,"items":[{"product_id":"1729384756192837461","title":"Low-profile mechanical keyboard 75%","price":"79.99","currency":"USD","sold_count":18204,"stock_status":"in_stock"}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"seller_id","in":"query","required":true,"description":"The TikTok Shop seller ID.","schema":{"type":"string"},"example":"7495000000000000001"},{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/shop/seller/categories":{"get":{"operationId":"sellerCategories","summary":"Seller categories","description":"Categories inside a seller's storefront.\n\nUpstream: /api/shop/v1/category/list.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["TikTok Shop"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/api/shop/v1/category/list"],"x-access":"public","x-legacy-aliases":["/v1/scrape/ecom/shop/categories"],"x-docs":"https://tikultra.com/docs/api/seller-categories","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"seller_id":"7495000000000000001","categories":[{"category_id":"cat_keyboards","name":"Keyboards","product_count":12},{"category_id":"cat_switches","name":"Switches & Stabilizers","product_count":9},{"category_id":"cat_keycaps","name":"Keycap Sets","product_count":7}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"seller_id","in":"query","required":true,"description":"The TikTok Shop seller ID.","schema":{"type":"string"},"example":"7495000000000000001"},{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/shop/seller/reviews":{"get":{"operationId":"sellerReviews","summary":"Seller reviews","description":"Verified buyer reviews across a seller’s shop.\n\nUpstream: /api/v1/shop_review/list.\n\nCost: 25 credits (premium tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["TikTok Shop"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/api/v1/shop_review/list"],"x-access":"public","x-legacy-aliases":["/v1/scrape/ecom/shop/reviews"],"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/seller-reviews","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":"20","has_more":true,"items":[{"review_id":"rev_99182736","product_id":"1729384756192837461","rating":5,"text":"Fast shipping and zero metallic ping out of the box.","buyer_mask":"j***n","verified_purchase":true,"create_time":1762810000}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"seller_id","in":"query","required":true,"description":"The TikTok Shop seller ID.","schema":{"type":"string"},"example":"7495000000000000001"},{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/shop/showcase":{"get":{"operationId":"showcase","summary":"Creator showcase","description":"Products in a creator's showcase.\n\nUpstream: /api/showcase/v1/product/list, /api/showcase/v1/creator_info/get.\n\nCost: 25 credits (premium tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["TikTok Shop"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/api/showcase/v1/product/list","/api/showcase/v1/creator_info/get"],"x-access":"public","x-legacy-aliases":["/v1/scrape/ecom/showcase"],"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/showcase","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":"20","has_more":true,"items":[{"product_id":"1729384756192837461","title":"Low-profile mechanical keyboard 75%","price":"79.99","currency":"USD","commission_rate_bps":1200}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"username","in":"query","required":false,"description":"The @username, without the @.","schema":{"type":"string"},"example":"acme"},{"name":"sec_uid","in":"query","required":false,"description":"The stable account ID used by the mobile API.","schema":{"type":"string"}},{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/shop/reviews":{"get":{"operationId":"shopReviews","summary":"Product reviews","description":"Buyer reviews of a product or shop.\n\nUpstream: /api/v1/review/list, /api/v1/shop_review/list.\n\nCost: 25 credits (premium tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["TikTok Shop"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/api/v1/review/list","/api/v1/shop_review/list"],"x-access":"public","x-legacy-aliases":["/v1/scrape/ecom/reviews"],"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/shop-reviews","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":"20","has_more":true,"items":[{"review_id":"rev_99182736","rating":5,"sku_spec":"Tactile Brown · Space Grey","text":"Best compact board I have owned.","verified_purchase":true,"helpful_count":37,"images":["https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/rev1.webp"]}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"product_id","in":"query","required":false,"description":"The TikTok Shop product ID.","schema":{"type":"string"},"example":"1729384756192837461"},{"name":"url","in":"query","required":false,"description":"A Shop product link.","schema":{"type":"string"}},{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/shop/anchors":{"get":{"operationId":"shopAnchors","summary":"Shop anchors","description":"Products anchored to a video.\n\nUpstream: /aweme/v1/anchor/aweme/.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["TikTok Shop"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/aweme/v1/anchor/aweme/"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/shop-anchors","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"aweme_id":"7705852133855161377","products":[{"product_id":"1729384756192837461","title":"Low-profile mechanical keyboard 75%","price":"79.99","currency":"USD"}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"aweme_id","in":"query","required":true,"description":"The numeric video ID.","schema":{"type":"string"},"example":"7705852133855161377"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/shop/mall":{"get":{"operationId":"shopMall","summary":"Mall home","description":"The Shop mall home page.\n\nUpstream: /api/v1/mall/homepage/bff/get.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["TikTok Shop"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/api/v1/mall/homepage/bff/get"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/shop-mall","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"region":"US","banners":[{"title":"Tech & Desk Week","campaign_id":"cmp_7721"}],"flash_sale":[{"product_id":"1729384756192837461","title":"Low-profile mechanical keyboard 75%","sale_price":"69.99","original_price":"109.00"}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/shop/tab":{"get":{"operationId":"shopTab","summary":"Shop tab","description":"The Shop tab recommendations.\n\nUpstream: /api/v1/mall/shop_tab/algorithm/reach/get.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["TikTok Shop"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/api/v1/mall/shop_tab/algorithm/reach/get"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/shop-tab","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"region":"US","items":[{"product_id":"1729384756192837461","title":"Low-profile mechanical keyboard 75%","price":"79.99","currency":"USD","recommendation_reason":"Top seller in Computer Peripherals"}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/shop/live-products":{"get":{"operationId":"shopLiveProducts","summary":"LIVE product pop-up","description":"The product pop-up shown in a LIVE room.\n\nUpstream: /aweme/v1/oec/live/product/pop.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["TikTok Shop"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/aweme/v1/oec/live/product/pop"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/shop-live-products","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"room_id":"7705861000123456789","pop_product":{"product_id":"1729384756192837461","title":"Low-profile mechanical keyboard 75%","live_price":"64.99","currency":"USD","remaining_stock":120}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"room_id","in":"query","required":true,"description":"The numeric LIVE room ID.","schema":{"type":"string"},"example":"7705861000123456789"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/shop/live-room":{"get":{"operationId":"shopLiveRoom","summary":"LIVE shop info","description":"Commerce info for a LIVE room.\n\nUpstream: /aweme/v1/oec/live/room/common_info.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["TikTok Shop"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/aweme/v1/oec/live/room/common_info"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/shop-live-room","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"room_id":"7705861000123456789","has_commerce_bag":true,"product_count":8,"seller_id":"7495000000000000001","atmosphere_tags":["Free shipping","120 sold in LIVE"]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"room_id","in":"query","required":true,"description":"The numeric LIVE room ID.","schema":{"type":"string"},"example":"7705861000123456789"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/shop/suggestions":{"get":{"operationId":"shopSuggestions","summary":"Shop suggestions","description":"Shop search suggestions.\n\nUpstream: /aweme/v1/search/sug/prefetch/ecom/.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["TikTok Shop"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/aweme/v1/search/sug/prefetch/ecom/"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/shop-suggestions","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"keyword":"serum","suggestions":["vitamin c serum","niacinamide serum","hyaluronic acid serum"]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"keyword","in":"query","required":true,"description":"What to search for.","schema":{"type":"string"},"example":"serum"},{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/shop/creator":{"get":{"operationId":"shopCreator","summary":"Shop creator","description":"A creator's commerce profile.\n\nUpstream: /api/shop/v1/creator/info/get.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["TikTok Shop"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/api/shop/v1/creator/info/get"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/shop-creator","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"username":"acme","uid":"6970000000000000001","has_showcase":true,"showcase_product_count":14,"category_focus":["Computers & Office","Consumer Electronics"]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"username","in":"query","required":false,"description":"The @username, without the @.","schema":{"type":"string"},"example":"acme"},{"name":"sec_uid","in":"query","required":false,"description":"The stable account ID used by the mobile API.","schema":{"type":"string"}},{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/shop/same-shop":{"get":{"operationId":"sameShop","summary":"More from this shop","description":"Other products from the same shop.\n\nUpstream: /api/v1/shop/recommend/same_shop/get.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["TikTok Shop"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/api/v1/shop/recommend/same_shop/get"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/same-shop","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"seller_id":"7495000000000000001","items":[{"product_id":"1729384756192837499","title":"Coiled USB-C Aviator Cable","price":"19.99","currency":"USD"},{"product_id":"1729384756192837500","title":"PBT Double-Shot Low-Profile Keycaps","price":"29.99","currency":"USD"}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"product_id","in":"query","required":false,"description":"The TikTok Shop product ID.","schema":{"type":"string"},"example":"1729384756192837461"},{"name":"url","in":"query","required":false,"description":"A Shop product link.","schema":{"type":"string"}},{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/shop/recommendations":{"get":{"operationId":"shopRecommendations","summary":"Product recommendations","description":"Products recommended on a product page.\n\nUpstream: /api/v1/shop/pdp/recommendations/get.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["TikTok Shop"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/api/v1/shop/pdp/recommendations/get"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/shop-recommendations","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"product_id":"1729384756192837461","items":[{"product_id":"1729384756192837511","title":"Walnut Wrist Rest 75%","price":"24.99","currency":"USD","rating":4.9}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"product_id","in":"query","required":false,"description":"The TikTok Shop product ID.","schema":{"type":"string"},"example":"1729384756192837461"},{"name":"url","in":"query","required":false,"description":"A Shop product link.","schema":{"type":"string"}},{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/shop/promotions":{"get":{"operationId":"shopPromotions","summary":"Promotions","description":"Active promotions on a product.\n\nUpstream: /api/v1/shop/promotion_info/get.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["TikTok Shop"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/api/v1/shop/promotion_info/get"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/shop-promotions","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"product_id":"1729384756192837461","promotions":[{"promo_id":"prm_101","type":"seller_coupon","label":"10% off $50+","discount_pct":10,"expires_at":1764547200},{"promo_id":"prm_102","type":"free_shipping","label":"Free standard shipping","min_spend":"35.00"}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"product_id","in":"query","required":false,"description":"The TikTok Shop product ID.","schema":{"type":"string"},"example":"1729384756192837461"},{"name":"url","in":"query","required":false,"description":"A Shop product link.","schema":{"type":"string"}},{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/shop/translation":{"get":{"operationId":"shopTranslation","summary":"Product translation","description":"Whether a product listing can be translated.\n\nUpstream: /aweme/v1/oec/content/anchors/get_product_translation_ability.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["TikTok Shop"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/aweme/v1/oec/content/anchors/get_product_translation_ability"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/shop-translation","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"product_id":"1729384756192837461","translatable":true,"source_language":"en","supported_targets":["es","de","fr","pt","ja"]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"product_id","in":"query","required":false,"description":"The TikTok Shop product ID.","schema":{"type":"string"},"example":"1729384756192837461"},{"name":"url","in":"query","required":false,"description":"A Shop product link.","schema":{"type":"string"}},{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/live/room":{"get":{"operationId":"liveRoom","summary":"LIVE room","description":"Room state, host, viewer counts and stream metadata.\n\nUpstream: /webcast/room/enter/, /webcast/room/info/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["LIVE rooms"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/webcast/room/enter/","/webcast/room/info/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/live/room"],"x-docs":"https://tikultra.com/docs/api/live-room","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"room_id":"7705861000123456789","status":"live","title":"Building 3 custom keyboards live + sound test","viewer_count":1842,"total_user_count":29410,"like_count":84200,"host":{"uid":"6970000000000000001","unique_id":"acme","nickname":"Acme Studio","verified":false},"has_commerce_goods":true,"started_at":1762896400}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"room_id","in":"query","required":false,"description":"The numeric LIVE room ID.","schema":{"type":"string"},"example":"7705861000123456789"},{"name":"username","in":"query","required":false,"description":"The host's @username.","schema":{"type":"string"}},{"name":"url","in":"query","required":false,"description":"A LIVE link.","schema":{"type":"string"}},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/live/check-alive":{"get":{"operationId":"liveCheckAlive","summary":"Is LIVE","description":"Whether rooms are live right now.\n\nUpstream: /webcast/room/check_alive/.\n\nCost: 5 credits (standard tier). Failed calls are not charged.","tags":["LIVE rooms"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/webcast/room/check_alive/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/live/check-alive"],"x-docs":"https://tikultra.com/docs/api/live-check-alive","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"rooms":[{"room_id":"7705861000123456789","alive":true}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"room_ids","in":"query","required":true,"description":"Comma-separated room IDs.","schema":{"type":"string"},"example":"7705861000123456789"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/live/chat":{"get":{"operationId":"liveChat","summary":"LIVE chat","description":"Decoded chat, gift and room events.\n\nUpstream: /webcast/im/fetch/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["LIVE rooms"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/webcast/im/fetch/"],"x-access":"public","x-paginated":true,"x-docs":"https://tikultra.com/docs/api/live-chat","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":"1762900015000_9912","has_more":true,"events":[{"type":"WebcastChatMessage","msg_id":"7705861999111222333","user":{"unique_id":"kbfan","nickname":"KB Fan"},"text":"Try the POM plate next!","ts_ms":1762900012410},{"type":"WebcastGiftMessage","msg_id":"7705861999111222334","user":{"unique_id":"deskminimal","nickname":"Desk Minimal"},"gift_name":"Doughnut","diamond_count":30,"repeat_count":2,"ts_ms":1762900014105}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"room_id","in":"query","required":true,"description":"The numeric LIVE room ID.","schema":{"type":"string"},"example":"7705861000123456789"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/live/with-chat":{"get":{"operationId":"liveWithChat","summary":"LIVE room with chat","description":"Room state and the latest chat events in one call.\n\nUpstream: /webcast/room/info/, /webcast/im/fetch/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["LIVE rooms"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/webcast/room/info/","/webcast/im/fetch/"],"x-access":"public","x-paginated":true,"x-docs":"https://tikultra.com/docs/api/live-with-chat","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"room":{"room_id":"7705861000123456789","status":"live","title":"Building 3 custom keyboards live","viewer_count":1842,"host":{"unique_id":"acme"}},"cursor":"1762900015000_9912","has_more":true,"events":[{"type":"WebcastChatMessage","user":{"unique_id":"kbfan"},"text":"Try the POM plate next!","ts_ms":1762900012410}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"room_id","in":"query","required":true,"description":"The numeric LIVE room ID.","schema":{"type":"string"},"example":"7705861000123456789"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/live/stream":{"get":{"operationId":"liveStream","summary":"LIVE stream URLs","description":"FLV and HLS stream URLs at each quality.\n\nUpstream: /webcast/room/info/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["LIVE rooms"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/webcast/room/info/"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/live-stream","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"room_id":"7705861000123456789","streams":{"origin":{"flv":"https://pull-f5-tt03.fcdn.us.tiktokcdn.com/game/stream-7705861000123456789_uhd.flv","hls":"https://pull-hls-f5-tt03.fcdn.us.tiktokcdn.com/game/stream-7705861000123456789_uhd/index.m3u8","resolution":"1080x1920","fps":60},"hd":{"flv":"https://pull-f5-tt03.fcdn.us.tiktokcdn.com/game/stream-7705861000123456789_hd.flv","hls":"https://pull-hls-f5-tt03.fcdn.us.tiktokcdn.com/game/stream-7705861000123456789_hd/index.m3u8","resolution":"720x1280","fps":30}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"room_id","in":"query","required":true,"description":"The numeric LIVE room ID.","schema":{"type":"string"},"example":"7705861000123456789"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/live/audience":{"get":{"operationId":"liveAudience","summary":"LIVE audience","description":"The online audience ranking.\n\nUpstream: /webcast/ranklist/online_audience/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["LIVE rooms"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/webcast/ranklist/online_audience/"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/live-audience","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"room_id":"7705861000123456789","online_count":1842,"contributors":[{"rank":1,"user":{"unique_id":"deskminimal","nickname":"Desk Minimal"},"score_diamonds":1450},{"rank":2,"user":{"unique_id":"kbfan","nickname":"KB Fan"},"score_diamonds":620}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"room_id","in":"query","required":true,"description":"The numeric LIVE room ID.","schema":{"type":"string"},"example":"7705861000123456789"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/live/ranking":{"get":{"operationId":"liveRanking","summary":"LIVE hourly ranking","description":"The hourly LIVE ranking.\n\nUpstream: /webcast/ranklist/hour/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["LIVE rooms"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/webcast/ranklist/hour/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/live/ranking"],"x-docs":"https://tikultra.com/docs/api/live-ranking","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"region":"US","rank_type":"hourly","items":[{"rank":1,"room_id":"7705861000123456789","host":{"unique_id":"acme","nickname":"Acme Studio"},"score":94210,"viewer_count":1842}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/live/gifts":{"get":{"operationId":"liveGifts","summary":"LIVE gift catalog","description":"The gifts available in a room, with coin prices.\n\nUpstream: /webcast/gift/list/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["LIVE rooms"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/webcast/gift/list/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/live/gifts"],"x-docs":"https://tikultra.com/docs/api/live-gifts","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"room_id":"7705861000123456789","gifts":[{"gift_id":5655,"name":"Rose","diamond_count":1,"icon_url":"https://p16-webcast.tiktokcdn.com/img/maliva/webcast-va/rose.png"},{"gift_id":5879,"name":"Doughnut","diamond_count":30,"icon_url":"https://p16-webcast.tiktokcdn.com/img/maliva/webcast-va/doughnut.png"},{"gift_id":6064,"name":"Galaxy","diamond_count":1000,"icon_url":"https://p16-webcast.tiktokcdn.com/img/maliva/webcast-va/galaxy.png"}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"room_id","in":"query","required":true,"description":"The numeric LIVE room ID.","schema":{"type":"string"},"example":"7705861000123456789"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/live/recommended":{"get":{"operationId":"liveRecommended","summary":"Recommended LIVE","description":"Rooms the LIVE feed recommends.\n\nUpstream: /webcast/feed/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["LIVE rooms"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/webcast/feed/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/live/recommended"],"x-docs":"https://tikultra.com/docs/api/live-recommended","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"region":"US","items":[{"room_id":"7705861000123456789","title":"Building 3 custom keyboards live","viewer_count":1842,"host":{"unique_id":"acme"}}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"10"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/live/goody-bag":{"get":{"operationId":"goodyBag","summary":"Goody bag","description":"Details of a room’s goody bag.\n\nUpstream: /webcast/goody_bag/detail/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["LIVE rooms"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/webcast/goody_bag/detail/"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/goody-bag","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"room_id":"7705861000123456789","active":true,"goody_bag_id":"gb_7705869001","total_coins":500,"winner_quota":25,"participant_count":418,"opens_at":1762900300}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"room_id","in":"query","required":true,"description":"The numeric LIVE room ID.","schema":{"type":"string"},"example":"7705861000123456789"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/live/bag-items":{"get":{"operationId":"liveBagItems","summary":"LIVE bag items","description":"Every product in a room’s shopping bag.\n\nUpstream: /aweme/v2/oec/live/bag/assemble.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["LIVE rooms"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/aweme/v2/oec/live/bag/assemble"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/live-bag-items","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"room_id":"7705861000123456789","count":2,"items":[{"product_id":"1729384756192837461","index":1,"title":"Low-profile mechanical keyboard 75%","price":"64.99","currency":"USD","stock":120},{"product_id":"1729384756192837499","index":2,"title":"Coiled USB-C Aviator Cable","price":"19.99","currency":"USD","stock":340}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"room_id","in":"query","required":true,"description":"The numeric LIVE room ID.","schema":{"type":"string"},"example":"7705861000123456789"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/series/mini-dramas":{"get":{"operationId":"miniDramas","summary":"Mini dramas","description":"The short-drama catalog with episode metrics.\n\nUpstream: /tiktok/v1/paid_content/mini_drama/feed/, /tiktok/v1/paid_content/mini_drama/tabs/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Series, sounds, hashtags & places"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/tiktok/v1/paid_content/mini_drama/feed/","/tiktok/v1/paid_content/mini_drama/tabs/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/mini-drama"],"x-exclusive":true,"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/mini-dramas","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":"20","has_more":true,"items":[{"series_id":"7705890000000000001","title":"The Heiress Returns","episodes":64,"free_episodes":8,"play_count":48210337,"genres":["Drama","Romance"]}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"tab_id","in":"query","required":false,"description":"A tab from /v1/series/mini-dramas/tabs.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/series/mini-dramas/tabs":{"get":{"operationId":"miniDramaTabs","summary":"Mini drama tabs","description":"The tabs of the short-drama catalog.\n\nUpstream: /tiktok/v1/paid_content/mini_drama/tabs/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["Series, sounds, hashtags & places"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/tiktok/v1/paid_content/mini_drama/tabs/"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/mini-drama-tabs","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"region":"US","tabs":[{"tab_id":"popular","name":"Trending"},{"tab_id":"new","name":"New Releases"},{"tab_id":"revenge","name":"CEO & Revenge"}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/series/mini-dramas/history":{"get":{"operationId":"miniDramaHistory","summary":"Mini drama watch history","description":"Short-drama watch history for a connected account.\n\nUpstream: /tiktok/v1/paid_content/mini_drama/watch_history/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Series, sounds, hashtags & places"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/tiktok/v1/paid_content/mini_drama/watch_history/"],"x-access":"growth","x-paginated":true,"x-docs":"https://tikultra.com/docs/api/mini-drama-history","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":null,"has_more":false,"items":[{"series_id":"7705890000000000001","title":"The Heiress Returns","last_watched_episode":9,"progress_ms":81400,"updated_at":1762891000}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"account_id","in":"query","required":true,"description":"A connected account, from /dash/sessions or POST /v1/account/import.","schema":{"type":"string"},"example":"acc_7Hq2"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"}]}},"/v1/series":{"get":{"operationId":"series","summary":"Series","description":"One series: title, price and episodes.\n\nUpstream: /tiktok/v1/paid_content/collection/detail/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["Series, sounds, hashtags & places"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/tiktok/v1/paid_content/collection/detail/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/series/info"],"x-docs":"https://tikultra.com/docs/api/series","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"series_id":"7705890000000000001","title":"Custom Keyboard Engineering A-Z","description":"Complete acoustics, PCB design, switch lubing, and firmware masterclass.","episode_count":12,"price":{"amount":"9.99","currency":"USD"},"creator":{"uid":"6970000000000000001","unique_id":"acme","nickname":"Acme Studio"}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"series_id","in":"query","required":true,"description":"The series ID.","schema":{"type":"string"},"example":"7705890000000000001"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/series/videos":{"get":{"operationId":"seriesVideos","summary":"Series episodes","description":"The episodes of a series.\n\nUpstream: /tiktok/v1/paid_content/collection/detail/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Series, sounds, hashtags & places"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/tiktok/v1/paid_content/collection/detail/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/series"],"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/series-videos","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":null,"has_more":false,"items":[{"episode_index":1,"aweme_id":"7705852133855161377","title":"Ep 1 · Case materials & gasket geometry","duration_ms":412000,"is_free_preview":true}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"series_id","in":"query","required":true,"description":"The series ID.","schema":{"type":"string"},"example":"7705890000000000001"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/mix":{"get":{"operationId":"mix","summary":"Playlist","description":"One playlist (mix).\n\nUpstream: /tiktok/v1/mix/detail/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["Series, sounds, hashtags & places"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/tiktok/v1/mix/detail/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/mix"],"x-docs":"https://tikultra.com/docs/api/mix","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"mix_id":"7705891000000000001","name":"Keyboard Sound Tests","video_count":24,"play_count":6920410,"author":{"uid":"6970000000000000001","unique_id":"acme","nickname":"Acme Studio"}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"mix_id","in":"query","required":true,"description":"The playlist ID.","schema":{"type":"string"},"example":"7705891000000000001"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/mix/videos":{"get":{"operationId":"mixVideos","summary":"Playlist videos","description":"The videos in a playlist.\n\nUpstream: /tiktok/v1/mix/aweme/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Series, sounds, hashtags & places"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/tiktok/v1/mix/aweme/"],"x-access":"public","x-paginated":true,"x-docs":"https://tikultra.com/docs/api/mix-videos","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":"1","has_more":true,"items":[{"aweme_id":"7705852133855161377","desc":"Launch film, 1080p60 master #keyboards #desksetup","create_time":1762622512,"region":"US","author":{"uid":"6970000000000000001","unique_id":"acme","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","nickname":"Acme Studio","follower_count":128431,"verified":false},"stats":{"play_count":1482906,"digg_count":96442,"comment_count":1318,"share_count":4877,"collect_count":2210,"repost_count":614},"music":{"id":"7569924403851462401","title":"original sound - acme","author":"Acme Studio","duration_sec":31},"video":{"codec":"bytevc1","width":1080,"height":1920,"fps":60,"duration_ms":31840,"bitrate_bps":3842100,"play_url":"https://v16-webapp-prime.tiktok.com/video/tos/useast2a/tos-useast2a-pve-0068/oQ8kLmN2xR9pV/?a=1233","cover_url":"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/o8kLmN2xR9pV~tplv-tiktokx-origin.image"}}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"mix_id","in":"query","required":true,"description":"The playlist ID.","schema":{"type":"string"},"example":"7705891000000000001"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/music":{"get":{"operationId":"music","summary":"Sound","description":"A sound and the videos that use it.\n\nUpstream: /aweme/v1/music/detail/, /aweme/v1/music/aweme/.\n\nCost: 5 credits (standard tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Series, sounds, hashtags & places"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/aweme/v1/music/detail/","/aweme/v1/music/aweme/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/music"],"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/music","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"music":{"id":"7569924403851462401","title":"original sound - acme","author":"Acme Studio","duration_sec":31,"user_count":1482,"is_original":true},"cursor":"20","has_more":true,"items":[{"aweme_id":"7705852133855161377","desc":"Launch film, 1080p60 master #keyboards #desksetup","create_time":1762622512,"region":"US","author":{"uid":"6970000000000000001","unique_id":"acme","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","nickname":"Acme Studio","follower_count":128431,"verified":false},"stats":{"play_count":1482906,"digg_count":96442,"comment_count":1318,"share_count":4877,"collect_count":2210,"repost_count":614},"music":{"id":"7569924403851462401","title":"original sound - acme","author":"Acme Studio","duration_sec":31},"video":{"codec":"bytevc1","width":1080,"height":1920,"fps":60,"duration_ms":31840,"bitrate_bps":3842100,"play_url":"https://v16-webapp-prime.tiktok.com/video/tos/useast2a/tos-useast2a-pve-0068/oQ8kLmN2xR9pV/?a=1233","cover_url":"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/o8kLmN2xR9pV~tplv-tiktokx-origin.image"}}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"music_id","in":"query","required":true,"description":"The numeric sound ID.","schema":{"type":"string"},"example":"7569924403851462401"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/music/fresh":{"get":{"operationId":"musicFresh","summary":"Sound: newest videos","description":"The newest videos using a sound.\n\nUpstream: /aweme/v1/music/fresh/aweme/.\n\nCost: 5 credits (standard tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Series, sounds, hashtags & places"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/aweme/v1/music/fresh/aweme/"],"x-access":"public","x-paginated":true,"x-docs":"https://tikultra.com/docs/api/music-fresh","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":"20","has_more":true,"items":[{"aweme_id":"7705852133855161377","desc":"Launch film, 1080p60 master #keyboards #desksetup","create_time":1762622512,"region":"US","author":{"uid":"6970000000000000001","unique_id":"acme","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","nickname":"Acme Studio","follower_count":128431,"verified":false},"stats":{"play_count":1482906,"digg_count":96442,"comment_count":1318,"share_count":4877,"collect_count":2210,"repost_count":614},"music":{"id":"7569924403851462401","title":"original sound - acme","author":"Acme Studio","duration_sec":31},"video":{"codec":"bytevc1","width":1080,"height":1920,"fps":60,"duration_ms":31840,"bitrate_bps":3842100,"play_url":"https://v16-webapp-prime.tiktok.com/video/tos/useast2a/tos-useast2a-pve-0068/oQ8kLmN2xR9pV/?a=1233","cover_url":"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/o8kLmN2xR9pV~tplv-tiktokx-origin.image"}}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"music_id","in":"query","required":true,"description":"The numeric sound ID.","schema":{"type":"string"},"example":"7569924403851462401"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/music/user-original":{"get":{"operationId":"musicUserOriginal","summary":"Original sounds","description":"Original sounds a creator made.\n\nUpstream: /aweme/v1/original/music/list/.\n\nCost: 5 credits (standard tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Series, sounds, hashtags & places"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/aweme/v1/original/music/list/"],"x-access":"public","x-paginated":true,"x-docs":"https://tikultra.com/docs/api/music-user-original","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":null,"has_more":false,"items":[{"id":"7569924403851462401","title":"original sound - acme","duration_sec":31,"user_count":1482}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"username","in":"query","required":false,"description":"The @username, without the @.","schema":{"type":"string"},"example":"acme"},{"name":"sec_uid","in":"query","required":false,"description":"The stable account ID used by the mobile API.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/music/charts":{"get":{"operationId":"musicCharts","summary":"Sound charts","description":"The music charts.\n\nUpstream: /tiktok/chart/music/list/v1/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["Series, sounds, hashtags & places"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/tiktok/chart/music/list/v1/"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/music-charts","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"region":"US","chart":"viral_50","items":[{"rank":1,"music_id":"7569924403851462401","title":"original sound - acme","author":"Acme Studio","video_count_7d":1482}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/hashtag":{"get":{"operationId":"hashtag","summary":"Hashtag","description":"A hashtag and its videos.\n\nUpstream: /aweme/v1/challenge/detail/, /aweme/v1/challenge/aweme/.\n\nCost: 5 credits (standard tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Series, sounds, hashtags & places"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/aweme/v1/challenge/detail/","/aweme/v1/challenge/aweme/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/hashtag"],"x-paginated":true,"x-docs":"https://tikultra.com/docs/api/hashtag","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"challenge":{"cid":"16049281","cha_name":"keyboards","desc":"Custom builds, switches, and desk acoustics.","view_count":4920184300,"user_count":618200},"cursor":"20","has_more":true,"items":[{"aweme_id":"7705852133855161377","desc":"Launch film, 1080p60 master #keyboards #desksetup","create_time":1762622512,"region":"US","author":{"uid":"6970000000000000001","unique_id":"acme","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","nickname":"Acme Studio","follower_count":128431,"verified":false},"stats":{"play_count":1482906,"digg_count":96442,"comment_count":1318,"share_count":4877,"collect_count":2210,"repost_count":614},"music":{"id":"7569924403851462401","title":"original sound - acme","author":"Acme Studio","duration_sec":31},"video":{"codec":"bytevc1","width":1080,"height":1920,"fps":60,"duration_ms":31840,"bitrate_bps":3842100,"play_url":"https://v16-webapp-prime.tiktok.com/video/tos/useast2a/tos-useast2a-pve-0068/oQ8kLmN2xR9pV/?a=1233","cover_url":"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/o8kLmN2xR9pV~tplv-tiktokx-origin.image"}}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"hashtag","in":"query","required":true,"description":"The hashtag, without the #.","schema":{"type":"string"},"example":"keyboards"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/hashtag/trending":{"get":{"operationId":"hashtagTrending","summary":"Trending hashtags","description":"Trending hashtag categories.\n\nUpstream: /aweme/v2/category/list/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["Series, sounds, hashtags & places"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/aweme/v2/category/list/"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/hashtag-trending","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"region":"US","items":[{"cid":"16049281","cha_name":"keyboards","view_count":4920184300},{"cid":"15981120","cha_name":"desksetup","view_count":12840192000}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"region","in":"query","required":false,"description":"Two-letter country code for egress and storefront.","schema":{"type":"string"},"example":"US"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/sticker":{"get":{"operationId":"sticker","summary":"Effect","description":"An effect and its stats.\n\nUpstream: /aweme/v1/sticker/detail/.\n\nCost: 5 credits (standard tier). Failed calls are not charged.","tags":["Series, sounds, hashtags & places"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/aweme/v1/sticker/detail/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/sticker"],"x-docs":"https://tikultra.com/docs/api/sticker","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"sticker_id":"7341928374619283745","name":"35mm Film Grain","user_count":284910,"owner_nickname":"TikTok Effects"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"sticker_id","in":"query","required":true,"description":"The effect ID.","schema":{"type":"string"},"example":"7341928374619283745"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/poi":{"get":{"operationId":"poi","summary":"Place","description":"A place, its reviews and videos tagged there.\n\nUpstream: /tiktok/poi/get/v1, /tiktok/poi/review/get/v2.\n\nCost: 5 credits (standard tier). Failed calls are not charged.","tags":["Series, sounds, hashtags & places"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/tiktok/poi/get/v1","/tiktok/poi/review/get/v2"],"x-access":"public","x-legacy-aliases":["/v1/scrape/poi"],"x-docs":"https://tikultra.com/docs/api/poi","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"poi_id":"22535865203049849","name":"Wynwood Walls","address":"2516 NW 2nd Ave, Miami, FL 33127","city":"Miami","country_code":"US","location":{"lat":25.8011,"lon":-80.1994},"video_count":94210,"rating":4.7,"items":[{"aweme_id":"7705852133855161377","desc":"Launch film, 1080p60 master #keyboards #desksetup","create_time":1762622512,"region":"US","author":{"uid":"6970000000000000001","unique_id":"acme","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","nickname":"Acme Studio","follower_count":128431,"verified":false},"stats":{"play_count":1482906,"digg_count":96442,"comment_count":1318,"share_count":4877,"collect_count":2210,"repost_count":614},"music":{"id":"7569924403851462401","title":"original sound - acme","author":"Acme Studio","duration_sec":31},"video":{"codec":"bytevc1","width":1080,"height":1920,"fps":60,"duration_ms":31840,"bitrate_bps":3842100,"play_url":"https://v16-webapp-prime.tiktok.com/video/tos/useast2a/tos-useast2a-pve-0068/oQ8kLmN2xR9pV/?a=1233","cover_url":"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/o8kLmN2xR9pV~tplv-tiktokx-origin.image"}}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"poi_id","in":"query","required":true,"description":"The place ID.","schema":{"type":"string"},"example":"22535865203049849"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/aistyle":{"get":{"operationId":"aistyle","summary":"AI style","description":"An AI style effect.\n\nUpstream: /tiktok/v1/aistyle/detail.\n\nCost: 5 credits (standard tier). Failed calls are not charged.","tags":["Series, sounds, hashtags & places"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/tiktok/v1/aistyle/detail"],"x-access":"public","x-legacy-aliases":["/v1/scrape/aistyle"],"x-docs":"https://tikultra.com/docs/api/aistyle","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"style_id":"7410001112223334445","name":"Claymation Studio","usage_count":512900}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"style_id","in":"query","required":true,"description":"The style ID.","schema":{"type":"string"},"example":"7410001112223334445"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/aistyle/videos":{"get":{"operationId":"aistyleVideos","summary":"AI style videos","description":"Videos made with an AI style.\n\nUpstream: /tiktok/v1/aistyle/aweme.\n\nCost: 5 credits (standard tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Series, sounds, hashtags & places"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/tiktok/v1/aistyle/aweme"],"x-access":"public","x-paginated":true,"x-docs":"https://tikultra.com/docs/api/aistyle-videos","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":"20","has_more":true,"items":[{"aweme_id":"7705852133855161377","desc":"Launch film, 1080p60 master #keyboards #desksetup","create_time":1762622512,"region":"US","author":{"uid":"6970000000000000001","unique_id":"acme","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","nickname":"Acme Studio","follower_count":128431,"verified":false},"stats":{"play_count":1482906,"digg_count":96442,"comment_count":1318,"share_count":4877,"collect_count":2210,"repost_count":614},"music":{"id":"7569924403851462401","title":"original sound - acme","author":"Acme Studio","duration_sec":31},"video":{"codec":"bytevc1","width":1080,"height":1920,"fps":60,"duration_ms":31840,"bitrate_bps":3842100,"play_url":"https://v16-webapp-prime.tiktok.com/video/tos/useast2a/tos-useast2a-pve-0068/oQ8kLmN2xR9pV/?a=1233","cover_url":"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/o8kLmN2xR9pV~tplv-tiktokx-origin.image"}}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"style_id","in":"query","required":true,"description":"The style ID.","schema":{"type":"string"},"example":"7410001112223334445"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/capcut/template":{"get":{"operationId":"capcutTemplate","summary":"CapCut template","description":"A CapCut template.\n\nUpstream: /tiktok/v1/capcut/template/.\n\nCost: 5 credits (standard tier). Failed calls are not charged.","tags":["Series, sounds, hashtags & places"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/tiktok/v1/capcut/template/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/capcut"],"x-docs":"https://tikultra.com/docs/api/capcut-template","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"template_id":"7398112233445566778","title":"Beat-Sync Product Showcase","slot_count":6,"duration_ms":14200,"usage_count":192400,"author":"Acme Templates"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"template_id","in":"query","required":true,"description":"The template ID.","schema":{"type":"string"},"example":"7398112233445566778"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/capcut/videos":{"get":{"operationId":"capcutVideos","summary":"CapCut template videos","description":"Videos made from a CapCut template.\n\nUpstream: /tiktok/v1/capcut/template/.\n\nCost: 5 credits (standard tier). Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Series, sounds, hashtags & places"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/tiktok/v1/capcut/template/"],"x-access":"public","x-paginated":true,"x-docs":"https://tikultra.com/docs/api/capcut-videos","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":"20","has_more":true,"items":[{"aweme_id":"7705852133855161377","desc":"Launch film, 1080p60 master #keyboards #desksetup","create_time":1762622512,"region":"US","author":{"uid":"6970000000000000001","unique_id":"acme","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","nickname":"Acme Studio","follower_count":128431,"verified":false},"stats":{"play_count":1482906,"digg_count":96442,"comment_count":1318,"share_count":4877,"collect_count":2210,"repost_count":614},"music":{"id":"7569924403851462401","title":"original sound - acme","author":"Acme Studio","duration_sec":31},"video":{"codec":"bytevc1","width":1080,"height":1920,"fps":60,"duration_ms":31840,"bitrate_bps":3842100,"play_url":"https://v16-webapp-prime.tiktok.com/video/tos/useast2a/tos-useast2a-pve-0068/oQ8kLmN2xR9pV/?a=1233","cover_url":"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/o8kLmN2xR9pV~tplv-tiktokx-origin.image"}}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"template_id","in":"query","required":true,"description":"The template ID.","schema":{"type":"string"},"example":"7398112233445566778"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/mv-template":{"get":{"operationId":"mvTemplate","summary":"MV template","description":"A photo-to-video (MV) template.\n\nUpstream: /aweme/v1/mv/detail/.\n\nCost: 5 credits (standard tier). Failed calls are not charged.","tags":["Series, sounds, hashtags & places"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/aweme/v1/mv/detail/"],"x-access":"public","x-legacy-aliases":["/v1/scrape/mv-template"],"x-docs":"https://tikultra.com/docs/api/mv-template","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"template_id":"7398112233445566778","name":"Clean Carousel Cut","min_photos":2,"max_photos":12,"usage_count":74800}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"template_id","in":"query","required":true,"description":"The template ID.","schema":{"type":"string"},"example":"7398112233445566778"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/translate":{"get":{"operationId":"translate","summary":"Translate","description":"TikTok's own translation of a caption or comment.\n\nUpstream: /aweme/v1/content/translation/.\n\nCost: 5 credits (standard tier). Failed calls are not charged.","tags":["Series, sounds, hashtags & places"],"x-credits":5,"x-tier":"standard","x-upstream-paths":["/aweme/v1/content/translation/"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/translate","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"source_text":"Dónde lo compraste?","translated_text":"Where did you buy it?","source_lang":"es","target_lang":"en"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"text","in":"query","required":true,"description":"The text to translate.","schema":{"type":"string"},"example":"Dónde lo compraste?"},{"name":"target","in":"query","required":false,"description":"Target language.","schema":{"type":"string"},"example":"en"},{"$ref":"#/components/parameters/os"},{"$ref":"#/components/parameters/app_flavour"},{"$ref":"#/components/parameters/app_version"}]}},"/v1/account/import":{"post":{"operationId":"importSession","summary":"Import session","description":"Bind a session you own to a dedicated mobile context.\n\nUpstream: /passport/account/info/v2/, /aweme/v1/user/profile/self/.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["Connected sessions"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/passport/account/info/v2/","/aweme/v1/user/profile/self/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/import-session","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"account_id":"acc_7Hq2","status":"connected","health":"healthy","uid":"6970000000000000001","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","username":"acme","nickname":"Acme Studio","device":{"device_id":"7392011847562901234","os":"android","app_flavour":"tiktok","app_version":"47.6.3","region":"US","city":"miami","pool":"FullPool"}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"session_id":{"type":"string","description":"The sessionid or sid_tt value exported from your device."},"cookies":{"type":"object","description":"Optional full cookie map from your device."},"device_id":{"type":"string","description":"Bind to a device you already provisioned. Omit to provision one."},"os":{"type":"string","enum":["android","ios"],"description":"android or ios."},"app_flavour":{"type":"string","enum":["tiktok","lite","lite_coin","pro","studio","shop","tv","douyin"],"description":"Which app to run as."},"app_version":{"type":"string","description":"A release of that app. Defaults to the current default for (os, app_flavour)."},"region":{"type":"string","description":"Two-letter country code for egress and storefront."},"city":{"type":"string","description":"A city in that region. See the supported cities list."}},"required":["session_id"]},"example":{"session_id":"7f8e9d0c1b2a3f4e5d6c7b8a9f0e1d2c","cookies":{"sessionid":"7f8e9d0c1b2a3f4e5d6c7b8a9f0e1d2c","tt-target-idc":"useast5"},"os":"android","app_flavour":"tiktok","app_version":"47.6.3","region":"US","city":"miami"}}}}}},"/v1/account/login/otp/send":{"post":{"operationId":"otpSend","summary":"Email sign-in: send code","description":"Send a one-time sign-in code to your account’s email.\n\nUpstream: /passport/email/send_code/.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["Connected sessions"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/passport/email/send_code/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/otp-send","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"status":"code_sent","email":"you@example.com","expires_in_sec":300,"device_id":"7392011847562901234"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"The email on the account."},"os":{"type":"string","enum":["android","ios"],"description":"android or ios."},"app_flavour":{"type":"string","enum":["tiktok","lite","lite_coin","pro","studio","shop","tv","douyin"],"description":"Which app to run as."},"app_version":{"type":"string","description":"A release of that app. Defaults to the current default for (os, app_flavour)."},"region":{"type":"string","description":"Two-letter country code for egress and storefront."},"city":{"type":"string","description":"A city in that region. See the supported cities list."}},"required":["email"]},"example":{"email":"you@example.com","region":"US"}}}}}},"/v1/account/login/otp/verify":{"post":{"operationId":"otpVerify","summary":"Email sign-in: verify code","description":"Finish signing in with the one-time code.\n\nUpstream: /passport/email/login/.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["Connected sessions"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/passport/email/login/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/otp-verify","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"account_id":"acc_7Hq2","status":"authenticated","uid":"6970000000000000001","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","username":"acme","device_id":"7392011847562901234"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"The same email."},"code":{"type":"string","description":"The code from the email."}},"required":["email","code"]},"example":{"email":"you@example.com","code":"482913"}}}}}},"/v1/account/session":{"post":{"operationId":"sessionState","summary":"Refresh session","description":"Refresh a session and return its state.\n\nUpstream: /passport/account/info/v2/.\n\nCost: 25 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":25,"x-tier":null,"x-upstream-paths":["/passport/account/info/v2/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/session-state","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"account_id":"acc_7Hq2","health":"healthy","session_active":true,"uid":"6970000000000000001","username":"acme","token_beat":"ok","refreshed_at":"2026-11-11T23:30:00Z"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."}},"required":["account_id"]},"example":{"account_id":"acc_7Hq2"}}}}}},"/v1/account/health":{"get":{"operationId":"accountHealth","summary":"Session health","description":"Whether a session is healthy, needs a refresh or has expired.\n\nUpstream: /passport/account/info/v2/.\n\nCost: 15 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":15,"x-tier":null,"x-upstream-paths":["/passport/account/info/v2/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/account-health","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"account_id":"acc_7Hq2","health":"healthy","authenticated":true,"uid":"6970000000000000001","username":"acme","device_id":"7392011847562901234","checked_at":"2026-11-11T23:30:00Z"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"account_id","in":"query","required":true,"description":"A connected account, from /dash/sessions or POST /v1/account/import.","schema":{"type":"string"},"example":"acc_7Hq2"}]}},"/v1/account/warm/niche":{"post":{"operationId":"warmNiche","summary":"Warm session for niche","description":"Calibrate a connected session’s For You feed toward a topic.\n\nUpstream: /aweme/v1/feed/, /aweme/v1/general/search/single/.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["Connected sessions"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/aweme/v1/feed/","/aweme/v1/general/search/single/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/warm-niche","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"account_id":"acc_7Hq2","niche":"mechanical keyboards","videos_dwelled":9,"searches_run":2,"warm_tier":"seasoned","took_ms":44120}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"niche":{"type":"string","description":"Topic or keyword cluster to calibrate toward."},"duration_sec":{"type":"integer","description":"Warming window in seconds."}},"required":["account_id","niche"]},"example":{"account_id":"acc_7Hq2","niche":"mechanical keyboards","duration_sec":45}}}}}},"/v1/account/upload/precheck":{"get":{"operationId":"uploadPrecheck","summary":"Upload precheck","description":"Check direct-post eligibility and duration limits before uploading.\n\nUpstream: /tiktok/v1/infringement/precheck/.\n\nCost: 15 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":15,"x-tier":null,"x-upstream-paths":["/tiktok/v1/infringement/precheck/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/upload-precheck","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"account_id":"acc_7Hq2","can_post":true,"max_video_duration_sec":600,"direct_post_quota_remaining":15,"infringement_status":"clear"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"account_id","in":"query","required":true,"description":"A connected account, from /dash/sessions or POST /v1/account/import.","schema":{"type":"string"},"example":"acc_7Hq2"}]}},"/v1/account/upload/video":{"post":{"operationId":"uploadVideo","summary":"Publish video","description":"Upload and publish in one request. The gateway gets the upload authorization, transfers the file in chunks, runs the media precheck and creates the post. Send multipart/form-data with a file, or JSON with video_url or video_base64.\n\nUpstream: /aweme/v1/upload/authkey/, /tiktok/v1/infringement/precheck/, /aweme/v1/create/aweme/.\n\nCost: 100 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":100,"x-tier":null,"x-upstream-paths":["/aweme/v1/upload/authkey/","/tiktok/v1/infringement/precheck/","/aweme/v1/create/aweme/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/upload-video","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"aweme_id":"7705852133855161377","status":"published","visibility":"public","share_url":"https://www.tiktok.com/@acme/video/7705852133855161377","steps":{"authorize_ms":182,"transfer_ms":2840,"precheck_ms":410,"create_ms":366}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"file":{"type":"string","format":"binary","description":"The .mp4 or .mov file (multipart only)."},"video_url":{"type":"string","description":"Or a URL to fetch the video from."},"video_base64":{"type":"string","description":"Or the video as base64."},"caption":{"type":"string","description":"The caption."},"hashtags":{"type":"array","items":{"type":"string"},"description":"Hashtags, without the #."},"mentions":{"type":"array","items":{"type":"string"},"description":"Usernames to mention."},"visibility":{"type":"string","enum":["public","friends","private"],"description":"Who can see it."},"allow_comment":{"type":"boolean","description":"Allow comments."},"allow_duet":{"type":"boolean","description":"Allow duets."},"allow_stitch":{"type":"boolean","description":"Allow stitches."},"allow_download":{"type":"boolean","description":"Allow downloads."},"cover_timestamp_ms":{"type":"integer","description":"Frame to use as the cover."},"poi_id":{"type":"string","description":"Tag a place."},"music_id":{"type":"string","description":"Use a sound."},"schedule_time":{"type":"integer","description":"Publish later, as Unix seconds."},"aigc_generated":{"type":"boolean","description":"Label the post as AI-generated."},"shop_product_ids":{"type":"array","items":{"type":"string"},"description":"Products to anchor."},"os":{"type":"string","enum":["android","ios"],"description":"android or ios."},"app_flavour":{"type":"string","enum":["tiktok","lite","lite_coin","pro","studio","shop","tv","douyin"],"description":"Which app to run as."},"app_version":{"type":"string","description":"A release of that app. Defaults to the current default for (os, app_flavour)."}},"required":["account_id"]}},"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"video_url":{"type":"string","description":"Or a URL to fetch the video from."},"video_base64":{"type":"string","description":"Or the video as base64."},"caption":{"type":"string","description":"The caption."},"hashtags":{"type":"array","items":{"type":"string"},"description":"Hashtags, without the #."},"mentions":{"type":"array","items":{"type":"string"},"description":"Usernames to mention."},"visibility":{"type":"string","enum":["public","friends","private"],"description":"Who can see it."},"allow_comment":{"type":"boolean","description":"Allow comments."},"allow_duet":{"type":"boolean","description":"Allow duets."},"allow_stitch":{"type":"boolean","description":"Allow stitches."},"allow_download":{"type":"boolean","description":"Allow downloads."},"cover_timestamp_ms":{"type":"integer","description":"Frame to use as the cover."},"poi_id":{"type":"string","description":"Tag a place."},"music_id":{"type":"string","description":"Use a sound."},"schedule_time":{"type":"integer","description":"Publish later, as Unix seconds."},"aigc_generated":{"type":"boolean","description":"Label the post as AI-generated."},"shop_product_ids":{"type":"array","items":{"type":"string"},"description":"Products to anchor."},"os":{"type":"string","enum":["android","ios"],"description":"android or ios."},"app_flavour":{"type":"string","enum":["tiktok","lite","lite_coin","pro","studio","shop","tv","douyin"],"description":"Which app to run as."},"app_version":{"type":"string","description":"A release of that app. Defaults to the current default for (os, app_flavour)."}},"required":["account_id"]},"example":{"account_id":"acc_7Hq2","video_url":"https://example.com/launch.mp4","caption":"Launch film","hashtags":["keyboards"],"visibility":"public","allow_comment":true,"allow_duet":true,"allow_stitch":true,"cover_timestamp_ms":1200}}}}}},"/v1/account/upload/slideshow":{"post":{"operationId":"uploadSlideshow","summary":"Publish slideshow","description":"Upload and publish a photo carousel in one call.\n\nUpstream: /aweme/v1/upload/authkey/, /aweme/v1/create/photo/.\n\nCost: 100 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":100,"x-tier":null,"x-upstream-paths":["/aweme/v1/upload/authkey/","/aweme/v1/create/photo/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/upload-slideshow","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"aweme_id":"7705852133855161378","status":"published","is_photo_mode":true,"image_count":2,"share_url":"https://www.tiktok.com/@acme/photo/7705852133855161378","steps":{"authorize_ms":164,"transfer_ms":1190,"create_ms":328}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"files[]":{"type":"array","items":{"type":"string"},"description":"Images, in order (multipart only)."},"images":{"type":"array","items":{"type":"string"},"description":"Or image URLs or base64, in order."},"title":{"type":"string","description":"The title."},"caption":{"type":"string","description":"The caption."},"music_id":{"type":"string","description":"Use a sound."},"visibility":{"type":"string","enum":["public","friends","private"],"description":"Who can see it."},"allow_comment":{"type":"boolean","description":"Allow comments."},"poi_id":{"type":"string","description":"Tag a place."}},"required":["account_id"]}},"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"images":{"type":"array","items":{"type":"string"},"description":"Or image URLs or base64, in order."},"title":{"type":"string","description":"The title."},"caption":{"type":"string","description":"The caption."},"music_id":{"type":"string","description":"Use a sound."},"visibility":{"type":"string","enum":["public","friends","private"],"description":"Who can see it."},"allow_comment":{"type":"boolean","description":"Allow comments."},"poi_id":{"type":"string","description":"Tag a place."}},"required":["account_id"]},"example":{"account_id":"acc_7Hq2","images":["https://example.com/1.jpg","https://example.com/2.jpg"],"caption":"Desk setup","visibility":"public"}}}}}},"/v1/account/upload/delete":{"post":{"operationId":"deletePost","summary":"Delete post","description":"Delete one of your posts.\n\nUpstream: /aweme/v1/aweme/delete/.\n\nCost: 15 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":15,"x-tier":null,"x-upstream-paths":["/aweme/v1/aweme/delete/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/delete-post","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"aweme_id":"7705852133855161377","deleted":true}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"aweme_id":{"type":"string","description":"The post."}},"required":["account_id","aweme_id"]},"example":{"account_id":"acc_7Hq2","aweme_id":"7705852133855161377"}}}}}},"/v1/account/post/visibility":{"post":{"operationId":"postVisibility","summary":"Post visibility","description":"Change who can see one of your posts.\n\nUpstream: /aweme/v1/aweme/modify/visibility/.\n\nCost: 15 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":15,"x-tier":null,"x-upstream-paths":["/aweme/v1/aweme/modify/visibility/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/post-visibility","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"aweme_id":"7705852133855161377","visibility":"private","updated":true}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"aweme_id":{"type":"string","description":"The post."},"visibility":{"type":"string","enum":["public","friends","private"],"description":"public, friends or private."}},"required":["account_id","aweme_id","visibility"]},"example":{"account_id":"acc_7Hq2","aweme_id":"7705852133855161377","visibility":"private"}}}}}},"/v1/account/upload/places":{"get":{"operationId":"uploadPlaces","summary":"Places for a post","description":"Search places to tag on a post.\n\nUpstream: /tiktok/poi/api/place/search.\n\nCost: 15 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":15,"x-tier":null,"x-upstream-paths":["/tiktok/poi/api/place/search"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/upload-places","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"keyword":"miami beach","items":[{"poi_id":"22535865203049849","name":"Wynwood Walls","address":"2516 NW 2nd Ave, Miami, FL"},{"poi_id":"22535865203049850","name":"South Pointe Park Pier","address":"1 Washington Ave, Miami Beach, FL"}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"account_id","in":"query","required":true,"description":"A connected account, from /dash/sessions or POST /v1/account/import.","schema":{"type":"string"},"example":"acc_7Hq2"},{"name":"keyword","in":"query","required":true,"description":"What to search for.","schema":{"type":"string"},"example":"miami beach"}]}},"/v1/account/profile/update":{"post":{"operationId":"profileUpdate","summary":"Update profile","description":"Change your nickname, bio or links.\n\nUpstream: /aweme/v1/commit/user/.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["Connected sessions"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/aweme/v1/commit/user/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/profile-update","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"account_id":"acc_7Hq2","updated":true,"user":{"uid":"6970000000000000001","unique_id":"acme","nickname":"Acme Studio","signature":"Custom mechanical keyboards · Miami","bio_url":"https://acme.example.com"}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"nickname":{"type":"string","description":"Display name."},"signature":{"type":"string","description":"Bio."},"bio_url":{"type":"string","description":"Link in bio."}},"required":["account_id"]},"example":{"account_id":"acc_7Hq2","nickname":"Acme Studio","signature":"Custom mechanical keyboards · Miami","bio_url":"https://acme.example.com"}}}}}},"/v1/account/profile/username":{"post":{"operationId":"profileUsername","summary":"Change username","description":"Change your @username.\n\nUpstream: /passport/login_name/update/.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["Connected sessions"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/passport/login_name/update/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/profile-username","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"account_id":"acc_7Hq2","unique_id":"acme_labs","updated":true,"next_change_allowed_at":"2026-12-11T23:30:00Z"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"unique_id":{"type":"string","description":"The new handle."}},"required":["account_id","unique_id"]},"example":{"account_id":"acc_7Hq2","unique_id":"acme_labs"}}}}}},"/v1/account/profile/avatar":{"post":{"operationId":"profileAvatar","summary":"Change avatar","description":"Upload a new profile picture.\n\nUpstream: /aweme/v1/upload/image/.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["Connected sessions"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/aweme/v1/upload/image/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/profile-avatar","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"account_id":"acc_7Hq2","updated":true,"avatar_uri":"tos-maliva-avt-0068/acme_new_1080x1080"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"image_url":{"type":"string","description":"The image."}},"required":["account_id","image_url"]},"example":{"account_id":"acc_7Hq2","image_url":"https://example.com/avatar.jpg"}}}}}},"/v1/account/profile/privacy":{"post":{"operationId":"profilePrivacy","summary":"Privacy settings","description":"Private account, who can comment, duet, stitch or message.\n\nUpstream: /tiktok/privacy/user/settings/update/v1.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["Connected sessions"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/tiktok/privacy/user/settings/update/v1"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/profile-privacy","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"account_id":"acc_7Hq2","updated":true,"settings":{"private_account":false,"comment":0,"duet":0,"stitch":0,"direct_message":0}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"settings":{"type":"object","description":"The settings to change."}},"required":["account_id","settings"]},"example":{"account_id":"acc_7Hq2","settings":{"private_account":false,"comment":0,"duet":0,"stitch":0,"direct_message":0}}}}}}},"/v1/account/settings":{"post":{"operationId":"accountSettings","summary":"App settings","description":"Change account settings.\n\nUpstream: /aweme/v1/user/set/settings/.\n\nCost: 15 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":15,"x-tier":null,"x-upstream-paths":["/aweme/v1/user/set/settings/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/account-settings","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"account_id":"acc_7Hq2","updated":true}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"settings":{"type":"object","description":"The settings to change."}},"required":["account_id","settings"]},"example":{"account_id":"acc_7Hq2","settings":{"language":"en","content_preferences_personalized":true}}}}}}},"/v1/account/wellbeing":{"post":{"operationId":"wellbeing","summary":"Digital wellbeing","description":"Screen time and restricted mode settings.\n\nUpstream: /tiktok/v1/digital_wellbeing/settings/.\n\nCost: 15 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":15,"x-tier":null,"x-upstream-paths":["/tiktok/v1/digital_wellbeing/settings/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/wellbeing","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"account_id":"acc_7Hq2","updated":true,"settings":{"screen_time_daily_minutes":90,"restricted_mode":false}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"settings":{"type":"object","description":"The settings to change."}},"required":["account_id","settings"]},"example":{"account_id":"acc_7Hq2","settings":{"screen_time_daily_minutes":90,"restricted_mode":false}}}}}}},"/v1/account/comment":{"post":{"operationId":"comment","summary":"Post comment","description":"Comment, or reply to a comment on your posts.\n\nUpstream: /aweme/v1/comment/publish/.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["Connected sessions"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/aweme/v1/comment/publish/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/comment","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"cid":"7705860099988877799","aweme_id":"7705852133855161377","text":"Thanks for watching!","status":"published","create_time":1762900100}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"aweme_id":{"type":"string","description":"The post."},"text":{"type":"string","description":"The comment."},"reply_to_comment_id":{"type":"string","description":"Reply to this comment."}},"required":["account_id","aweme_id","text"]},"example":{"account_id":"acc_7Hq2","aweme_id":"7705852133855161377","text":"Thanks for watching!"}}}}}},"/v1/account/comment/like":{"post":{"operationId":"commentLike","summary":"Like comment","description":"Heart a comment on your post.\n\nUpstream: /aweme/v1/comment/digg/.\n\nCost: 15 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":15,"x-tier":null,"x-upstream-paths":["/aweme/v1/comment/digg/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/comment-like","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"aweme_id":"7705852133855161377","comment_id":"7705860011122233344","liked":true}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"aweme_id":{"type":"string","description":"The post."},"comment_id":{"type":"string","description":"The comment."}},"required":["account_id","aweme_id","comment_id"]},"example":{"account_id":"acc_7Hq2","aweme_id":"7705852133855161377","comment_id":"7705860011122233344"}}}}}},"/v1/account/comment/unlike":{"post":{"operationId":"commentUnlike","summary":"Unlike comment","description":"Remove a heart from a comment.\n\nUpstream: /aweme/v1/comment/digg/.\n\nCost: 15 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":15,"x-tier":null,"x-upstream-paths":["/aweme/v1/comment/digg/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/comment-unlike","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"aweme_id":"7705852133855161377","comment_id":"7705860011122233344","liked":false}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"aweme_id":{"type":"string","description":"The post."},"comment_id":{"type":"string","description":"The comment."}},"required":["account_id","aweme_id","comment_id"]},"example":{"account_id":"acc_7Hq2","aweme_id":"7705852133855161377","comment_id":"7705860011122233344"}}}}}},"/v1/account/comment/delete":{"post":{"operationId":"commentDelete","summary":"Delete comment","description":"Delete a comment on your post, or one you wrote.\n\nUpstream: /aweme/v1/comment/delete/.\n\nCost: 15 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":15,"x-tier":null,"x-upstream-paths":["/aweme/v1/comment/delete/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/comment-delete","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"comment_id":"7705860011122233344","deleted":true}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"comment_id":{"type":"string","description":"The comment."}},"required":["account_id","comment_id"]},"example":{"account_id":"acc_7Hq2","comment_id":"7705860011122233344"}}}}}},"/v1/account/dm/inbox":{"get":{"operationId":"inbox","summary":"Inbox","description":"New messages across conversations.\n\nUpstream: /im/v1/messages/get_by_user.\n\nCost: 20 cr. Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Connected sessions"],"x-credits":20,"x-tier":null,"x-upstream-paths":["/im/v1/messages/get_by_user"],"x-access":"growth","x-paginated":true,"x-docs":"https://tikultra.com/docs/api/inbox","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":null,"has_more":false,"items":[{"message_id":"7705865000111222333","conversation_id":"0:1:6970000000000000001:6970000000000000002","sender_uid":"6970000000000000002","sender_username":"kbfan","type":"text","text":"Hey! Would love to review the new 75% build.","create_time":1762900020}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"account_id","in":"query","required":true,"description":"A connected account, from /dash/sessions or POST /v1/account/import.","schema":{"type":"string"},"example":"acc_7Hq2"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}}]}},"/v1/account/dm/conversation/list":{"get":{"operationId":"dmConversations","summary":"Conversations","description":"Your conversations, newest first.\n\nUpstream: /im/v1/conversation/get_list.\n\nCost: 20 cr. Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Connected sessions"],"x-credits":20,"x-tier":null,"x-upstream-paths":["/im/v1/conversation/get_list"],"x-access":"growth","x-paginated":true,"x-docs":"https://tikultra.com/docs/api/dm-conversations","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":null,"has_more":false,"items":[{"conversation_id":"0:1:6970000000000000001:6970000000000000002","peer":{"uid":"6970000000000000002","unique_id":"kbfan","nickname":"KB Fan"},"unread_count":1,"last_message_preview":"Hey! Would love to review the new 75% build.","updated_at":1762900020}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"account_id","in":"query","required":true,"description":"A connected account, from /dash/sessions or POST /v1/account/import.","schema":{"type":"string"},"example":"acc_7Hq2"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"}]}},"/v1/account/dm/conversation/messages":{"get":{"operationId":"dmMessages","summary":"Conversation messages","description":"Messages in one conversation.\n\nUpstream: /im/v1/messages/get_by_user.\n\nCost: 20 cr. Failed calls are not charged.\n\nPaginated: pass `cursor` and read `cursor` and `has_more` at the top level of the response.","tags":["Connected sessions"],"x-credits":20,"x-tier":null,"x-upstream-paths":["/im/v1/messages/get_by_user"],"x-access":"growth","x-paginated":true,"x-docs":"https://tikultra.com/docs/api/dm-messages","responses":{"200":{"description":"A page. `cursor` and `has_more` are always at the top level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"example":{"cursor":null,"has_more":false,"items":[{"message_id":"7705865000111222333","conversation_id":"0:1:6970000000000000001:6970000000000000002","sender_uid":"6970000000000000002","type":"text","text":"Hey! Would love to review the new 75% build.","create_time":1762900020}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"account_id","in":"query","required":true,"description":"A connected account, from /dash/sessions or POST /v1/account/import.","schema":{"type":"string"},"example":"acc_7Hq2"},{"name":"conversation_id","in":"query","required":true,"description":"The conversation.","schema":{"type":"string"},"example":"0:1:6970000000000000001:6970000000000000002"},{"name":"cursor","in":"query","required":false,"description":"The cursor from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Items per page.","schema":{"type":"integer"},"example":"20"}]}},"/v1/account/dm/conversation/create":{"post":{"operationId":"dmCreate","summary":"Start conversation","description":"Open a conversation with someone.\n\nUpstream: /im/v1/conversation/create_v2.\n\nCost: 20 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":20,"x-tier":null,"x-upstream-paths":["/im/v1/conversation/create_v2"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/dm-create","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"conversation_id":"0:1:6970000000000000001:6970000000000000002","peer_username":"kbfan","created":true}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"to":{"type":"string","description":"Their @username."}},"required":["account_id","to"]},"example":{"account_id":"acc_7Hq2","to":"kbfan"}}}}}},"/v1/account/dm/conversation/read":{"post":{"operationId":"dmRead","summary":"Mark read","description":"Mark a conversation as read.\n\nUpstream: /im/v1/conversation/mark_read.\n\nCost: 20 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":20,"x-tier":null,"x-upstream-paths":["/im/v1/conversation/mark_read"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/dm-read","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"conversation_id":"0:1:6970000000000000001:6970000000000000002","marked_read":true}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"conversation_id":{"type":"string","description":"The conversation."}},"required":["account_id","conversation_id"]},"example":{"account_id":"acc_7Hq2","conversation_id":"0:1:6970000000000000001:6970000000000000002"}}}}}},"/v1/account/dm/send":{"post":{"operationId":"sendDm","summary":"Send message","description":"Send a text message.\n\nUpstream: /im/v1/message/send.\n\nCost: 35 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":35,"x-tier":null,"x-upstream-paths":["/im/v1/message/send"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/send-dm","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"message_id":"7705865000111222400","conversation_id":"0:1:6970000000000000001:6970000000000000002","status":"sent","create_time":1762900150}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"conversation_id":{"type":"string","description":"The conversation."},"to":{"type":"string","description":"Or their @username."},"text":{"type":"string","description":"The message."}},"required":["account_id","text"]},"example":{"account_id":"acc_7Hq2","to":"kbfan","text":"Thanks for the collab!"}}}}}},"/v1/account/dm/send-image":{"post":{"operationId":"dmSendImage","summary":"Send image","description":"Send an image.\n\nUpstream: /im/v1/message/send.\n\nCost: 35 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":35,"x-tier":null,"x-upstream-paths":["/im/v1/message/send"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/dm-send-image","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"message_id":"7705865000111222401","conversation_id":"0:1:6970000000000000001:6970000000000000002","type":"image","status":"sent"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"conversation_id":{"type":"string","description":"The conversation."},"image_url":{"type":"string","description":"The image."}},"required":["account_id","conversation_id","image_url"]},"example":{"account_id":"acc_7Hq2","conversation_id":"0:1:6970000000000000001:6970000000000000002","image_url":"https://example.com/a.jpg"}}}}}},"/v1/account/dm/send-voice":{"post":{"operationId":"dmSendVoice","summary":"Send voice note","description":"Send a voice note.\n\nUpstream: /im/v1/message/send.\n\nCost: 35 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":35,"x-tier":null,"x-upstream-paths":["/im/v1/message/send"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/dm-send-voice","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"message_id":"7705865000111222402","conversation_id":"0:1:6970000000000000001:6970000000000000002","type":"audio","duration_ms":6400,"status":"sent"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"conversation_id":{"type":"string","description":"The conversation."},"audio_url":{"type":"string","description":"The audio file."}},"required":["account_id","conversation_id","audio_url"]},"example":{"account_id":"acc_7Hq2","conversation_id":"0:1:6970000000000000001:6970000000000000002","audio_url":"https://example.com/voice.m4a"}}}}}},"/v1/account/dm/reply":{"post":{"operationId":"dmReply","summary":"Reply to message","description":"Reply to a specific message.\n\nUpstream: /im/v1/message/send.\n\nCost: 35 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":35,"x-tier":null,"x-upstream-paths":["/im/v1/message/send"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/dm-reply","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"message_id":"7705865000111222403","reply_to_message_id":"7705865000111222333","conversation_id":"0:1:6970000000000000001:6970000000000000002","status":"sent"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"conversation_id":{"type":"string","description":"The conversation."},"message_id":{"type":"string","description":"The message to reply to."},"text":{"type":"string","description":"The reply."}},"required":["account_id","conversation_id","message_id","text"]},"example":{"account_id":"acc_7Hq2","conversation_id":"0:1:6970000000000000001:6970000000000000002","message_id":"7705865000111222333","text":"Sounds great, shipping Friday!"}}}}}},"/v1/account/dm/sticker":{"post":{"operationId":"dmSticker","summary":"Send sticker","description":"Send a sticker.\n\nUpstream: /im/v1/message/send.\n\nCost: 35 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":35,"x-tier":null,"x-upstream-paths":["/im/v1/message/send"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/dm-sticker","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"message_id":"7705865000111222404","conversation_id":"0:1:6970000000000000001:6970000000000000002","sticker_id":"7341928374619283745","status":"sent"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"conversation_id":{"type":"string","description":"The conversation."},"sticker_id":{"type":"string","description":"The sticker."}},"required":["account_id","conversation_id","sticker_id"]},"example":{"account_id":"acc_7Hq2","conversation_id":"0:1:6970000000000000001:6970000000000000002","sticker_id":"7341928374619283745"}}}}}},"/v1/account/dm/share-video":{"post":{"operationId":"dmShareVideo","summary":"Share video","description":"Share a video in a conversation.\n\nUpstream: /im/v1/message/send.\n\nCost: 35 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":35,"x-tier":null,"x-upstream-paths":["/im/v1/message/send"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/dm-share-video","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"message_id":"7705865000111222405","conversation_id":"0:1:6970000000000000001:6970000000000000002","shared_aweme_id":"7705852133855161377","status":"sent"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"conversation_id":{"type":"string","description":"The conversation."},"aweme_id":{"type":"string","description":"The video."}},"required":["account_id","conversation_id","aweme_id"]},"example":{"account_id":"acc_7Hq2","conversation_id":"0:1:6970000000000000001:6970000000000000002","aweme_id":"7705852133855161377"}}}}}},"/v1/account/dm/react":{"post":{"operationId":"dmReact","summary":"React to message","description":"Add an emoji reaction to a message.\n\nUpstream: /im/v1/message/send.\n\nCost: 15 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":15,"x-tier":null,"x-upstream-paths":["/im/v1/message/send"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/dm-react","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"message_id":"7705865000111222333","emoji":"❤️","status":"applied"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"message_id":{"type":"string","description":"The message."},"emoji":{"type":"string","description":"The reaction."}},"required":["account_id","message_id","emoji"]},"example":{"account_id":"acc_7Hq2","message_id":"7705865000111222333","emoji":"❤️"}}}}}},"/v1/account/dm/recall":{"post":{"operationId":"dmRecall","summary":"Unsend message","description":"Unsend a message you sent.\n\nUpstream: /im/v1/message/send.\n\nCost: 15 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":15,"x-tier":null,"x-upstream-paths":["/im/v1/message/send"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/dm-recall","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"message_id":"7705865000111222333","recalled":true}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"message_id":{"type":"string","description":"The message."}},"required":["account_id","message_id"]},"example":{"account_id":"acc_7Hq2","message_id":"7705865000111222333"}}}}}},"/v1/account/dm/group/info":{"get":{"operationId":"dmGroupInfo","summary":"Group info","description":"A group chat’s name and settings.\n\nUpstream: /im/v1/conversation/get_list.\n\nCost: 20 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":20,"x-tier":null,"x-upstream-paths":["/im/v1/conversation/get_list"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/dm-group-info","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"conversation_id":"0:1:6970000000000000001:6970000000000000002","is_group":true,"name":"Creator Hardware Collective","member_count":14,"owner_uid":"6970000000000000001"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"account_id","in":"query","required":true,"description":"A connected account, from /dash/sessions or POST /v1/account/import.","schema":{"type":"string"},"example":"acc_7Hq2"},{"name":"conversation_id","in":"query","required":true,"description":"The group.","schema":{"type":"string"},"example":"0:1:6970000000000000001:6970000000000000002"}]}},"/v1/account/dm/group/members":{"get":{"operationId":"dmGroupMembers","summary":"Group members","description":"The members of a group chat.\n\nUpstream: /im/v1/conversation/get_list.\n\nCost: 20 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":20,"x-tier":null,"x-upstream-paths":["/im/v1/conversation/get_list"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/dm-group-members","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"conversation_id":"0:1:6970000000000000001:6970000000000000002","members":[{"uid":"6970000000000000001","unique_id":"acme","role":"owner"},{"uid":"6970000000000000002","unique_id":"kbfan","role":"member"}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"account_id","in":"query","required":true,"description":"A connected account, from /dash/sessions or POST /v1/account/import.","schema":{"type":"string"},"example":"acc_7Hq2"},{"name":"conversation_id","in":"query","required":true,"description":"The group.","schema":{"type":"string"},"example":"0:1:6970000000000000001:6970000000000000002"}]}},"/v1/account/dm/streaks":{"get":{"operationId":"dmStreaks","summary":"Streaks","description":"Message streaks with your contacts.\n\nUpstream: /tiktok/v1/im/streaks/info.\n\nCost: 20 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":20,"x-tier":null,"x-upstream-paths":["/tiktok/v1/im/streaks/info"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/dm-streaks","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"account_id":"acc_7Hq2","streaks":[{"peer_username":"kbfan","days":19,"active":true,"expires_at":1762986400}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"account_id","in":"query","required":true,"description":"A connected account, from /dash/sessions or POST /v1/account/import.","schema":{"type":"string"},"example":"acc_7Hq2"}]}},"/v1/account/live/start":{"post":{"operationId":"liveStart","summary":"Start LIVE","description":"Create a LIVE room on your account and get the RTMP ingest.\n\nUpstream: /webcast/room/create/.\n\nCost: 100 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":100,"x-tier":null,"x-upstream-paths":["/webcast/room/create/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/live-start","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"room_id":"7705861000123456789","status":"created","rtmp_push_url":"rtmps://push-rtmp-f5-tt01.fcdn.us.tiktokcdn.com/game/","stream_key":"stream-7705861000123456789?expire=1762986400&sign=8b2f91c4e0"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"title":{"type":"string","description":"The room title."}},"required":["account_id","title"]},"example":{"account_id":"acc_7Hq2","title":"Desk build, part 2"}}}}}},"/v1/account/live/ping":{"post":{"operationId":"livePing","summary":"LIVE heartbeat","description":"Keep your room open while you stream.\n\nUpstream: /webcast/room/ping/anchor/.\n\nCost: 15 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":15,"x-tier":null,"x-upstream-paths":["/webcast/room/ping/anchor/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/live-ping","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"room_id":"7705861000123456789","status":"alive","viewer_count":1842,"next_ping_sec":15}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"room_id":{"type":"string","description":"The numeric LIVE room ID."}},"required":["account_id","room_id"]},"example":{"account_id":"acc_7Hq2","room_id":"7705861000123456789"}}}}}},"/v1/account/live/finish":{"post":{"operationId":"liveFinish","summary":"End LIVE","description":"End your LIVE.\n\nUpstream: /webcast/room/finish/.\n\nCost: 15 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":15,"x-tier":null,"x-upstream-paths":["/webcast/room/finish/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/live-finish","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"room_id":"7705861000123456789","status":"finished","duration_sec":3920,"peak_viewers":2410}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"room_id":{"type":"string","description":"The numeric LIVE room ID."}},"required":["account_id","room_id"]},"example":{"account_id":"acc_7Hq2","room_id":"7705861000123456789"}}}}}},"/v1/account/live/moderate":{"post":{"operationId":"liveModerate","summary":"Moderate LIVE","description":"Post, pin or remove comments and mute viewers in your room.\n\nUpstream: /webcast/room/chat/.\n\nCost: 20 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":20,"x-tier":null,"x-upstream-paths":["/webcast/room/chat/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/live-moderate","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"room_id":"7705861000123456789","action":"comment","status":"ok","msg_id":"7705861999111222900"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"room_id":{"type":"string","description":"The numeric LIVE room ID."},"action":{"type":"string","enum":["comment","pin","delete","mute"],"description":"comment, pin, delete or mute."},"text":{"type":"string","description":"For comment."},"target_id":{"type":"string","description":"The comment or viewer to act on."}},"required":["account_id","room_id","action"]},"example":{"account_id":"acc_7Hq2","room_id":"7705861000123456789","action":"comment","text":"Welcome in!"}}}}}},"/v1/account/live/cohost":{"post":{"operationId":"liveCohost","summary":"Co-host","description":"Invite or accept a co-host in your room.\n\nUpstream: /webcast/room/chat/.\n\nCost: 20 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":20,"x-tier":null,"x-upstream-paths":["/webcast/room/chat/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/live-cohost","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"room_id":"7705861000123456789","invited_username":"kbfan","status":"invite_sent"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"room_id":{"type":"string","description":"The numeric LIVE room ID."},"username":{"type":"string","description":"The co-host."}},"required":["account_id","room_id","username"]},"example":{"account_id":"acc_7Hq2","room_id":"7705861000123456789","username":"kbfan"}}}}}},"/v1/account/live/battle":{"post":{"operationId":"liveBattle","summary":"LIVE match","description":"Start or accept a LIVE match from your room.\n\nUpstream: /webcast/room/chat/.\n\nCost: 20 cr. Failed calls are not charged.","tags":["Connected sessions"],"x-credits":20,"x-tier":null,"x-upstream-paths":["/webcast/room/chat/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/live-battle","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"room_id":"7705861000123456789","opponent":"kbfan","battle_id":"7705868888111222333","status":"invite_sent"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"A connected account, from /dash/sessions or POST /v1/account/import."},"room_id":{"type":"string","description":"The numeric LIVE room ID."},"opponent":{"type":"string","description":"The other host."}},"required":["account_id","room_id","opponent"]},"example":{"account_id":"acc_7Hq2","room_id":"7705861000123456789","opponent":"kbfan"}}}}}},"/v1/account/shop/cart":{"get":{"operationId":"shopCart","summary":"Cart","description":"Your account's Shop cart.\n\nUpstream: /api/v1/shop/cart/get_cart.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["Connected sessions"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/api/v1/shop/cart/get_cart"],"x-access":"growth","x-legacy-aliases":["/v1/shop/cart"],"x-docs":"https://tikultra.com/docs/api/shop-cart","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"account_id":"acc_7Hq2","item_count":1,"subtotal":{"amount":"79.99","currency":"USD"},"items":[{"product_id":"1729384756192837461","sku_id":"1729384756192837462","quantity":1,"title":"Low-profile mechanical keyboard 75%","unit_price":"79.99"}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"account_id","in":"query","required":true,"description":"A connected account, from /dash/sessions or POST /v1/account/import.","schema":{"type":"string"},"example":"acc_7Hq2"}]}},"/v1/account/shop/order-center":{"get":{"operationId":"shopOrderCenter","summary":"Orders","description":"Your account's Shop orders.\n\nUpstream: /api/v1/trade/entrance/get.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["Connected sessions"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/api/v1/trade/entrance/get"],"x-access":"growth","x-legacy-aliases":["/v1/shop/order-center"],"x-docs":"https://tikultra.com/docs/api/shop-order-center","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"account_id":"acc_7Hq2","counts":{"unpaid":0,"to_ship":1,"shipped":2,"completed":14},"recent_orders":[{"order_id":"577102938475619283","status":"shipped","total":"79.99","currency":"USD","carrier":"USPS","created_at":1762790000}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"account_id","in":"query","required":true,"description":"A connected account, from /dash/sessions or POST /v1/account/import.","schema":{"type":"string"},"example":"acc_7Hq2"}]}},"/v1/account/shop/cs":{"get":{"operationId":"shopCs","summary":"Shop support chat","description":"Your conversations with Shop sellers’ support.\n\nUpstream: /api/v1/cs/rt.\n\nCost: 25 credits (premium tier). Failed calls are not charged.","tags":["Connected sessions"],"x-credits":25,"x-tier":"premium","x-upstream-paths":["/api/v1/cs/rt"],"x-access":"growth","x-legacy-aliases":["/v1/shop/cs"],"x-docs":"https://tikultra.com/docs/api/shop-cs","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"account_id":"acc_7Hq2","threads":[{"seller_id":"7495000000000000001","shop_name":"Acme Studio Shop","unread":0,"last_message":"Your tracking number is live—arrives Thursday!"}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"account_id","in":"query","required":true,"description":"A connected account, from /dash/sessions or POST /v1/account/import.","schema":{"type":"string"},"example":"acc_7Hq2"}]}},"/v1/resolve":{"get":{"operationId":"resolve","summary":"Resolve","description":"Resolve a video, profile, LIVE or Shop link (tiktok.com, vm.tiktok.com, vt.tiktok.com) or an @username into typed IDs and the creation time decoded from the Snowflake ID.\n\nUpstream: redirect + /aweme/v1/aweme/detail/.\n\nCost: 2 credits (primitive tier). Failed calls are not charged.","tags":["Devices, signing & primitives"],"x-credits":2,"x-tier":"primitive","x-upstream-paths":["redirect + /aweme/v1/aweme/detail/"],"x-access":"public","x-legacy-aliases":["/v1/tools/deeplink"],"x-docs":"https://tikultra.com/docs/api/resolve","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"kind":"video","canonical_url":"https://www.tiktok.com/@acme/video/7705852133855161377","aweme_id":"7705852133855161377","uid":"6970000000000000001","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","unique_id":"acme","room_id":null,"product_id":null,"music_id":"7569924403851462401","snowflake_timestamp_utc":"2026-11-08T17:21:52Z"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"input","in":"query","required":true,"description":"A link or @username.","schema":{"type":"string"},"example":"https://vm.tiktok.com/ZMh7Kx2Qp/"}]},"post":{"operationId":"resolvePost","summary":"Resolve (POST)","description":"The same resolver, with a JSON body.\n\nUpstream: redirect + /aweme/v1/aweme/detail/.\n\nCost: 2 credits (primitive tier). Failed calls are not charged.","tags":["Devices, signing & primitives"],"x-credits":2,"x-tier":"primitive","x-upstream-paths":["redirect + /aweme/v1/aweme/detail/"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/resolve-post","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"kind":"video","canonical_url":"https://www.tiktok.com/@acme/video/7705852133855161377","aweme_id":"7705852133855161377","uid":"6970000000000000001","sec_uid":"MS4wLjABAAAAq8V3xLm2pR9wQ8mN4vK1zH7tB2yX","unique_id":"acme","room_id":null,"product_id":null,"music_id":"7569924403851462401","snowflake_timestamp_utc":"2026-11-08T17:21:52Z"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"input":{"type":"string","description":"A link or @username."}},"required":["input"]},"example":{"input":"https://vm.tiktok.com/ZMh7Kx2Qp/"}}}}}},"/v1/tools/id-converter":{"get":{"operationId":"idConverter","summary":"ID converter","description":"Snowflake timestamps and uid ↔ sec_uid lookups.\n\nUpstream: local · snowflake + /aweme/v1/user/profile/other/.\n\nCost: 2 credits (primitive tier). Failed calls are not charged.","tags":["Devices, signing & primitives"],"x-credits":2,"x-tier":"primitive","x-upstream-paths":["local · snowflake + /aweme/v1/user/profile/other/"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/id-converter","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"id":"7705852133855161377","is_snowflake":true,"timestamp_ms":1762622512000,"timestamp_utc":"2026-11-08T17:21:52Z","worker_bits":353,"sequence":33}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"id","in":"query","required":false,"description":"Any TikTok ID (video, user, comment, room).","schema":{"type":"string"},"example":"7705852133855161377"},{"name":"username","in":"query","required":false,"description":"A @username to resolve to uid and sec_uid.","schema":{"type":"string"}}]}},"/v1/tools/protobuf-decode":{"post":{"operationId":"protobufDecode","summary":"Protobuf decode","description":"Decode a raw protobuf payload to JSON.\n\nUpstream: local · protobuf decoder.\n\nCost: 2 credits (primitive tier). Failed calls are not charged.","tags":["Devices, signing & primitives"],"x-credits":2,"x-tier":"primitive","x-upstream-paths":["local · protobuf decoder"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/protobuf-decode","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"byte_length":8,"fields":[{"field_number":1,"wire_type":"varint","value":12},{"field_number":2,"wire_type":"bytes_utf8","value":"test"}],"inferred_proto":"message DecodedPayload {\n  int64 field_1 = 1;\n  string field_2 = 2;\n}"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"hex":{"type":"string","description":"The payload as hex."}},"required":["hex"]},"example":{"hex":"080c120474657374"}}}}}},"/v1/jobs/submit":{"post":{"operationId":"submitBatchJob","summary":"Submit batch job","description":"Up to 500 tasks, run async, billed per task.\n\nUpstream: gateway · async batch queue (up to 500 tasks).\n\nCost: per task. Failed calls are not charged.","tags":["Devices, signing & primitives"],"x-credits":null,"x-tier":null,"x-upstream-paths":["gateway · async batch queue (up to 500 tasks)"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/submit-batch-job","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"id":"job_8fK2xQ9mP4","status":"queued","tasks_total":2,"tasks_done":0,"webhook_url":"https://example.com/hooks/tikultra","created_at":"2026-11-11T23:30:00Z"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tasks":{"type":"array","items":{"type":"string"},"description":"Up to 500 tasks, each a path and its query."},"webhook_url":{"type":"string","description":"Called when the job finishes."}},"required":["tasks"]},"example":{"tasks":[{"path":"/v1/video","query":{"aweme_id":"7705852133855161377"}},{"path":"/v1/user","query":{"username":"acme"}}],"webhook_url":"https://example.com/hooks/tikultra"}}}}}},"/v1/jobs/{id}":{"get":{"operationId":"getJob","summary":"Get job","description":"A job’s progress and results.\n\nUpstream: gateway · async batch queue.\n\nCost: Free. Failed calls are not charged.","tags":["Devices, signing & primitives"],"x-credits":0,"x-tier":null,"x-upstream-paths":["gateway · async batch queue"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/get-job","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"id":"job_8fK2xQ9mP4","status":"completed","tasks_total":2,"tasks_done":2,"tasks_failed":0,"credits_charged":10,"results":[{"index":0,"path":"/v1/video","status":200,"credits":5,"data":{"aweme_id":"7705852133855161377","desc":"Launch film, 1080p60 master #keyboards #desksetup"}},{"index":1,"path":"/v1/user","status":200,"credits":5,"data":{"uid":"6970000000000000001","unique_id":"acme"}}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"id","in":"path","required":true,"description":"The job ID.","schema":{"type":"string"},"example":"job_8fK2xQ9mP4"}]}},"/v1/devices":{"get":{"operationId":"listDevices","summary":"List devices","description":"Every device context your keys have provisioned.\n\nUpstream: gateway · context registry.\n\nCost: Free. Failed calls are not charged.","tags":["Devices, signing & primitives"],"x-credits":0,"x-tier":null,"x-upstream-paths":["gateway · context registry"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/list-devices","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"count":1,"global_warm_pool_size":24,"devices":[{"device_id":"7392011847562901234","install_id":"7392011998877665544","os":"android","app_flavour":"tiktok","app_version":"47.6.3","model":"Pixel 8 Pro","region":"US","city":"miami","bootstrapped":true,"warm_tier":"seasoned","report_sequence":5,"sdk_counter":18}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[]}},"/v1/devices/provision":{"post":{"operationId":"provisionDevice","summary":"Provision device","description":"A dedicated mobile device context pinned to a city.\n\nUpstream: /service/2/device_register/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["Devices, signing & primitives"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/service/2/device_register/"],"x-access":"growth","x-legacy-aliases":["/v1/contexts/provision"],"x-docs":"https://tikultra.com/docs/api/provision-device","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"status":"provisioned","device":{"device_id":"7392011847562901234","install_id":"7392011998877665544","os":"android","app_flavour":"tiktok","app_version":"47.6.3","aid":1233,"model":"Pixel 8 Pro","os_version":"14","region":"US","city":"miami","bootstrapped":true,"report_sequence":3}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"os":{"type":"string","enum":["android","ios"],"description":"android or ios."},"app_flavour":{"type":"string","enum":["tiktok","lite","lite_coin","pro","studio","shop","tv","douyin"],"description":"Which app to run as."},"app_version":{"type":"string","description":"A release of that app. Defaults to the current default for (os, app_flavour)."},"region":{"type":"string","description":"Two-letter country code for egress and storefront."},"city":{"type":"string","description":"A city in that region. See the supported cities list."},"hardware_template":{"type":"string","description":"One of 237 Android or 15 iOS hardware profiles. Omit for a random one."}},"required":["region"]},"example":{"os":"android","app_flavour":"tiktok","app_version":"47.6.3","region":"US","city":"miami"}}}}}},"/v1/devices/templates":{"get":{"operationId":"deviceTemplates","summary":"Hardware templates","description":"The 237 Android and 15 iOS hardware profiles.\n\nUpstream: gateway · client & device catalog.\n\nCost: Free. Failed calls are not charged.","tags":["Devices, signing & primitives"],"x-credits":0,"x-tier":null,"x-upstream-paths":["gateway · client & device catalog"],"x-access":"public","x-legacy-aliases":["/v1/contexts/templates"],"x-docs":"https://tikultra.com/docs/api/device-templates","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"total_android":237,"total_ios":15,"templates":[{"id":"google_pixel_8_pro_14","os":"android","brand":"Google","model":"Pixel 8 Pro","os_version":"14","dpi":480,"resolution":"1344x2992"},{"id":"samsung_sm_s928b_14","os":"android","brand":"Samsung","model":"SM-S928B","os_version":"14","dpi":450,"resolution":"1440x3120"},{"id":"iphone16_2_ios18_3","os":"ios","brand":"Apple","model":"iPhone16,2","os_version":"18.3.1","resolution":"1290x2796"}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"os","in":"query","required":false,"description":"android or ios.","schema":{"type":"string","enum":["android","ios"]},"example":"android"}]}},"/v1/apps/versions":{"get":{"operationId":"appVersions","summary":"App versions","description":"Every supported (os, app_flavour, app_version).\n\nUpstream: gateway · client & device catalog.\n\nCost: Free. Failed calls are not charged.","tags":["Devices, signing & primitives"],"x-credits":0,"x-tier":null,"x-upstream-paths":["gateway · client & device catalog"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/app-versions","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"default_client":{"os":"android","app_flavour":"tiktok","app_version":"47.6.3","aid":1233},"clients":[{"os":"android","app_flavour":"tiktok","aid":1233,"default":"47.6.3","versions":["47.7.3","47.7.2","47.6.3","47.5.41"]},{"os":"ios","app_flavour":"tiktok","aid":1233,"default":"47.5.0","versions":["47.5.0","47.4.0","46.9.0"]},{"os":"android","app_flavour":"studio","aid":8660,"default":"44.6.3","versions":["44.6.3","44.6.2"]},{"os":"android","app_flavour":"douyin","aid":1128,"default":"40.8.0","versions":["40.8.0"]}]}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[]}},"/v1/devices/{id}":{"get":{"operationId":"getDevice","summary":"Get device","description":"One device context and its state.\n\nUpstream: gateway · context registry.\n\nCost: Free. Failed calls are not charged.","tags":["Devices, signing & primitives"],"x-credits":0,"x-tier":null,"x-upstream-paths":["gateway · context registry"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/get-device","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"device_id":"7392011847562901234","install_id":"7392011998877665544","os":"android","app_flavour":"tiktok","app_version":"47.6.3","aid":1233,"model":"Pixel 8 Pro","region":"US","city":"miami","bootstrapped":true,"warm_tier":"seasoned","report_sequence":5,"sdk_counter":18}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"id","in":"path","required":true,"description":"The device ID.","schema":{"type":"string"},"example":"7392011847562901234"}]}},"/v1/devices/{id}/bootstrap":{"post":{"operationId":"bootstrapDevice","summary":"Bootstrap device","description":"Register a provisioned device so it is ready for calls.\n\nUpstream: /service/2/device_register/, /service/2/app_alert_check/.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["Devices, signing & primitives"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/service/2/device_register/","/service/2/app_alert_check/"],"x-access":"growth","x-docs":"https://tikultra.com/docs/api/bootstrap-device","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"status":"bootstrapped","context":{"device_id":"7392011847562901234","install_id":"7392011998877665544","bootstrapped":true,"report_sequence":5,"warm_tier":"warm"}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"id","in":"path","required":true,"description":"The device ID.","schema":{"type":"string"},"example":"7392011847562901234"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"warmup":{"type":"boolean","description":"Run initial organic warm-up browse."}},"required":[]},"example":{"warmup":true}}}}}},"/v1/devices/{id}/report":{"post":{"operationId":"deviceReport","summary":"Device security report","description":"Execute scheduled security telemetry scenes on a provisioned device.\n\nUpstream: /sdi/get_seed, /ri/report.\n\nCost: 10 credits (heavy tier). Failed calls are not charged.","tags":["Devices, signing & primitives"],"x-credits":10,"x-tier":"heavy","x-upstream-paths":["/sdi/get_seed","/ri/report"],"x-access":"growth","x-legacy-aliases":["/v1/contexts/{id}/report"],"x-docs":"https://tikultra.com/docs/api/device-report","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"status":"ok","device_id":"7392011847562901234","scene":"full_sequence","executed_reports":["cold_start_112","periodic_100","auto_102"],"report_sequence":6}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"parameters":[{"name":"id","in":"path","required":true,"description":"The device ID.","schema":{"type":"string"},"example":"7392011847562901234"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"scene":{"type":"string","enum":["full_sequence","cold_start","periodic","auto"],"description":"full_sequence, cold_start, periodic, or auto."}},"required":[]},"example":{"scene":"full_sequence"}}}}}},"/v1/crypto/sign":{"post":{"operationId":"signRequest","summary":"Sign request","description":"Native signature headers for a mobile request you are about to send, in 0.25 ms at p50 and 0.93 ms at p99. Pick the client with os, app_flavour and app_version.\n\nUpstream: local · native request signer (<1 ms).\n\nCost: 2 credits (primitive tier). Failed calls are not charged.","tags":["Devices, signing & primitives"],"x-credits":2,"x-tier":"primitive","x-upstream-paths":["local · native request signer (<1 ms)"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/sign-request","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"headers":{"x-argus":"2PxBqzvQe0d+5SWvx45cr+LKRhQN3D0elZBF6hFDcKtTYsKtysoEdsp1TMLEi73Q5TIgcpXxDSuR9L22KPpbm0N8XEGsOXStCg4S","x-gorgon":"8404701B00006D2BAB9391444846DFBE6320BCC64DE2A5417306","x-khronos":"1762900000","x-ladon":"7Rn17g/L4D32jfFAmX5C3KRcWg424sPaP/v+QtSRHAolomQI","x-ss-req-ticket":"1762900000412"},"client":{"os":"android","app_flavour":"tiktok","app_version":"47.6.3","aid":1233},"took_ms":0.24}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"os":{"type":"string","enum":["android","ios"],"description":"android or ios."},"app_flavour":{"type":"string","enum":["tiktok","lite","lite_coin","pro","studio","shop","tv","douyin"],"description":"Which app to run as."},"app_version":{"type":"string","description":"A release of that app. Defaults to the current default for (os, app_flavour)."},"method":{"type":"string","description":"The HTTP method of your request."},"url":{"type":"string","description":"The full request URL, with its query."},"headers":{"type":"object","description":"Headers you will send."},"body":{"type":"string","description":"The body you will send, if any."},"device_id":{"type":"string","description":"Sign as one of your provisioned devices."}},"required":["method","url"]},"example":{"os":"android","app_flavour":"tiktok","app_version":"47.6.3","method":"GET","url":"https://api16-normal-c-useast1a.tiktokv.com/aweme/v1/feed/?aid=1233&count=6"}}}}}},"/v1/crypto/x-cylons":{"post":{"operationId":"xCylons","summary":"X-Cylons token","description":"Generate an X-Cylons session-binding header from query, stub, and Lanus keys.\n\nUpstream: local · X-Cylons SM3/MD5 signer.\n\nCost: 2 credits (primitive tier). Failed calls are not charged.","tags":["Devices, signing & primitives"],"x-credits":2,"x-tier":"primitive","x-upstream-paths":["local · X-Cylons SM3/MD5 signer"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/x-cylons","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"x_cylons":"AQILq7nEOCRCxhO/cr2I749vyyTi8kSLCVdIht2HRqpWQBEj1FOJ8aRK3TGbEYLZ2BIAAAAAaRO4IA==","lanusk_md5_hex":"0babb9c4382442c613bf72bd88ef8f6f","lanusv_sm3_hex":"cb24e2f2448b09574886dd8746aa56401123d45389f1a44add319b1182d9d812","khronos":1762900000}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query_string":{"type":"string","description":"Raw URL query string."},"x_ss_stub":{"type":"string","description":"Optional 32-hex MD5 body digest."},"lanusk":{"type":"string","description":"Session Lanus key."},"lanusv":{"type":"string","description":"Session Lanus version."},"khronos":{"type":"integer","description":"Unix timestamp in seconds."}},"required":["query_string"]},"example":{"query_string":"aid=1233&count=6","khronos":1762900000}}}}}},"/v1/crypto/x-argus/decrypt":{"post":{"operationId":"xArgusDecrypt","summary":"X-Argus decrypt","description":"Decrypt and inspect an external X-Argus header into typed fields.\n\nUpstream: local · X-Argus cipher & protobuf inspector.\n\nCost: 2 credits (primitive tier). Failed calls are not charged.","tags":["Devices, signing & primitives"],"x-credits":2,"x-tier":"primitive","x-upstream-paths":["local · X-Argus cipher & protobuf inspector"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/x-argus-decrypt","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"aid":1233,"app_version":"47.6.3","sdk_version_str":"v05.03.03-ov-android","sdk_version":168101952,"platform":"android","create_time":1762900000,"device_id":"7310000000000000001","license_id":2142840551,"psk_version":"0","call_type":738,"query_hash_hex":"8c4a129e0b1f44e1","body_hash_hex":"d41d8cd98f00b204"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"x_argus":{"type":"string","description":"Base64 X-Argus header captured from your own device."},"os":{"type":"string","enum":["android","ios"],"description":"android or ios."},"app_flavour":{"type":"string","enum":["tiktok","lite","lite_coin","pro","studio","shop","tv","douyin"],"description":"Which app to run as."},"app_version":{"type":"string","description":"A release of that app. Defaults to the current default for (os, app_flavour)."}},"required":["x_argus"]},"example":{"x_argus":"2PxBqzvQe0d+5SWvx45cr+LKRhQN3D0elZBF6hFDcKtTYsKtysoEdsp1TMLEi73Q5TIgcpXxDSuR9L22KPpbm0N8XEGsOXStCg4S//5sPy+SGlaJgl/OuWDmRbuSl4xldVE9d4ZmHkVFHTzj4ebr7scntHmaKQTlbml/avTPUVO/W4SanQm9KMr9DHhWU/eJBCYMc0BUmQ1OdV02D+YgB+AWA/+ju4WIrp/B61J+v36Bkj5uWearxxA5Ctlz7VnKqivhNMe3MnyJk2zHc6fmKJtD6Rk0kThF6TmijVQK/e6qHiMZOSocMk6SgMTq5ji9KgtNzIhcp33C7tUHAX3kdmOapQop0kf9DcBpAK1K277eG5pL6rvlhwJq+LNlE2dHWp8="}}}}}},"/v1/crypto/x-ladon/decrypt":{"post":{"operationId":"xLadonDecrypt","summary":"X-Ladon decrypt","description":"Decrypt an external X-Ladon header into timestamp, license ID and aid.\n\nUpstream: local · X-Ladon cipher inspector.\n\nCost: 2 credits (primitive tier). Failed calls are not charged.","tags":["Devices, signing & primitives"],"x-credits":2,"x-tier":"primitive","x-upstream-paths":["local · X-Ladon cipher inspector"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/x-ladon-decrypt","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"plaintext":"1762900000-2142840551-1233","khronos":1762900000,"lc_id":"2142840551","aid":"1233"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"x_ladon":{"type":"string","description":"Base64 X-Ladon header."},"aid":{"type":"string","description":"Application ID used to derive the key."}},"required":["x_ladon"]},"example":{"x_ladon":"7Rn17g/L4D32jfFAmX5C3KRcWg424sPaP/v+QtSRHAolomQI","aid":"1233"}}}}}},"/v1/crypto/x-gorgon/decrypt":{"post":{"operationId":"xGorgonDecrypt","summary":"X-Gorgon decrypt","description":"Decrypt an external X-Gorgon header into query digest, timestamp and SDK version.\n\nUpstream: local · X-Gorgon cipher inspector.\n\nCost: 2 credits (primitive tier). Failed calls are not charged.","tags":["Devices, signing & primitives"],"x-credits":2,"x-tier":"primitive","x-upstream-paths":["local · X-Gorgon cipher inspector"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/x-gorgon-decrypt","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"xg_version":"8404","random":"701b0000","env_code":"0000","query_md5_prefix4":"6d2bab93","x_khronos":1762900000,"ms_version":"v05.03.03"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"x_gorgon":{"type":"string","description":"Hex X-Gorgon header."}},"required":["x_gorgon"]},"example":{"x_gorgon":"8404701B00006D2BAB9391444846DFBE6320BCC64DE2A5417306"}}}}}},"/v1/crypto/ttencrypt/encrypt":{"post":{"operationId":"ttencryptEncrypt","summary":"TTEncrypt encode","description":"Encrypt telemetry or registration JSON with TTEncrypt.\n\nUpstream: local · TTEncrypt codec.\n\nCost: 2 credits (primitive tier). Failed calls are not charged.","tags":["Devices, signing & primitives"],"x-credits":2,"x-tier":"primitive","x-upstream-paths":["local · TTEncrypt codec"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/ttencrypt-encrypt","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"ciphertext_base64":"dGMFEAAAe8F4+5CYxfGXyqSNJKbB4euSFkEMBHrbAAAAAGr0+qqTnvZeQiJaT1YAP+hG7RjD5HJTyJqFqe4Xug/l5fu9ONiZw5iCWSHatRBC2IpRNzmUvHu/fPwsS7tpioWTaMXQONyxcOu9MqTWBAXACWXOxw/qsoRiWZJNWrcM/30DGr6Vgf2ntP/Y1BF3C0UzPyzwoaMuq0/NejyG5CK1XeiULw1d667pQ09gpklCjx32dbeZ877qjpcwG1r1xFwjXOCu","ciphertext_hex":"7463051000007bc178fb9098c5f197caa48d24a6c1e1eb9216410c047adb000000006af4faaa939ef65e42225a4f5600"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"plaintext":{"type":"string","description":"UTF-8 JSON or string payload to encrypt."},"compress":{"type":"boolean","description":"Gzip-compress before encrypting."}},"required":["plaintext"]},"example":{"plaintext":"{\"aid\":1233,\"app_name\":\"musical_ly\",\"channel\":\"googleplay\"}","compress":true}}}}}},"/v1/crypto/ttencrypt/decrypt":{"post":{"operationId":"ttencryptDecrypt","summary":"TTEncrypt decode","description":"Decrypt an external TTEncrypt frame into UTF-8 and parsed JSON.\n\nUpstream: local · TTEncrypt codec.\n\nCost: 2 credits (primitive tier). Failed calls are not charged.","tags":["Devices, signing & primitives"],"x-credits":2,"x-tier":"primitive","x-upstream-paths":["local · TTEncrypt codec"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/ttencrypt-decrypt","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"plaintext":"{\"aid\":1233,\"app_name\":\"musical_ly\",\"channel\":\"googleplay\"}","plaintext_base64":"eyJhaWQiOjEyMzMsImFwcF9uYW1lIjoibXVzaWNhbF9seSIsImNoYW5uZWwiOiJnb29nbGVwbGF5In0=","json":{"aid":1233,"app_name":"musical_ly","channel":"googleplay"}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ciphertext_base64":{"type":"string","description":"Base64 TTEncrypt payload from your own capture."}},"required":["ciphertext_base64"]},"example":{"ciphertext_base64":"dGMFEAAAe8F4+5CYxfGXyqSNJKbB4euSFkEMBHrbAAAAAGr0+qqTnvZeQiJaT1YAP+hG7RjD5HJTyJqFqe4Xug/l5fu9ONiZw5iCWSHatRBC2IpRNzmUvHu/fPwsS7tpioWTaMXQONyxcOu9MqTWBAXACWXOxw/qsoRiWZJNWrcM/30DGr6Vgf2ntP/Y1BF3C0UzPyzwoaMuq0/NejyG5CK1XeiULw1d667pQ09gpklCjx32dbeZ877qjpcwG1r1xFwjXOCu"}}}}}},"/v1/crypto/zstd/compress":{"post":{"operationId":"zstdCompress","summary":"zstd compress","description":"Compress a payload with zstd.\n\nUpstream: local · zstd codec.\n\nCost: 2 credits (primitive tier). Failed calls are not charged.","tags":["Devices, signing & primitives"],"x-credits":2,"x-tier":"primitive","x-upstream-paths":["local · zstd codec"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/zstd-compress","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"compressed_base64":"KLUv/QAAoQAAeyJoZWxsbyI6InRpa3VsdHJhIn0=","compressed_hex":"28b52ffd0000a100007b2268656c6c6f223a2274696b756c747261227d","dictionary":"tt-zstd-v0.0.2"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"data_base64":{"type":"string","description":"The payload, base64."}},"required":["data_base64"]},"example":{"data_base64":"eyJoZWxsbyI6InRpa3VsdHJhIn0="}}}}}},"/v1/crypto/zstd/decompress":{"post":{"operationId":"zstdDecompress","summary":"zstd decompress","description":"Decompress a zstd payload.\n\nUpstream: local · zstd codec.\n\nCost: 2 credits (primitive tier). Failed calls are not charged.","tags":["Devices, signing & primitives"],"x-credits":2,"x-tier":"primitive","x-upstream-paths":["local · zstd codec"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/zstd-decompress","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"decompressed":"{\"hello\":\"tikultra\"}","decompressed_base64":"eyJoZWxsbyI6InRpa3VsdHJhIn0="}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"data_base64":{"type":"string","description":"The payload, base64."}},"required":["data_base64"]},"example":{"data_base64":"KLUv/QAAoQAAeyJoZWxsbyI6InRpa3VsdHJhIn0="}}}}}},"/v1/crypto/passport-hash":{"post":{"operationId":"passportHash","summary":"Passport identifier hash","description":"Compute Passport XOR-5 hex, TTP identifier SHA-256 and session scramble values.\n\nUpstream: local · Passport XOR5 & TTP hash.\n\nCost: 2 credits (primitive tier). Failed calls are not charged.","tags":["Devices, signing & primitives"],"x-credits":2,"x-tier":"primitive","x-upstream-paths":["local · Passport XOR5 & TTP hash"],"x-access":"public","x-docs":"https://tikultra.com/docs/api/passport-hash","responses":{"200":{"description":"Success. Decoded JSON.","headers":{"x-credits-cost":{"schema":{"type":"integer"}},"x-credits-remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"xor5_hex":"6466686045607d64687569602b666a68","ttp_identifier_hash":"0ec07e2add1b72e4100dbdfb6334cfcb9d05aebf6b1cffa446baf99f182ff865","scrambled_session_id":"1636d65604568716d607c656e236f6d6","caesar_minus_one":"`bld?dw`lokd-bnl"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"string","description":"Email, phone, username or session token."},"identifier_type":{"type":"string","enum":["email","phone","username","uid"],"description":"email, phone, username or uid."}},"required":["value"]},"example":{"value":"acme@example.com","identifier_type":"email"}}}}}}},"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"x-api-key"}},"parameters":{"os":{"name":"os","in":"query","required":false,"description":"Run as android or ios.","schema":{"type":"string","enum":["android","ios"]}},"app_flavour":{"name":"app_flavour","in":"query","required":false,"description":"Which app to run as.","schema":{"type":"string","enum":["tiktok","lite","lite_coin","pro","studio","shop","tv","douyin"]}},"app_version":{"name":"app_version","in":"query","required":false,"description":"A release of that app. Defaults to the current default for (os, app_flavour).","schema":{"type":"string"}}},"schemas":{"Page":{"type":"object","required":["cursor","has_more"],"properties":{"cursor":{"type":["string","null"],"description":"Pass back as `cursor` for the next page."},"has_more":{"type":"boolean"}},"additionalProperties":true}},"responses":{"Error":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}}}}}}}