# Tikultra — Complete LLM & Coding Agent Reference (llms-full.txt) > TikTok’s native mobile API behind one REST API: 200+ 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. ## 1. Platform Constants & Quick Setup - **REST Base URL:** `https://api.tikultra.com` - **Authentication:** Header `x-api-key: ` - **TypeScript / JavaScript SDK:** `npm install tikultra` (`import { TikUltra } from "tikultra"`) - **Python SDK:** `pip install tikultra` (`from tikultra import TikUltra, AsyncTikUltra`) - **Hosted Remote MCP:** `https://mcp.tikultra.com/mcp` (Streamable HTTP + SSE; pass `x-api-key` header; optional `?profile=core|public|decrypt|all&max_credits=500`) - **Local Node MCP:** `npx -y @tikultra/mcp --key $TIKULTRA_KEY` - **Client Matrix:** `os` (`android`, `ios`), `app_flavour` (`tiktok`, `lite`, `lite_coin`, `pro`, `studio`, `shop`, `tv`, `douyin`), `app_version` (50+ releases; signing 0.25 ms p50), `region` & `city` (84 cities). - **Pricing Tiers:** Primitive = 2 cr, Standard = 5 cr, Heavy = 10 cr, Premium = 25 cr. Unit cost on Scale: $0.12/1k primitives, $0.25/1k blended, $0.29/1k standard reads. Failed calls always cost `0` credits. - **Plans & Payments:** Free $0/mo (2,500 cr, 3 rps); Starter $29/mo (250,000 cr, 25 rps); Growth $99/mo (1,250,000 cr, 75 rps); Scale $349/mo (6,000,000 cr, 250 rps); Enterprise from $1499/mo. Card (Stripe) + Crypto (OxaPay: USDT, USDC, BTC, ETH, SOL, TRX, LTC) + instant PAYG credit packs on all plans. ## 2. The Four Execution Planes (Critical Architecture Rule) 1. **Managed Guest Pool (`LeanPool`):** Used by public unauthenticated mobile reads (`/v1/video`, `/v1/user`, `/v1/search`, `/v1/feed`, `/v1/shop/*`, `/v1/live/*`, `/v1/hashtag`, `/v1/music`). Never pass `account_id`. 2. **Managed Authed Read Pool (`FullPool` Read-Only Corpus):** Used automatically by login-gated public reads (`/v1/user/stories`, `/v1/user/stories/batch`, `/v1/user/reposts`, `/v1/user/favorites`, `/v1/video/upvotes`, `/v1/user/followers`, `/v1/user/followings`). Internal corpus devices (`owner="corpus"`) are strictly read-only (`403 account_forbidden` on any write). Never pass `account_id`. 3. **Caller-Owned Connected Workspace (`account_id` on Dedicated 1:1 `FullPool`):** Used by all `/v1/account/*` routes (publishing, protobuf DMs, comments, likes/follows/reposts, profile updates, LIVE hosting, Studio analytics). You MUST first obtain your own `account_id` via: - `POST /v1/account/import` (bring exported `sessionid` / cookies), - `POST /v1/account/login/otp/send` + `POST /v1/account/login/otp/verify` (email OTP sign-in), or - `POST /v1/account/register/email/send` + `POST /v1/account/register/email/verify` (Scale+ 2-step registration requiring your own residential/mobile `proxy`). 4. **Local Protocol Primitives & Device Fleet:** Sub-ms native signing (`POST /v1/crypto/sign`), read-only header/frame decryption (`/v1/crypto/*/decrypt`), codecs (`protobuf`, `ttencrypt`, `zstd`), URL/Snowflake resolver (`/v1/resolve`, `/v1/id-converter`), async batch jobs (`/v1/jobs/submit`), and caller-provisioned guest devices (`/v1/devices/*`). ## 3. Canonical Multi-Endpoint Workflows ### Workflow A — Autonomous Native Protobuf Direct Messaging (Growth+) 1. `POST /v1/account/import` (or `/v1/account/login/otp/send` -> `/verify`) -> store `account_id`. 2. `POST /v1/account/session/warm-reopen` with `{ account_id }` -> foreground AppLog + MSSDK Scene 105. 3. `GET /v1/account/dm/inbox?account_id=...` -> poll unread conversations and extract `conversation_id`. 4. `GET /v1/account/dm/conversation/messages?account_id=...&conversation_id=...` -> read thread context. 5. `POST /v1/account/dm/conversation/read` + `POST /v1/account/dm/typing` -> mark read & show typing. 6. `POST /v1/account/dm/send` (or `/reply`, `/send-image`, `/send-voice`, `/share-video`) -> dispatch protobuf IM. ### Workflow B — Caller-Owned Account Likes, Follows, Reposts & Comments (Growth+) 1. Connect your own account (`account_id`) via `/v1/account/import`, `/v1/account/login/otp/*`, or Scale+ `/v1/account/register/email/*`. 2. Resolve target post/user via `GET /v1/resolve?input=...` or `GET /v1/video?url=...` -> `aweme_id`, `uid`, `sec_uid`. 3. Record realistic watch dwell on that same device via `POST /v1/account/warm/watch-item` (`{ account_id, aweme_id, play_delta_ms, finish: true }`). 4. Commit engagement on your `account_id`: `POST /v1/account/like`, `/v1/account/follow`, `/v1/account/repost`, `/v1/account/favorite`, or `/v1/account/comment`. ### Workflow C — Scale+ 2-Step Email Registration with BYO Proxy 1. Optional: `GET /v1/user/check-username?unique_id=...` (2 cr) to verify target handle is free. 2. `POST /v1/account/register/email/send` with `{ email, password, birthday: "YYYY-MM-DD", proxy: "http://...", region, city, warmup: true }` -> save `context_id`. 3. Read the 6-digit email OTP from your inbox. 4. `POST /v1/account/register/email/verify` with `{ context_id, email, code, password, birthday, proxy }` -> receive persistent `account_id`. 5. Claim handle (`POST /v1/account/profile/username`), set bio/avatar (`/profile/update`, `/profile/avatar`), and calibrate FYP (`POST /v1/account/warm/niche`). ### Workflow D — One-Call Video & Carousel Publishing (Growth+) 1. `GET /v1/account/health?account_id=...` + optional `GET /v1/account/upload/precheck?account_id=...`. 2. `POST /v1/account/upload/video` (multipart `file` or JSON `video_url`, `caption`, `hashtags`, `visibility`, `music_id`, `poi_id`, `shop_product_ids`) or `POST /v1/account/upload/slideshow`. 3. Monitor reach via `GET /v1/account/studio/overview?account_id=...` and `GET /v1/video/fyp-velocity?aweme_id=...`. ## 4. Guides & Tutorials Markdown URLs - [Introduction](https://tikultra.com/docs/md/introduction): Tikultra is a gateway to TikTok’s native mobile API: managed endpoints that return JSON, devices and signing primitives for your own pipeline, and connected sessions for accounts you own. - [Quickstart](https://tikultra.com/docs/md/quickstart): Create a key, fetch one TikTok video as JSON and see what the call cost. It takes about a minute. - [Authentication](https://tikultra.com/docs/md/authentication): Every request needs an API key in the x-api-key header. Each key has its own credit balance; your plan sets its rate limit. - [Credits and pricing](https://tikultra.com/docs/md/credits): Every endpoint has a fixed cost. Plans set your monthly credits; top-ups cost your plan’s rate. - [Rate limits](https://tikultra.com/docs/md/rate-limits): Your plan sets requests per second for the whole account. Over the limit you get 429 with a retry-after header, at no cost. - [Errors and retries](https://tikultra.com/docs/md/errors): Every error has a stable code and costs nothing. Retry 429s and 5xx with backoff; fix the rest. - [Managed gateway](https://tikultra.com/docs/md/managed-gateway): One REST call returns typed JSON for videos, profiles, feeds, search, Tako AI, LIVE rooms, series and Shop product pages. We handle signing, contexts, retries and decoding. - [Clients and versions](https://tikultra.com/docs/md/clients): Pick the app you run as with three fields: os, app_flavour and app_version. 8 app flavours, 50+ releases. - [Devices, signing & primitives](https://tikultra.com/docs/md/primitives): Bring your own HTTP pipeline. Sign native requests, provision device contexts, resolve links and decode protobuf payloads. - [Connected sessions](https://tikultra.com/docs/md/connected-sessions): Bind sessions you own to dedicated 1:1 mobile contexts (FullPool) to publish, manage comments and DMs, and host LIVE. Growth and Scale. - [Batch jobs](https://tikultra.com/docs/md/batch-jobs): Submit up to 500 tasks per job and get a webhook when it finishes. Growth and Scale. - [IDs and the resolver](https://tikultra.com/docs/md/ids): TikTok IDs are 64-bit Snowflakes; the top 32 bits are the creation time. The resolver turns any link into typed IDs. - [Pagination](https://tikultra.com/docs/md/pagination): Every list endpoint uses one contract: pass cursor and count, get back cursor and has_more at the top level. - [Media streams](https://tikultra.com/docs/md/media-streams): Video responses include the play stream’s codec, size and frame rate. Source files come from the no-watermark endpoint. - [Contexts and egress](https://tikultra.com/docs/md/contexts): Calls run in isolated, pre-warmed device contexts with city-level egress in 84 cities, so sessions stay consistent and results stay local. - [Webhooks](https://tikultra.com/docs/md/webhooks): Get told when credits run low, when an endpoint starts failing for you, or when a batch job finishes. - [TypeScript SDK](https://tikultra.com/docs/md/typescript-sdk): Zero-dependency TypeScript and JavaScript client built on Web-standard fetch, FormData and Blob: runs on Node 18+, Bun, Deno, Cloudflare Workers and Next.js Edge, with immutable matrix scoping, async pagination, multipart publishing and decrypt inspectors. - [Python SDK](https://tikultra.com/docs/md/python-sdk): Typed sync and async Python client backed by httpx: domain resources, client/geo matrix defaults, automatic cursor pagination, one-call multipart publishing and credit telemetry. - [AI agents and MCP](https://tikultra.com/docs/md/mcp): Connect Claude, Cursor, Windsurf, OpenAI or any MCP client via zero-install Hosted Remote MCP or @tikultra/mcp — exposing 230+ gateway, commerce, SMM and session tools, 8 read-only decrypt inspectors, 20 research & operator prompts and 6 tikultra:// resources. - [OpenAPI and llms.txt](https://tikultra.com/docs/md/openapi): Machine-readable descriptions of every endpoint, plus official TypeScript, Python and MCP integrations. - [Creator intelligence A–Z](https://tikultra.com/docs/md/tutorial-creator-intelligence): Resolve any @handle or share link into stable IDs, walk a creator’s post timeline via cursor pagination, sample ASR transcripts and top comment sentiment, and account for every credit spent. - [TikTok Shop research A–Z](https://tikultra.com/docs/md/tutorial-shop-market-research): Scope immutable US and UK TikTok Shop clients, discover category SKUs by keyword, parse mobile SDUI product pricing and stock, paginate verified buyer reviews, and benchmark affiliate showcases. - [Geo & persona feeds A–Z](https://tikultra.com/docs/md/tutorial-geo-persona-feeds): Provision a dedicated city-pinned device context, run bootstrap and niche warmup, compare For You distributions across Miami, London and Tokyo, and batch-enrich discovered videos. - [Shadowban & fleet forensics A–Z](https://tikultra.com/docs/md/tutorial-shadowban-fleet-forensics): Audit 50+ agency, theme-page or clipper handles for silent FYP suppression ("200-view jail"), search de-indexing, upload-source fingerprinting (shoot vs upload vs capcut), and moderation flags. - [Winning product & affiliate spy A–Z](https://tikultra.com/docs/md/tutorial-winning-product-affiliate-spy): Snipe breakout TikTok Shop (OEC) SKUs by tracking PDP inventory deltas to infer daily unit velocity, reverse-engineering top creator affiliate showcases, scraping video cart anchors, and monitoring LIVE bag rotations. - [Douyin arbitrage & lead mining A–Z](https://tikultra.com/docs/md/tutorial-douyin-arbitrage-lead-mining): Spot breakout Douyin formats 2–4 weeks early, pull clean master media and translated ASR scripts, harvest buyer-intent competitor comments, and target blue-comment search suggestions and Studio content gaps. - [SMM multi-account runner A–Z](https://tikultra.com/docs/md/tutorial-smm-account-operations): Bind caller-owned brand, agency, UGC and theme-page accounts to sticky 1:1 mobile device + city contexts, run realistic multi-day organic warming and foreground lifecycle loops, brand profiles, precheck & publish media, and convert comment/DM leads. - [Rare username checker & claimer A–Z](https://tikultra.com/docs/md/tutorial-rare-username-claiming): Sweep 3–6 character, dictionary and brand @username candidates at 2 credits per check, filter out banned or trademark-reserved handles, verify 30-day handle cooldowns, and claim available handles onto an owned Connected Workspace account. - [Protocol decrypt & audit A–Z](https://tikultra.com/docs/md/tutorial-protocol-decrypt-inspector): Inspect authorized QA and mobile security traffic captures end-to-end with read-only decrypt and decode primitives — verifying headers, payload hashes, MSSDK frames and protobuf wire fields without signing keys. - [Autonomous MCP agent A–Z](https://tikultra.com/docs/md/tutorial-ai-agent-mcp): Connect Claude, Cursor or a custom TypeScript MCP client to Hosted Remote MCP or @tikultra/mcp, load compliance-grounded research prompts, enforce a hard credit cap, and emit a structured report. ## 5. Complete API Endpoint Reference (209 Endpoints) ### Videos & comments #### GET /v1/video — Get video - **Docs / Raw MD:** https://tikultra.com/docs/api/get-video | https://tikultra.com/docs/md/api/get-video - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr - **Upstream:** /aweme/v1/aweme/detail/ - **Summary:** One video by aweme_id or share URL: caption, stats, author, sound and the play stream’s codec, size and frame rate. - **Params:** aweme_id:string, url:string - **Workflow:** Link Resolution, Source Media, Transcripts & Video Forensics (/v1/resolve -> /v1/video -> /v1/video/no-watermark -> /v1/video/fyp-velocity) #### POST /v1/video/batch — Batch videos - **Docs / Raw MD:** https://tikultra.com/docs/api/video-batch | https://tikultra.com/docs/md/api/video-batch - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr / item - **Upstream:** /aweme/v1/multi/aweme/detail/ - **Summary:** Up to 50 videos in one call, billed per video. - **Params:** aweme_ids*:string[] - **Workflow:** Link Resolution, Source Media, Transcripts & Video Forensics (/v1/resolve -> /v1/video -> /v1/video/no-watermark -> /v1/video/batch -> /v1/video/fyp-velocity) #### GET /v1/video/comments — Comments - **Docs / Raw MD:** https://tikultra.com/docs/api/comments | https://tikultra.com/docs/md/api/comments - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /aweme/v2/comment/list/ - **Summary:** A page of comments on a video. - **Params:** aweme_id:string, url:string, cursor:string, count:integer, sort_strategy:string - **Workflow:** Link Resolution, Source Media, Transcripts & Video Forensics (/v1/resolve -> /v1/video -> /v1/video/no-watermark -> /v1/video/comments -> /v1/video/fyp-velocity) #### GET /v1/video/comments/replies — Comment replies - **Docs / Raw MD:** https://tikultra.com/docs/api/comment-replies | https://tikultra.com/docs/md/api/comment-replies - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /aweme/v1/comment/list/reply/ - **Summary:** A page of replies to one comment. - **Params:** aweme_id*:string, comment_id*:string, cursor:string, count:integer - **Workflow:** Link Resolution, Source Media, Transcripts & Video Forensics (/v1/resolve -> /v1/video -> /v1/video/no-watermark -> /v1/video/comments/replies -> /v1/video/fyp-velocity) #### GET /v1/video/comments/by-ids — Comments by ID - **Docs / Raw MD:** https://tikultra.com/docs/api/comments-by-ids | https://tikultra.com/docs/md/api/comments-by-ids - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr - **Upstream:** /tiktok/comment/status/batch_get/v1 - **Summary:** Look up comments by their IDs. - **Params:** comment_ids*:string - **Workflow:** Link Resolution, Source Media, Transcripts & Video Forensics (/v1/resolve -> /v1/video -> /v1/video/no-watermark -> /v1/video/comments/by-ids -> /v1/video/fyp-velocity) #### GET /v1/video/danmaku — Danmaku - **Docs / Raw MD:** https://tikultra.com/docs/api/danmaku | https://tikultra.com/docs/md/api/danmaku - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr - **Upstream:** /tiktok/danmaku/get/v1, /tiktok/danmaku/list/v1 - **Summary:** Time-coded floating “bullet” reactions viewers pin to moments in a video, with their offsets in milliseconds. - **Params:** aweme_id*:string, start_time_ms:integer, end_time_ms:integer - **Workflow:** Link Resolution, Source Media, Transcripts & Video Forensics (/v1/resolve -> /v1/video -> /v1/video/no-watermark -> /v1/video/danmaku -> /v1/video/fyp-velocity) #### GET /v1/video/transcript — Transcript - **Docs / Raw MD:** https://tikultra.com/docs/api/transcript | https://tikultra.com/docs/md/api/transcript - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 2 cr - **Upstream:** /aweme/v1/aweme/detail/ - **Summary:** Time-aligned caption tracks for a video. - **Params:** aweme_id:string, url:string, lang:string - **Workflow:** Link Resolution, Source Media, Transcripts & Video Forensics (/v1/resolve -> /v1/video -> /v1/video/no-watermark -> /v1/video/transcript -> /v1/video/fyp-velocity) #### GET /v1/video/no-watermark — No-watermark media - **Docs / Raw MD:** https://tikultra.com/docs/api/no-watermark | https://tikultra.com/docs/md/api/no-watermark - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 2 cr - **Upstream:** /aweme/v1/aweme/detail/ - **Summary:** Source 1080p60 ByteVC1 or H.264 master URLs. - **Params:** aweme_id:string, url:string - **Workflow:** Link Resolution, Source Media, Transcripts & Video Forensics (/v1/resolve -> /v1/video -> /v1/video/no-watermark -> /v1/video/fyp-velocity) #### GET /v1/video/slideshow — Slideshow media - **Docs / Raw MD:** https://tikultra.com/docs/api/slideshow-downloader | https://tikultra.com/docs/md/api/slideshow-downloader - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 2 cr - **Upstream:** /aweme/v1/aweme/detail/ - **Summary:** Every source image and the audio of a carousel. - **Params:** aweme_id:string, url:string - **Workflow:** Link Resolution, Source Media, Transcripts & Video Forensics (/v1/resolve -> /v1/video -> /v1/video/no-watermark -> /v1/video/slideshow -> /v1/video/fyp-velocity) #### GET /v1/video/duets — Duets and stitches - **Docs / Raw MD:** https://tikultra.com/docs/api/duets | https://tikultra.com/docs/md/api/duets - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /tiktok/v1/duet/detail/ - **Summary:** Duets and stitches made from a video. - **Params:** aweme_id*:string, cursor:string, count:integer - **Workflow:** Link Resolution, Source Media, Transcripts & Video Forensics (/v1/resolve -> /v1/video -> /v1/video/no-watermark -> /v1/video/duets -> /v1/video/fyp-velocity) #### GET /v1/video/anchors — Video anchors - **Docs / Raw MD:** https://tikultra.com/docs/api/video-anchors | https://tikultra.com/docs/md/api/video-anchors - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr - **Upstream:** /aweme/v1/anchor/aweme/ - **Summary:** Shop, CapCut, place or effect anchors on a video. - **Params:** aweme_id*:string - **Workflow:** Link Resolution, Source Media, Transcripts & Video Forensics (/v1/resolve -> /v1/video -> /v1/video/no-watermark -> /v1/video/anchors -> /v1/video/fyp-velocity) #### GET /v1/video/upvotes — Repost annotations - **Docs / Raw MD:** https://tikultra.com/docs/api/upvotes | https://tikultra.com/docs/md/api/upvotes - **Pool:** Managed Authed Read Pool · Read-Only Corpus | **Access:** Every plan | **Cost:** 10 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /tiktok/v1/upvote/batch_list/ - **Summary:** Public repost annotations on a post (read-only managed authed pool). - **Params:** aweme_id*:string, cursor:string, count:integer - **Workflow:** Login-Gated Public Reads via Managed Authed Corpus (/v1/user -> /v1/user/stories -> /v1/video/upvotes -> /v1/user/followers) #### GET /v1/video/share-info — Share info - **Docs / Raw MD:** https://tikultra.com/docs/api/share-info | https://tikultra.com/docs/md/api/share-info - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr - **Upstream:** /tiktok/share/link/shorten/v1/ - **Summary:** The short share link and share metadata of a video. - **Params:** aweme_id*:string - **Workflow:** Link Resolution, Source Media, Transcripts & Video Forensics (/v1/resolve -> /v1/video -> /v1/video/no-watermark -> /v1/video/share-info -> /v1/video/fyp-velocity) #### GET /v1/video/gifts — Video gifts - **Docs / Raw MD:** https://tikultra.com/docs/api/video-gifts | https://tikultra.com/docs/md/api/video-gifts - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr - **Upstream:** /tiktok/v1/gift/list/ - **Summary:** Gifts sent on a video. - **Params:** aweme_id*:string - **Workflow:** Link Resolution, Source Media, Transcripts & Video Forensics (/v1/resolve -> /v1/video -> /v1/video/no-watermark -> /v1/video/gifts -> /v1/video/fyp-velocity) #### GET /v1/video/forensics — Video forensics - **Docs / Raw MD:** https://tikultra.com/docs/api/video-forensics | https://tikultra.com/docs/md/api/video-forensics - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /aweme/v1/aweme/detail/, /tiktok/inspect/item/v1 - **Summary:** Encoding, upload client and AI-generated content metadata. - **Params:** aweme_id:string, url:string - **Workflow:** Link Resolution, Source Media, Transcripts & Video Forensics (/v1/resolve -> /v1/video -> /v1/video/no-watermark -> /v1/video/forensics -> /v1/video/fyp-velocity) #### GET /v1/video/fyp-velocity — FYP velocity - **Docs / Raw MD:** https://tikultra.com/docs/api/fyp-velocity | https://tikultra.com/docs/md/api/fyp-velocity - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /aweme/v1/aweme/detail/ - **Summary:** Play, like and share velocity of a post. - **Params:** aweme_id:string, url:string - **Workflow:** Link Resolution, Source Media, Transcripts & Video Forensics (/v1/resolve -> /v1/video -> /v1/video/no-watermark -> /v1/video/fyp-velocity) #### GET /v1/video/comment-leads — Comment leads - **Docs / Raw MD:** https://tikultra.com/docs/api/comment-leads | https://tikultra.com/docs/md/api/comment-leads - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /aweme/v2/comment/list/ - **Summary:** Questions and purchase-intent comments, structured. - **Params:** aweme_id:string, url:string - **Workflow:** Comment Lead Mining, Replies & Moderation (/v1/video/comments -> /v1/video/comments/replies -> /v1/account/comment -> /v1/video/comment-leads -> /v1/account/comment/like) ### Users & profiles #### GET /v1/user — Get profile - **Docs / Raw MD:** https://tikultra.com/docs/api/get-profile | https://tikultra.com/docs/md/api/get-profile - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr - **Upstream:** /aweme/v1/user/profile/other/, /tiktok/user/profile/other/v1 - **Summary:** Profile details, counts, bio and links. - **Params:** username:string, sec_uid:string, uid:string, url:string - **Workflow:** Creator Intelligence, Shadowban Visibility & Benchmarking (/v1/user/with-posts -> /v1/user/audit -> /v1/user/visibility -> /v1/user -> /v1/user/compare) #### GET /v1/user/posts — Profile posts - **Docs / Raw MD:** https://tikultra.com/docs/api/profile-posts | https://tikultra.com/docs/md/api/profile-posts - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /aweme/v1/aweme/post/ - **Summary:** A page of a profile's posts. - **Params:** username:string, sec_uid:string, cursor:string, count:integer, sort:string - **Workflow:** Creator Intelligence, Shadowban Visibility & Benchmarking (/v1/user/with-posts -> /v1/user/audit -> /v1/user/visibility -> /v1/user/posts -> /v1/user/compare) #### GET /v1/user/with-posts — Profile with posts - **Docs / Raw MD:** https://tikultra.com/docs/api/profile-with-posts | https://tikultra.com/docs/md/api/profile-with-posts - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /aweme/v1/user/profile/other/, /aweme/v1/aweme/post/ - **Summary:** A profile and its first page of posts in one call. - **Params:** username:string, sec_uid:string - **Workflow:** Creator Intelligence, Shadowban Visibility & Benchmarking (/v1/user/with-posts -> /v1/user/audit -> /v1/user/visibility -> /v1/user/compare) #### GET /v1/user/stories — Stories - **Docs / Raw MD:** https://tikultra.com/docs/api/stories | https://tikultra.com/docs/md/api/stories - **Pool:** Managed Authed Read Pool · Read-Only Corpus | **Access:** Every plan | **Cost:** 10 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /tiktok/story/archive/detail/v1, /tiktok/story/archive/list/v1 - **Summary:** A user's active 24-hour stories (read-only managed authed pool). - **Params:** username:string, sec_uid:string, uid:string, cursor:string, count:integer - **Workflow:** Login-Gated Public Reads via Managed Authed Corpus (/v1/user -> /v1/user/stories -> /v1/user/followers) #### POST /v1/user/stories/batch — Batch stories - **Docs / Raw MD:** https://tikultra.com/docs/api/stories-batch | https://tikultra.com/docs/md/api/stories-batch - **Pool:** Managed Authed Read Pool · Read-Only Corpus | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /tiktok/story/archive/detail/v1 - **Summary:** Active stories for up to 20 users at once (read-only managed authed pool). - **Params:** usernames*:string[] - **Workflow:** Login-Gated Public Reads via Managed Authed Corpus (/v1/user -> /v1/user/stories -> /v1/user/stories/batch -> /v1/user/followers) #### GET /v1/user/reposts — Reposts - **Docs / Raw MD:** https://tikultra.com/docs/api/reposts | https://tikultra.com/docs/md/api/reposts - **Pool:** Managed Authed Read Pool · Read-Only Corpus | **Access:** Every plan | **Cost:** 10 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /tiktok/v1/upvote/item/list/ - **Summary:** The public repost feed of a profile (read-only managed authed pool). - **Params:** username:string, sec_uid:string, cursor:string, count:integer - **Workflow:** Login-Gated Public Reads via Managed Authed Corpus (/v1/user -> /v1/user/stories -> /v1/user/reposts -> /v1/user/followers) #### GET /v1/user/favorites — Favorites - **Docs / Raw MD:** https://tikultra.com/docs/api/favorites | https://tikultra.com/docs/md/api/favorites - **Pool:** Managed Authed Read Pool · Read-Only Corpus | **Access:** Every plan | **Cost:** 10 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /aweme/v1/aweme/favorite/ - **Summary:** Videos a profile has publicly favorited (read-only managed authed pool). - **Params:** username:string, sec_uid:string, cursor:string, count:integer - **Workflow:** Login-Gated Public Reads via Managed Authed Corpus (/v1/user -> /v1/user/stories -> /v1/user/favorites -> /v1/user/followers) #### GET /v1/user/playlists — Playlists - **Docs / Raw MD:** https://tikultra.com/docs/api/playlists | https://tikultra.com/docs/md/api/playlists - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /tiktok/v1/mix/list/ - **Summary:** A creator's playlists. - **Params:** username:string, sec_uid:string, cursor:string, count:integer - **Workflow:** Creator Intelligence, Shadowban Visibility & Benchmarking (/v1/user/with-posts -> /v1/user/audit -> /v1/user/visibility -> /v1/user/playlists -> /v1/user/compare) #### GET /v1/user/followers — Followers - **Docs / Raw MD:** https://tikultra.com/docs/api/followers | https://tikultra.com/docs/md/api/followers - **Pool:** Managed Authed Read Pool · Read-Only Corpus | **Access:** Every plan | **Cost:** 10 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /aweme/v1/user/follower/list/ - **Summary:** A page of followers. - **Params:** username:string, sec_uid:string, cursor:string, count:integer - **Workflow:** Login-Gated Public Reads via Managed Authed Corpus (/v1/user -> /v1/user/stories -> /v1/user/followers) #### GET /v1/user/followings — Followings - **Docs / Raw MD:** https://tikultra.com/docs/api/followings | https://tikultra.com/docs/md/api/followings - **Pool:** Managed Authed Read Pool · Read-Only Corpus | **Access:** Every plan | **Cost:** 10 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /aweme/v1/user/following/list/ - **Summary:** A page of accounts a profile follows. - **Params:** username:string, sec_uid:string, cursor:string, count:integer - **Workflow:** Login-Gated Public Reads via Managed Authed Corpus (/v1/user -> /v1/user/stories -> /v1/user/followings -> /v1/user/followers) #### GET /v1/user/followers/search — Search followers - **Docs / Raw MD:** https://tikultra.com/docs/api/followers-search | https://tikultra.com/docs/md/api/followers-search - **Pool:** Managed Authed Read Pool · Read-Only Corpus | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /aweme/v1/user/follower/list/ - **Summary:** Search within a profile's followers. - **Params:** username:string, sec_uid:string, keyword*:string - **Workflow:** Login-Gated Public Reads via Managed Authed Corpus (/v1/user -> /v1/user/stories -> /v1/user/followers/search -> /v1/user/followers) #### GET /v1/user/followings/search — Search followings - **Docs / Raw MD:** https://tikultra.com/docs/api/followings-search | https://tikultra.com/docs/md/api/followings-search - **Pool:** Managed Authed Read Pool · Read-Only Corpus | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /aweme/v1/user/following/list/ - **Summary:** Search within the accounts a profile follows. - **Params:** username:string, sec_uid:string, keyword*:string - **Workflow:** Login-Gated Public Reads via Managed Authed Corpus (/v1/user -> /v1/user/stories -> /v1/user/followings/search -> /v1/user/followers) #### GET /v1/user/similar — Similar creators - **Docs / Raw MD:** https://tikultra.com/docs/api/similar-users | https://tikultra.com/docs/md/api/similar-users - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /aweme/v1/following/page/user/recommend/ - **Summary:** Creators similar to a profile. - **Params:** username:string, sec_uid:string - **Workflow:** Creator Intelligence, Shadowban Visibility & Benchmarking (/v1/user/with-posts -> /v1/user/audit -> /v1/user/visibility -> /v1/user/similar -> /v1/user/compare) #### GET /v1/user/collections — Collections - **Docs / Raw MD:** https://tikultra.com/docs/api/collections | https://tikultra.com/docs/md/api/collections - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /tiktok/collection/item_archive/list/v1 - **Summary:** A profile's public collections. - **Params:** username:string, sec_uid:string, cursor:string, count:integer - **Workflow:** Creator Intelligence, Shadowban Visibility & Benchmarking (/v1/user/with-posts -> /v1/user/audit -> /v1/user/visibility -> /v1/user/collections -> /v1/user/compare) #### GET /v1/user/collections/videos — Collection videos - **Docs / Raw MD:** https://tikultra.com/docs/api/collection-videos | https://tikultra.com/docs/md/api/collection-videos - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /tiktok/collection/item_archive/item/list/v1 - **Summary:** The videos in one collection. - **Params:** collection_id*:string, cursor:string, count:integer - **Workflow:** Creator Intelligence, Shadowban Visibility & Benchmarking (/v1/user/with-posts -> /v1/user/audit -> /v1/user/visibility -> /v1/user/collections/videos -> /v1/user/compare) #### GET /v1/user/locate-post — Locate post - **Docs / Raw MD:** https://tikultra.com/docs/api/locate-post | https://tikultra.com/docs/md/api/locate-post - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /aweme/v1/post/locate/ - **Summary:** Find where a post sits in a profile's timeline. - **Params:** username:string, sec_uid:string, aweme_id*:string - **Workflow:** Creator Intelligence, Shadowban Visibility & Benchmarking (/v1/user/with-posts -> /v1/user/audit -> /v1/user/visibility -> /v1/user/locate-post -> /v1/user/compare) #### GET /v1/user/series — Creator series - **Docs / Raw MD:** https://tikultra.com/docs/api/user-series | https://tikultra.com/docs/md/api/user-series - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /tiktok/v1/paid_content/collection/list/ - **Summary:** A creator's paid series. - **Params:** username:string, sec_uid:string - **Workflow:** Creator Intelligence, Shadowban Visibility & Benchmarking (/v1/user/with-posts -> /v1/user/audit -> /v1/user/visibility -> /v1/user/series -> /v1/user/compare) #### GET /v1/user/audit — Creator audit - **Docs / Raw MD:** https://tikultra.com/docs/api/account-audit | https://tikultra.com/docs/md/api/account-audit - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr - **Upstream:** /aweme/v1/user/profile/other/, /aweme/v1/aweme/post/ - **Summary:** Engagement, cadence and reach diagnostics for a creator. - **Params:** username:string, sec_uid:string - **Workflow:** Creator Intelligence, Shadowban Visibility & Benchmarking (/v1/user/with-posts -> /v1/user/audit -> /v1/user/visibility -> /v1/user/compare) #### GET /v1/user/visibility — Visibility check - **Docs / Raw MD:** https://tikultra.com/docs/api/visibility | https://tikultra.com/docs/md/api/visibility - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr - **Upstream:** /aweme/v1/general/search/single/, /aweme/v1/aweme/post/ - **Summary:** Search indexability and feed distribution diagnostics. - **Params:** username:string, sec_uid:string - **Workflow:** Creator Intelligence, Shadowban Visibility & Benchmarking (/v1/user/with-posts -> /v1/user/audit -> /v1/user/visibility -> /v1/user/compare) #### GET /v1/user/compare — Compare creators - **Docs / Raw MD:** https://tikultra.com/docs/api/compare-users | https://tikultra.com/docs/md/api/compare-users - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr - **Upstream:** /aweme/v1/user/profile/other/ - **Summary:** Benchmark several creators side by side. - **Params:** usernames*:string - **Workflow:** Creator Intelligence, Shadowban Visibility & Benchmarking (/v1/user/with-posts -> /v1/user/audit -> /v1/user/visibility -> /v1/user/compare) #### GET /v1/user/check-username — Check username - **Docs / Raw MD:** https://tikultra.com/docs/api/check-username | https://tikultra.com/docs/md/api/check-username - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 2 cr - **Upstream:** /aweme/v1/unique/id/check/ - **Summary:** Whether a username is available, taken or reserved. - **Params:** unique_id*:string - **Workflow:** Rare @Username Availability Monitoring & Claiming (/v1/user/bulk-check -> /v1/user/check-username -> /v1/account/health -> /v1/account/profile/username) #### POST /v1/user/bulk-check — Bulk profile check - **Docs / Raw MD:** https://tikultra.com/docs/api/bulk-check | https://tikultra.com/docs/md/api/bulk-check - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr / item - **Upstream:** /aweme/v1/user/profile/other/ - **Summary:** Whether each of up to 100 usernames exists and is public. - **Params:** usernames*:string[] - **Workflow:** Rare @Username Availability Monitoring & Claiming (/v1/user/bulk-check -> /v1/user/check-username -> /v1/account/health -> /v1/account/profile/username) ### Feeds, search & Tako AI #### GET /v1/feed/persona-fyp — Persona For You feed - **Docs / Raw MD:** https://tikultra.com/docs/api/persona-fyp | https://tikultra.com/docs/md/api/persona-fyp - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /aweme/v1/feed/ - **Summary:** 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. - **Params:** region*:string, city:string, niche*:string, count:integer, cursor:string - **Workflow:** City-Pinned Persona Feeds, Search Insights & Cross-Market Trends (/v1/feed/persona-fyp/cities -> /v1/feed/persona-fyp -> /v1/search -> /v1/douyin/hot) #### GET /v1/feed/persona-fyp/cities — Supported persona cities - **Docs / Raw MD:** https://tikultra.com/docs/api/persona-cities | https://tikultra.com/docs/md/api/persona-cities - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** Free - **Upstream:** gateway · regional city catalog - **Summary:** All 84 supported city slugs grouped by country code. - **Params:** none (x-api-key header only) - **Workflow:** City-Pinned Persona Feeds, Search Insights & Cross-Market Trends (/v1/feed/persona-fyp/cities -> /v1/feed/persona-fyp -> /v1/search -> /v1/douyin/hot) #### GET /v1/feed — Feeds - **Docs / Raw MD:** https://tikultra.com/docs/api/for-you-feed | https://tikultra.com/docs/md/api/for-you-feed - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /aweme/v1/feed/, /aweme/v2/follow/feed/, /tiktok/feed/stem/v2, /tiktok/feed/explore/v1, /tiktok/feed/nearby/revamp - **Summary:** For You, Following, STEM, Explore and Nearby feeds. - **Params:** type*:string, region:string, city:string, count:integer, cursor:string - **Workflow:** City-Pinned Persona Feeds, Search Insights & Cross-Market Trends (/v1/feed/persona-fyp/cities -> /v1/feed/persona-fyp -> /v1/search -> /v1/feed -> /v1/douyin/hot) #### GET /v1/feed/stories — Stories feed - **Docs / Raw MD:** https://tikultra.com/docs/api/feed-stories | https://tikultra.com/docs/md/api/feed-stories - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr - **Upstream:** /aweme/v2/follow/feed/skylight - **Summary:** The stories tray at the top of the feed. - **Params:** region:string, city:string - **Workflow:** City-Pinned Persona Feeds, Search Insights & Cross-Market Trends (/v1/feed/persona-fyp/cities -> /v1/feed/persona-fyp -> /v1/search -> /v1/feed/stories -> /v1/douyin/hot) #### GET /v1/feed/landscape — Landscape feed - **Docs / Raw MD:** https://tikultra.com/docs/api/feed-landscape | https://tikultra.com/docs/md/api/feed-landscape - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /tiktok/feed/horizontal/v2 - **Summary:** The horizontal, full-screen video feed. - **Params:** region:string, city:string, count:integer, cursor:string - **Workflow:** City-Pinned Persona Feeds, Search Insights & Cross-Market Trends (/v1/feed/persona-fyp/cities -> /v1/feed/persona-fyp -> /v1/search -> /v1/feed/landscape -> /v1/douyin/hot) #### GET /v1/search — Search - **Docs / Raw MD:** https://tikultra.com/docs/api/search | https://tikultra.com/docs/md/api/search - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /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/ - **Summary:** Search videos, users, LIVE, hashtags, sounds and places. - **Params:** keyword*:string, type:string, sort_type:string, publish_time:string, cursor:string, count:integer - **Workflow:** City-Pinned Persona Feeds, Search Insights & Cross-Market Trends (/v1/feed/persona-fyp/cities -> /v1/feed/persona-fyp -> /v1/search -> /v1/douyin/hot) #### GET /v1/search/suggestions — Search suggestions - **Docs / Raw MD:** https://tikultra.com/docs/api/search-suggestions | https://tikultra.com/docs/md/api/search-suggestions - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr - **Upstream:** /aweme/v1/search/sug/ - **Summary:** Suggestions for a partial keyword. - **Params:** keyword*:string - **Workflow:** City-Pinned Persona Feeds, Search Insights & Cross-Market Trends (/v1/feed/persona-fyp/cities -> /v1/feed/persona-fyp -> /v1/search -> /v1/search/suggestions -> /v1/douyin/hot) #### POST /v1/vision/ecom-search — Vision search - **Docs / Raw MD:** https://tikultra.com/docs/api/vision-search | https://tikultra.com/docs/md/api/vision-search - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr - **Upstream:** /aweme/v1/search/photo/bff/ecom/, /aweme/v1/search/vision/general/ - **Summary:** Reverse image search across Shop products and matching videos. - **Params:** image_url:string, image_base64:string, mode:string, region:string, city:string - **Workflow:** City-Pinned Persona Feeds, Search Insights & Cross-Market Trends (/v1/feed/persona-fyp/cities -> /v1/feed/persona-fyp -> /v1/search -> /v1/vision/ecom-search -> /v1/douyin/hot) #### POST /v1/tako/ask — Tako ask - **Docs / Raw MD:** https://tikultra.com/docs/api/tako-ask | https://tikultra.com/docs/md/api/tako-ask - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr - **Upstream:** /aweme/v1/tako/op/stream/ - **Summary:** 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. - **Params:** query*:string, aweme_id:string, region:string, city:string - **Workflow:** Tako AI Grounded Q&A & Connected Conversation Memory (/v1/tako/sug -> /v1/tako/ask -> /v1/tako/chat -> /v1/video/batch) #### POST /v1/tako/chat — Tako chat - **Docs / Raw MD:** https://tikultra.com/docs/api/tako-chat | https://tikultra.com/docs/md/api/tako-chat - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr - **Upstream:** /aweme/v1/tako/op/stream/ - **Summary:** A multi-turn conversation with Tako. - **Params:** messages*:object[], region:string, city:string - **Workflow:** Tako AI Grounded Q&A & Connected Conversation Memory (/v1/tako/sug -> /v1/tako/ask -> /v1/tako/chat -> /v1/video/batch) #### GET /v1/tako/sug — Tako suggestions - **Docs / Raw MD:** https://tikultra.com/docs/api/tako-sug | https://tikultra.com/docs/md/api/tako-sug - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr - **Upstream:** /aweme/v1/tako/sug/ - **Summary:** Prompts Tako suggests for a video or topic. - **Params:** aweme_id:string, query:string - **Workflow:** Tako AI Grounded Q&A & Connected Conversation Memory (/v1/tako/sug -> /v1/tako/ask -> /v1/tako/chat -> /v1/video/batch) #### GET /v1/tako/conversation — Tako conversation - **Docs / Raw MD:** https://tikultra.com/docs/api/tako-conversation | https://tikultra.com/docs/md/api/tako-conversation - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 10 cr - **Upstream:** /aweme/v1/tako/conversation/message/list/ - **Summary:** Messages in one of a connected account's Tako conversations. - **Params:** account_id*:string, conversation_id*:string - **Workflow:** Tako AI Grounded Q&A & Connected Conversation Memory (/v1/tako/sug -> /v1/tako/ask -> /v1/tako/chat -> /v1/tako/conversation -> /v1/video/batch) #### GET /v1/tako/inbox — Tako inbox - **Docs / Raw MD:** https://tikultra.com/docs/api/tako-inbox | https://tikultra.com/docs/md/api/tako-inbox - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 10 cr - **Upstream:** /aweme/v1/tako/inbox/message/list/ - **Summary:** A connected account's Tako inbox. - **Params:** account_id*:string - **Workflow:** Tako AI Grounded Q&A & Connected Conversation Memory (/v1/tako/sug -> /v1/tako/ask -> /v1/tako/chat -> /v1/tako/inbox -> /v1/video/batch) #### GET /v1/tako/memory — Tako memory - **Docs / Raw MD:** https://tikultra.com/docs/api/tako-memory | https://tikultra.com/docs/md/api/tako-memory - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 10 cr - **Upstream:** /aweme/v1/tako/memory/list/ - **Summary:** What Tako remembers for a connected account. - **Params:** account_id*:string - **Workflow:** Tako AI Grounded Q&A & Connected Conversation Memory (/v1/tako/sug -> /v1/tako/ask -> /v1/tako/chat -> /v1/tako/memory -> /v1/video/batch) #### GET /v1/creator/search-insights — Search insights - **Docs / Raw MD:** https://tikultra.com/docs/api/search-insights | https://tikultra.com/docs/md/api/search-insights - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /tiktok/v1/creator/search_insights/topics/ - **Summary:** Studio search topics with content gaps. - **Params:** keyword*:string, region:string, city:string, cursor:string, count:integer - **Workflow:** City-Pinned Persona Feeds, Search Insights & Cross-Market Trends (/v1/feed/persona-fyp/cities -> /v1/feed/persona-fyp -> /v1/search -> /v1/creator/search-insights -> /v1/douyin/hot) #### GET /v1/creator/search-insights/detail — Search insight detail - **Docs / Raw MD:** https://tikultra.com/docs/api/search-insights-detail | https://tikultra.com/docs/md/api/search-insights-detail - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr - **Upstream:** /tiktok/v1/creator/search_insights/detail/ - **Summary:** One search topic: volume, gap and related queries. - **Params:** topic_id*:string, region:string, city:string - **Workflow:** City-Pinned Persona Feeds, Search Insights & Cross-Market Trends (/v1/feed/persona-fyp/cities -> /v1/feed/persona-fyp -> /v1/search -> /v1/creator/search-insights/detail -> /v1/douyin/hot) #### GET /v1/creator/search-insights/trend — Search insight trend - **Docs / Raw MD:** https://tikultra.com/docs/api/search-insights-trend | https://tikultra.com/docs/md/api/search-insights-trend - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr - **Upstream:** /tiktok/v1/creator/search_insights/detail/ - **Summary:** Search volume over time for a topic. - **Params:** topic_id*:string, region:string, city:string - **Workflow:** City-Pinned Persona Feeds, Search Insights & Cross-Market Trends (/v1/feed/persona-fyp/cities -> /v1/feed/persona-fyp -> /v1/search -> /v1/creator/search-insights/trend -> /v1/douyin/hot) #### GET /v1/creator/search-insights/videos — Search insight videos - **Docs / Raw MD:** https://tikultra.com/docs/api/search-insights-videos | https://tikultra.com/docs/md/api/search-insights-videos - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /tiktok/v1/creator/search_insights/detail/ - **Summary:** Top videos for a search topic. - **Params:** topic_id*:string, region:string, city:string, cursor:string, count:integer - **Workflow:** City-Pinned Persona Feeds, Search Insights & Cross-Market Trends (/v1/feed/persona-fyp/cities -> /v1/feed/persona-fyp -> /v1/search -> /v1/creator/search-insights/videos -> /v1/douyin/hot) #### GET /v1/creator/recommended-terms — Recommended creator terms - **Docs / Raw MD:** https://tikultra.com/docs/api/creator-recommended-terms | https://tikultra.com/docs/md/api/creator-recommended-terms - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /tiktok/v1/creator/search_insights/recommended_terms/ - **Summary:** Breakout search terms and content-gap topics recommended for creators. - **Params:** category:string, region:string, city:string - **Workflow:** City-Pinned Persona Feeds, Search Insights & Cross-Market Trends (/v1/feed/persona-fyp/cities -> /v1/feed/persona-fyp -> /v1/search -> /v1/creator/recommended-terms -> /v1/douyin/hot) #### GET /v1/douyin/hot — Douyin hot list - **Docs / Raw MD:** https://tikultra.com/docs/api/douyin-hot | https://tikultra.com/docs/md/api/douyin-hot - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /aweme/v1/hot/search/list/ - **Summary:** The Douyin hot search list. - **Params:** none (x-api-key header only) - **Workflow:** City-Pinned Persona Feeds, Search Insights & Cross-Market Trends (/v1/feed/persona-fyp/cities -> /v1/feed/persona-fyp -> /v1/search -> /v1/douyin/hot) #### GET /v1/douyin/search — Douyin hot search - **Docs / Raw MD:** https://tikultra.com/docs/api/douyin-search | https://tikultra.com/docs/md/api/douyin-search - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /aweme/v1/hot/search/list/ - **Summary:** The Douyin hot search board for a keyword. - **Params:** keyword*:string - **Workflow:** City-Pinned Persona Feeds, Search Insights & Cross-Market Trends (/v1/feed/persona-fyp/cities -> /v1/feed/persona-fyp -> /v1/search -> /v1/douyin/search -> /v1/douyin/hot) #### GET /v1/douyin/brand — Douyin brand board - **Docs / Raw MD:** https://tikultra.com/docs/api/douyin-brand | https://tikultra.com/docs/md/api/douyin-brand - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /aweme/v1/hot/search/list/ - **Summary:** The Douyin brand board. - **Params:** category:string - **Workflow:** City-Pinned Persona Feeds, Search Insights & Cross-Market Trends (/v1/feed/persona-fyp/cities -> /v1/feed/persona-fyp -> /v1/search -> /v1/douyin/brand -> /v1/douyin/hot) #### GET /v1/douyin/music — Douyin music board - **Docs / Raw MD:** https://tikultra.com/docs/api/douyin-music | https://tikultra.com/docs/md/api/douyin-music - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /aweme/v1/hot/search/list/ - **Summary:** The Douyin music board. - **Params:** none (x-api-key header only) - **Workflow:** City-Pinned Persona Feeds, Search Insights & Cross-Market Trends (/v1/feed/persona-fyp/cities -> /v1/feed/persona-fyp -> /v1/search -> /v1/douyin/music -> /v1/douyin/hot) ### TikTok Shop #### GET /v1/shop/product-page — Product page - **Docs / Raw MD:** https://tikultra.com/docs/api/shop-product-page | https://tikultra.com/docs/md/api/shop-product-page - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr - **Upstream:** /api/v2/shop/sdui_pdp/get, /api/v1/shop/item/product_info/get - **Summary:** The full SDUI product detail page the app renders: SKUs, prices, inventory, shipping, coupons and seller stats. - **Params:** product_id:string, url:string, region:string, city:string - **Workflow:** TikTok Shop SDUI Product Spy, Visual Search & Affiliate Discovery (/v1/shop/search -> /v1/shop/product-page -> /v1/shop/reviews -> /v1/shop/live-bag) #### POST /v1/shop/browse — Shop browse flow - **Docs / Raw MD:** https://tikultra.com/docs/api/shop-browse | https://tikultra.com/docs/md/api/shop-browse - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr - **Upstream:** /api/v1/mall/shop_tab/algorithm/reach/get, /api/v1/mall/homepage/bff/get, /api/v2/shop/sdui_pdp/get - **Summary:** Execute an organic Shop tab → Mall → search → PDP browse sequence. - **Params:** keyword:string, product_id:string, region:string, city:string - **Workflow:** TikTok Shop SDUI Product Spy, Visual Search & Affiliate Discovery (/v1/shop/search -> /v1/shop/product-page -> /v1/shop/reviews -> /v1/shop/browse -> /v1/shop/live-bag) #### GET /v1/shop/live-bag — LIVE shopping bag - **Docs / Raw MD:** https://tikultra.com/docs/api/live-bag | https://tikultra.com/docs/md/api/live-bag - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr - **Upstream:** /aweme/v2/oec/live/bag/assemble, /aweme/v2/oec/live/bag/tabs_and_products - **Summary:** Products pinned in a LIVE room, with prices and promos. - **Params:** room_id*:string, region:string, city:string - **Workflow:** TikTok Shop SDUI Product Spy, Visual Search & Affiliate Discovery (/v1/shop/search -> /v1/shop/product-page -> /v1/shop/reviews -> /v1/shop/live-bag) #### GET /v1/shop/search — Shop search - **Docs / Raw MD:** https://tikultra.com/docs/api/shop-search | https://tikultra.com/docs/md/api/shop-search - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /aweme/v1/search/single/bff/ecom/, /aweme/v1/search/pack_product/ecom/ - **Summary:** Search Shop products by keyword. - **Params:** keyword*:string, region:string, city:string, cursor:string, count:integer - **Workflow:** TikTok Shop SDUI Product Spy, Visual Search & Affiliate Discovery (/v1/shop/search -> /v1/shop/product-page -> /v1/shop/reviews -> /v1/shop/live-bag) #### GET /v1/shop/seller — Seller catalog - **Docs / Raw MD:** https://tikultra.com/docs/api/seller-catalog | https://tikultra.com/docs/md/api/seller-catalog - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /api/shop/v1/homepage/get, /api/shop/v1/product/list - **Summary:** A seller's storefront and catalog. - **Params:** seller_id*:string, region:string, city:string, cursor:string, count:integer - **Workflow:** TikTok Shop SDUI Product Spy, Visual Search & Affiliate Discovery (/v1/shop/search -> /v1/shop/product-page -> /v1/shop/reviews -> /v1/shop/seller -> /v1/shop/live-bag) #### GET /v1/shop/seller/categories — Seller categories - **Docs / Raw MD:** https://tikultra.com/docs/api/seller-categories | https://tikultra.com/docs/md/api/seller-categories - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr - **Upstream:** /api/shop/v1/category/list - **Summary:** Categories inside a seller's storefront. - **Params:** seller_id*:string, region:string, city:string - **Workflow:** TikTok Shop SDUI Product Spy, Visual Search & Affiliate Discovery (/v1/shop/search -> /v1/shop/product-page -> /v1/shop/reviews -> /v1/shop/seller/categories -> /v1/shop/live-bag) #### GET /v1/shop/seller/reviews — Seller reviews - **Docs / Raw MD:** https://tikultra.com/docs/api/seller-reviews | https://tikultra.com/docs/md/api/seller-reviews - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /api/v1/shop_review/list - **Summary:** Verified buyer reviews across a seller’s shop. - **Params:** seller_id*:string, region:string, city:string, cursor:string, count:integer - **Workflow:** TikTok Shop SDUI Product Spy, Visual Search & Affiliate Discovery (/v1/shop/search -> /v1/shop/product-page -> /v1/shop/reviews -> /v1/shop/seller/reviews -> /v1/shop/live-bag) #### GET /v1/shop/showcase — Creator showcase - **Docs / Raw MD:** https://tikultra.com/docs/api/showcase | https://tikultra.com/docs/md/api/showcase - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /api/showcase/v1/product/list, /api/showcase/v1/creator_info/get - **Summary:** Products in a creator's showcase. - **Params:** username:string, sec_uid:string, region:string, city:string, cursor:string, count:integer - **Workflow:** TikTok Shop SDUI Product Spy, Visual Search & Affiliate Discovery (/v1/shop/search -> /v1/shop/product-page -> /v1/shop/reviews -> /v1/shop/showcase -> /v1/shop/live-bag) #### GET /v1/shop/reviews — Product reviews - **Docs / Raw MD:** https://tikultra.com/docs/api/shop-reviews | https://tikultra.com/docs/md/api/shop-reviews - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /api/v1/review/list, /api/v1/shop_review/list - **Summary:** Buyer reviews of a product or shop. - **Params:** product_id:string, url:string, region:string, city:string, cursor:string, count:integer - **Workflow:** TikTok Shop SDUI Product Spy, Visual Search & Affiliate Discovery (/v1/shop/search -> /v1/shop/product-page -> /v1/shop/reviews -> /v1/shop/live-bag) #### GET /v1/shop/anchors — Shop anchors - **Docs / Raw MD:** https://tikultra.com/docs/api/shop-anchors | https://tikultra.com/docs/md/api/shop-anchors - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr - **Upstream:** /aweme/v1/anchor/aweme/ - **Summary:** Products anchored to a video. - **Params:** aweme_id*:string - **Workflow:** TikTok Shop SDUI Product Spy, Visual Search & Affiliate Discovery (/v1/shop/search -> /v1/shop/product-page -> /v1/shop/reviews -> /v1/shop/anchors -> /v1/shop/live-bag) #### GET /v1/shop/mall — Mall home - **Docs / Raw MD:** https://tikultra.com/docs/api/shop-mall | https://tikultra.com/docs/md/api/shop-mall - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr - **Upstream:** /api/v1/mall/homepage/bff/get - **Summary:** The Shop mall home page. - **Params:** region:string, city:string - **Workflow:** TikTok Shop SDUI Product Spy, Visual Search & Affiliate Discovery (/v1/shop/search -> /v1/shop/product-page -> /v1/shop/reviews -> /v1/shop/mall -> /v1/shop/live-bag) #### GET /v1/shop/tab — Shop tab - **Docs / Raw MD:** https://tikultra.com/docs/api/shop-tab | https://tikultra.com/docs/md/api/shop-tab - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr - **Upstream:** /api/v1/mall/shop_tab/algorithm/reach/get - **Summary:** The Shop tab recommendations. - **Params:** region:string, city:string - **Workflow:** TikTok Shop SDUI Product Spy, Visual Search & Affiliate Discovery (/v1/shop/search -> /v1/shop/product-page -> /v1/shop/reviews -> /v1/shop/tab -> /v1/shop/live-bag) #### GET /v1/shop/live-products — LIVE product pop-up - **Docs / Raw MD:** https://tikultra.com/docs/api/shop-live-products | https://tikultra.com/docs/md/api/shop-live-products - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr - **Upstream:** /aweme/v1/oec/live/product/pop - **Summary:** The product pop-up shown in a LIVE room. - **Params:** room_id*:string - **Workflow:** TikTok Shop SDUI Product Spy, Visual Search & Affiliate Discovery (/v1/shop/search -> /v1/shop/product-page -> /v1/shop/reviews -> /v1/shop/live-products -> /v1/shop/live-bag) #### GET /v1/shop/live-room — LIVE shop info - **Docs / Raw MD:** https://tikultra.com/docs/api/shop-live-room | https://tikultra.com/docs/md/api/shop-live-room - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr - **Upstream:** /aweme/v1/oec/live/room/common_info - **Summary:** Commerce info for a LIVE room. - **Params:** room_id*:string - **Workflow:** TikTok Shop SDUI Product Spy, Visual Search & Affiliate Discovery (/v1/shop/search -> /v1/shop/product-page -> /v1/shop/reviews -> /v1/shop/live-room -> /v1/shop/live-bag) #### GET /v1/shop/suggestions — Shop suggestions - **Docs / Raw MD:** https://tikultra.com/docs/api/shop-suggestions | https://tikultra.com/docs/md/api/shop-suggestions - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr - **Upstream:** /aweme/v1/search/sug/prefetch/ecom/ - **Summary:** Shop search suggestions. - **Params:** keyword*:string, region:string, city:string - **Workflow:** TikTok Shop SDUI Product Spy, Visual Search & Affiliate Discovery (/v1/shop/search -> /v1/shop/product-page -> /v1/shop/reviews -> /v1/shop/suggestions -> /v1/shop/live-bag) #### GET /v1/shop/creator — Shop creator - **Docs / Raw MD:** https://tikultra.com/docs/api/shop-creator | https://tikultra.com/docs/md/api/shop-creator - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr - **Upstream:** /api/shop/v1/creator/info/get - **Summary:** A creator's commerce profile. - **Params:** username:string, sec_uid:string, region:string, city:string - **Workflow:** TikTok Shop SDUI Product Spy, Visual Search & Affiliate Discovery (/v1/shop/search -> /v1/shop/product-page -> /v1/shop/reviews -> /v1/shop/creator -> /v1/shop/live-bag) #### GET /v1/shop/same-shop — More from this shop - **Docs / Raw MD:** https://tikultra.com/docs/api/same-shop | https://tikultra.com/docs/md/api/same-shop - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr - **Upstream:** /api/v1/shop/recommend/same_shop/get - **Summary:** Other products from the same shop. - **Params:** product_id:string, url:string, seller_id*:string, region:string, city:string - **Workflow:** TikTok Shop SDUI Product Spy, Visual Search & Affiliate Discovery (/v1/shop/search -> /v1/shop/product-page -> /v1/shop/reviews -> /v1/shop/same-shop -> /v1/shop/live-bag) #### GET /v1/shop/recommendations — Product recommendations - **Docs / Raw MD:** https://tikultra.com/docs/api/shop-recommendations | https://tikultra.com/docs/md/api/shop-recommendations - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr - **Upstream:** /api/v1/shop/pdp/recommendations/get - **Summary:** Products recommended on a product page. - **Params:** product_id:string, url:string, region:string, city:string - **Workflow:** TikTok Shop SDUI Product Spy, Visual Search & Affiliate Discovery (/v1/shop/search -> /v1/shop/product-page -> /v1/shop/reviews -> /v1/shop/recommendations -> /v1/shop/live-bag) #### GET /v1/shop/promotions — Promotions - **Docs / Raw MD:** https://tikultra.com/docs/api/shop-promotions | https://tikultra.com/docs/md/api/shop-promotions - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr - **Upstream:** /api/v1/shop/promotion_info/get - **Summary:** Active promotions on a product. - **Params:** product_id:string, url:string, region:string, city:string - **Workflow:** TikTok Shop SDUI Product Spy, Visual Search & Affiliate Discovery (/v1/shop/search -> /v1/shop/product-page -> /v1/shop/reviews -> /v1/shop/promotions -> /v1/shop/live-bag) #### GET /v1/shop/translation — Product translation - **Docs / Raw MD:** https://tikultra.com/docs/api/shop-translation | https://tikultra.com/docs/md/api/shop-translation - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 25 cr - **Upstream:** /aweme/v1/oec/content/anchors/get_product_translation_ability - **Summary:** Whether a product listing can be translated. - **Params:** product_id:string, url:string, region:string, city:string - **Workflow:** TikTok Shop SDUI Product Spy, Visual Search & Affiliate Discovery (/v1/shop/search -> /v1/shop/product-page -> /v1/shop/reviews -> /v1/shop/translation -> /v1/shop/live-bag) ### LIVE rooms #### GET /v1/live/room — LIVE room - **Docs / Raw MD:** https://tikultra.com/docs/api/live-room | https://tikultra.com/docs/md/api/live-room - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /webcast/room/enter/, /webcast/room/info/ - **Summary:** Room state, host, viewer counts and stream metadata. - **Params:** room_id:string, username:string, url:string - **Workflow:** LIVE Room Discovery, Stream URLs & Real-Time Webcast Chat (/v1/live/recommended -> /v1/live/room -> /v1/live/chat -> /v1/live/audience) #### GET /v1/live/check-alive — Is LIVE - **Docs / Raw MD:** https://tikultra.com/docs/api/live-check-alive | https://tikultra.com/docs/md/api/live-check-alive - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr - **Upstream:** /webcast/room/check_alive/ - **Summary:** Whether rooms are live right now. - **Params:** room_ids*:string - **Workflow:** LIVE Room Discovery, Stream URLs & Real-Time Webcast Chat (/v1/live/recommended -> /v1/live/room -> /v1/live/chat -> /v1/live/check-alive -> /v1/live/audience) #### GET /v1/live/chat — LIVE chat - **Docs / Raw MD:** https://tikultra.com/docs/api/live-chat | https://tikultra.com/docs/md/api/live-chat - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /webcast/im/fetch/ - **Summary:** Decoded chat, gift and room events. - **Params:** room_id*:string, cursor:string - **Workflow:** LIVE Room Discovery, Stream URLs & Real-Time Webcast Chat (/v1/live/recommended -> /v1/live/room -> /v1/live/chat -> /v1/live/audience) #### GET /v1/live/with-chat — LIVE room with chat - **Docs / Raw MD:** https://tikultra.com/docs/api/live-with-chat | https://tikultra.com/docs/md/api/live-with-chat - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /webcast/room/info/, /webcast/im/fetch/ - **Summary:** Room state and the latest chat events in one call. - **Params:** room_id*:string, cursor:string - **Workflow:** LIVE Room Discovery, Stream URLs & Real-Time Webcast Chat (/v1/live/recommended -> /v1/live/room -> /v1/live/chat -> /v1/live/with-chat -> /v1/live/audience) #### GET /v1/live/stream — LIVE stream URLs - **Docs / Raw MD:** https://tikultra.com/docs/api/live-stream | https://tikultra.com/docs/md/api/live-stream - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /webcast/room/info/ - **Summary:** FLV and HLS stream URLs at each quality. - **Params:** room_id*:string - **Workflow:** LIVE Room Discovery, Stream URLs & Real-Time Webcast Chat (/v1/live/recommended -> /v1/live/room -> /v1/live/chat -> /v1/live/stream -> /v1/live/audience) #### GET /v1/live/audience — LIVE audience - **Docs / Raw MD:** https://tikultra.com/docs/api/live-audience | https://tikultra.com/docs/md/api/live-audience - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /webcast/ranklist/online_audience/ - **Summary:** The online audience ranking. - **Params:** room_id*:string - **Workflow:** LIVE Room Discovery, Stream URLs & Real-Time Webcast Chat (/v1/live/recommended -> /v1/live/room -> /v1/live/chat -> /v1/live/audience) #### GET /v1/live/ranking — LIVE hourly ranking - **Docs / Raw MD:** https://tikultra.com/docs/api/live-ranking | https://tikultra.com/docs/md/api/live-ranking - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /webcast/ranklist/hour/ - **Summary:** The hourly LIVE ranking. - **Params:** region:string, city:string - **Workflow:** LIVE Room Discovery, Stream URLs & Real-Time Webcast Chat (/v1/live/recommended -> /v1/live/room -> /v1/live/chat -> /v1/live/ranking -> /v1/live/audience) #### GET /v1/live/gifts — LIVE gift catalog - **Docs / Raw MD:** https://tikultra.com/docs/api/live-gifts | https://tikultra.com/docs/md/api/live-gifts - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /webcast/gift/list/ - **Summary:** The gifts available in a room, with coin prices. - **Params:** room_id*:string - **Workflow:** LIVE Room Discovery, Stream URLs & Real-Time Webcast Chat (/v1/live/recommended -> /v1/live/room -> /v1/live/chat -> /v1/live/gifts -> /v1/live/audience) #### GET /v1/live/recommended — Recommended LIVE - **Docs / Raw MD:** https://tikultra.com/docs/api/live-recommended | https://tikultra.com/docs/md/api/live-recommended - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /webcast/feed/ - **Summary:** Rooms the LIVE feed recommends. - **Params:** region:string, city:string, count:integer - **Workflow:** LIVE Room Discovery, Stream URLs & Real-Time Webcast Chat (/v1/live/recommended -> /v1/live/room -> /v1/live/chat -> /v1/live/audience) #### GET /v1/live/goody-bag — Goody bag - **Docs / Raw MD:** https://tikultra.com/docs/api/goody-bag | https://tikultra.com/docs/md/api/goody-bag - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /webcast/goody_bag/detail/ - **Summary:** Details of a room’s goody bag. - **Params:** room_id*:string - **Workflow:** LIVE Room Discovery, Stream URLs & Real-Time Webcast Chat (/v1/live/recommended -> /v1/live/room -> /v1/live/chat -> /v1/live/goody-bag -> /v1/live/audience) #### GET /v1/live/bag-items — LIVE bag items - **Docs / Raw MD:** https://tikultra.com/docs/api/live-bag-items | https://tikultra.com/docs/md/api/live-bag-items - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /aweme/v2/oec/live/bag/assemble - **Summary:** Every product in a room’s shopping bag. - **Params:** room_id*:string - **Workflow:** LIVE Room Discovery, Stream URLs & Real-Time Webcast Chat (/v1/live/recommended -> /v1/live/room -> /v1/live/chat -> /v1/live/bag-items -> /v1/live/audience) ### Series, sounds, hashtags & places #### GET /v1/series/mini-dramas — Mini dramas - **Docs / Raw MD:** https://tikultra.com/docs/api/mini-dramas | https://tikultra.com/docs/md/api/mini-dramas - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /tiktok/v1/paid_content/mini_drama/feed/, /tiktok/v1/paid_content/mini_drama/tabs/ - **Summary:** The short-drama catalog with episode metrics. - **Params:** tab_id:string, cursor:string, count:integer, region:string, city:string - **Workflow:** Sounds, Hashtags, Mini Dramas, Effects & Template Tracking (/v1/music/charts -> /v1/music -> /v1/series/mini-dramas -> /v1/series/mini-dramas/tabs) #### GET /v1/series/mini-dramas/tabs — Mini drama tabs - **Docs / Raw MD:** https://tikultra.com/docs/api/mini-drama-tabs | https://tikultra.com/docs/md/api/mini-drama-tabs - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /tiktok/v1/paid_content/mini_drama/tabs/ - **Summary:** The tabs of the short-drama catalog. - **Params:** region:string, city:string - **Workflow:** Sounds, Hashtags, Mini Dramas, Effects & Template Tracking (/v1/music/charts -> /v1/music -> /v1/series/mini-dramas/tabs) #### GET /v1/series/mini-dramas/history — Mini drama watch history - **Docs / Raw MD:** https://tikultra.com/docs/api/mini-drama-history | https://tikultra.com/docs/md/api/mini-drama-history - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 10 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /tiktok/v1/paid_content/mini_drama/watch_history/ - **Summary:** Short-drama watch history for a connected account. - **Params:** account_id*:string, cursor:string, count:integer - **Workflow:** Sounds, Hashtags, Mini Dramas, Effects & Template Tracking (/v1/music/charts -> /v1/music -> /v1/series/mini-dramas/history -> /v1/series/mini-dramas/tabs) #### GET /v1/series — Series - **Docs / Raw MD:** https://tikultra.com/docs/api/series | https://tikultra.com/docs/md/api/series - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /tiktok/v1/paid_content/collection/detail/ - **Summary:** One series: title, price and episodes. - **Params:** series_id*:string - **Workflow:** Sounds, Hashtags, Mini Dramas, Effects & Template Tracking (/v1/music/charts -> /v1/music -> /v1/series -> /v1/series/mini-dramas/tabs) #### GET /v1/series/videos — Series episodes - **Docs / Raw MD:** https://tikultra.com/docs/api/series-videos | https://tikultra.com/docs/md/api/series-videos - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /tiktok/v1/paid_content/collection/detail/ - **Summary:** The episodes of a series. - **Params:** series_id*:string, cursor:string, count:integer - **Workflow:** Sounds, Hashtags, Mini Dramas, Effects & Template Tracking (/v1/music/charts -> /v1/music -> /v1/series/videos -> /v1/series/mini-dramas/tabs) #### GET /v1/mix — Playlist - **Docs / Raw MD:** https://tikultra.com/docs/api/mix | https://tikultra.com/docs/md/api/mix - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /tiktok/v1/mix/detail/ - **Summary:** One playlist (mix). - **Params:** mix_id*:string - **Workflow:** Sounds, Hashtags, Mini Dramas, Effects & Template Tracking (/v1/music/charts -> /v1/music -> /v1/mix -> /v1/series/mini-dramas/tabs) #### GET /v1/mix/videos — Playlist videos - **Docs / Raw MD:** https://tikultra.com/docs/api/mix-videos | https://tikultra.com/docs/md/api/mix-videos - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /tiktok/v1/mix/aweme/ - **Summary:** The videos in a playlist. - **Params:** mix_id*:string, cursor:string, count:integer - **Workflow:** Sounds, Hashtags, Mini Dramas, Effects & Template Tracking (/v1/music/charts -> /v1/music -> /v1/mix/videos -> /v1/series/mini-dramas/tabs) #### GET /v1/music — Sound - **Docs / Raw MD:** https://tikultra.com/docs/api/music | https://tikultra.com/docs/md/api/music - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /aweme/v1/music/detail/, /aweme/v1/music/aweme/ - **Summary:** A sound and the videos that use it. - **Params:** music_id*:string, cursor:string, count:integer - **Workflow:** Sounds, Hashtags, Mini Dramas, Effects & Template Tracking (/v1/music/charts -> /v1/music -> /v1/series/mini-dramas/tabs) #### GET /v1/music/fresh — Sound: newest videos - **Docs / Raw MD:** https://tikultra.com/docs/api/music-fresh | https://tikultra.com/docs/md/api/music-fresh - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /aweme/v1/music/fresh/aweme/ - **Summary:** The newest videos using a sound. - **Params:** music_id*:string, cursor:string, count:integer - **Workflow:** Sounds, Hashtags, Mini Dramas, Effects & Template Tracking (/v1/music/charts -> /v1/music -> /v1/music/fresh -> /v1/series/mini-dramas/tabs) #### GET /v1/music/user-original — Original sounds - **Docs / Raw MD:** https://tikultra.com/docs/api/music-user-original | https://tikultra.com/docs/md/api/music-user-original - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /aweme/v1/original/music/list/ - **Summary:** Original sounds a creator made. - **Params:** username:string, sec_uid:string, cursor:string, count:integer - **Workflow:** Sounds, Hashtags, Mini Dramas, Effects & Template Tracking (/v1/music/charts -> /v1/music -> /v1/music/user-original -> /v1/series/mini-dramas/tabs) #### GET /v1/music/charts — Sound charts - **Docs / Raw MD:** https://tikultra.com/docs/api/music-charts | https://tikultra.com/docs/md/api/music-charts - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /tiktok/chart/music/list/v1/ - **Summary:** The music charts. - **Params:** region:string, city:string - **Workflow:** Sounds, Hashtags, Mini Dramas, Effects & Template Tracking (/v1/music/charts -> /v1/music -> /v1/series/mini-dramas/tabs) #### GET /v1/hashtag — Hashtag - **Docs / Raw MD:** https://tikultra.com/docs/api/hashtag | https://tikultra.com/docs/md/api/hashtag - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /aweme/v1/challenge/detail/, /aweme/v1/challenge/aweme/ - **Summary:** A hashtag and its videos. - **Params:** hashtag*:string, cursor:string, count:integer - **Workflow:** Sounds, Hashtags, Mini Dramas, Effects & Template Tracking (/v1/music/charts -> /v1/music -> /v1/hashtag -> /v1/series/mini-dramas/tabs) #### GET /v1/hashtag/trending — Trending hashtags - **Docs / Raw MD:** https://tikultra.com/docs/api/hashtag-trending | https://tikultra.com/docs/md/api/hashtag-trending - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 10 cr - **Upstream:** /aweme/v2/category/list/ - **Summary:** Trending hashtag categories. - **Params:** region:string, city:string - **Workflow:** Sounds, Hashtags, Mini Dramas, Effects & Template Tracking (/v1/music/charts -> /v1/music -> /v1/hashtag/trending -> /v1/series/mini-dramas/tabs) #### GET /v1/sticker — Effect - **Docs / Raw MD:** https://tikultra.com/docs/api/sticker | https://tikultra.com/docs/md/api/sticker - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr - **Upstream:** /aweme/v1/sticker/detail/ - **Summary:** An effect and its stats. - **Params:** sticker_id*:string - **Workflow:** Sounds, Hashtags, Mini Dramas, Effects & Template Tracking (/v1/music/charts -> /v1/music -> /v1/sticker -> /v1/series/mini-dramas/tabs) #### GET /v1/poi — Place - **Docs / Raw MD:** https://tikultra.com/docs/api/poi | https://tikultra.com/docs/md/api/poi - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr - **Upstream:** /tiktok/poi/get/v1, /tiktok/poi/review/get/v2 - **Summary:** A place, its reviews and videos tagged there. - **Params:** poi_id*:string - **Workflow:** Sounds, Hashtags, Mini Dramas, Effects & Template Tracking (/v1/music/charts -> /v1/music -> /v1/poi -> /v1/series/mini-dramas/tabs) #### GET /v1/aistyle — AI style - **Docs / Raw MD:** https://tikultra.com/docs/api/aistyle | https://tikultra.com/docs/md/api/aistyle - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr - **Upstream:** /tiktok/v1/aistyle/detail - **Summary:** An AI style effect. - **Params:** style_id*:string - **Workflow:** Sounds, Hashtags, Mini Dramas, Effects & Template Tracking (/v1/music/charts -> /v1/music -> /v1/aistyle -> /v1/series/mini-dramas/tabs) #### GET /v1/aistyle/videos — AI style videos - **Docs / Raw MD:** https://tikultra.com/docs/api/aistyle-videos | https://tikultra.com/docs/md/api/aistyle-videos - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /tiktok/v1/aistyle/aweme - **Summary:** Videos made with an AI style. - **Params:** style_id*:string, cursor:string, count:integer - **Workflow:** Sounds, Hashtags, Mini Dramas, Effects & Template Tracking (/v1/music/charts -> /v1/music -> /v1/aistyle/videos -> /v1/series/mini-dramas/tabs) #### GET /v1/capcut/template — CapCut template - **Docs / Raw MD:** https://tikultra.com/docs/api/capcut-template | https://tikultra.com/docs/md/api/capcut-template - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr - **Upstream:** /tiktok/v1/capcut/template/ - **Summary:** A CapCut template. - **Params:** template_id*:string - **Workflow:** Sounds, Hashtags, Mini Dramas, Effects & Template Tracking (/v1/music/charts -> /v1/music -> /v1/capcut/template -> /v1/series/mini-dramas/tabs) #### GET /v1/capcut/videos — CapCut template videos - **Docs / Raw MD:** https://tikultra.com/docs/api/capcut-videos | https://tikultra.com/docs/md/api/capcut-videos - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /tiktok/v1/capcut/template/ - **Summary:** Videos made from a CapCut template. - **Params:** template_id*:string, cursor:string, count:integer - **Workflow:** Sounds, Hashtags, Mini Dramas, Effects & Template Tracking (/v1/music/charts -> /v1/music -> /v1/capcut/videos -> /v1/series/mini-dramas/tabs) #### GET /v1/mv-template — MV template - **Docs / Raw MD:** https://tikultra.com/docs/api/mv-template | https://tikultra.com/docs/md/api/mv-template - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr - **Upstream:** /aweme/v1/mv/detail/ - **Summary:** A photo-to-video (MV) template. - **Params:** template_id*:string - **Workflow:** Sounds, Hashtags, Mini Dramas, Effects & Template Tracking (/v1/music/charts -> /v1/music -> /v1/mv-template -> /v1/series/mini-dramas/tabs) #### GET /v1/translate — Translate - **Docs / Raw MD:** https://tikultra.com/docs/api/translate | https://tikultra.com/docs/md/api/translate - **Pool:** Managed Guest Pool · LeanPool | **Access:** Every plan | **Cost:** 5 cr - **Upstream:** /aweme/v1/content/translation/ - **Summary:** TikTok's own translation of a caption or comment. - **Params:** text*:string, target:string - **Workflow:** Sounds, Hashtags, Mini Dramas, Effects & Template Tracking (/v1/music/charts -> /v1/music -> /v1/translate -> /v1/series/mini-dramas/tabs) ### Connected sessions #### POST /v1/account/import — Import session - **Docs / Raw MD:** https://tikultra.com/docs/api/import-session | https://tikultra.com/docs/md/api/import-session - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 25 cr - **Upstream:** /passport/account/info/v2/, /aweme/v1/user/profile/self/ - **Summary:** Bind a session you own to a dedicated mobile context. - **Params:** session_id*:string, cookies:object, device_id:string, os:string, app_flavour:string, app_version:string, region:string, city:string - **Workflow:** Account Sign-In, Session Import & Health Lifecycle (/v1/account/import -> /v1/account/login/otp/verify -> /v1/account/health -> /v1/account/session) #### POST /v1/account/login/otp/send — Email sign-in: send code - **Docs / Raw MD:** https://tikultra.com/docs/api/otp-send | https://tikultra.com/docs/md/api/otp-send - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 25 cr - **Upstream:** /passport/email/send_code/ - **Summary:** Send a one-time sign-in code to your account’s email. - **Params:** email*:string, os:string, app_flavour:string, app_version:string, region:string, city:string - **Workflow:** Account Sign-In, Session Import & Health Lifecycle (/v1/account/import -> /v1/account/login/otp/verify -> /v1/account/health -> /v1/account/login/otp/send -> /v1/account/session) #### POST /v1/account/login/otp/verify — Email sign-in: verify code - **Docs / Raw MD:** https://tikultra.com/docs/api/otp-verify | https://tikultra.com/docs/md/api/otp-verify - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 25 cr - **Upstream:** /passport/email/login/ - **Summary:** Finish signing in with the one-time code. - **Params:** email*:string, code*:string - **Workflow:** Account Sign-In, Session Import & Health Lifecycle (/v1/account/import -> /v1/account/login/otp/verify -> /v1/account/health -> /v1/account/session) #### POST /v1/account/register/email/send — Email registration: send code - **Docs / Raw MD:** https://tikultra.com/docs/api/register-email-send | https://tikultra.com/docs/md/api/register-email-send - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Scale and up | **Cost:** 25 cr - **Upstream:** /passport/user/check_email_registered, /passport/email/send_code/ - **Summary:** Start 2-step email registration on a dedicated FullPool device context using your own residential/mobile proxy (Scale+). - **Params:** email*:string, password*:string, birthday*:string, proxy*:string, context_id:string, warmup:boolean, os:string, app_flavour:string, app_version:string, region:string, city:string - **Workflow:** 2-Step Scale+ Email Registration with BYO Proxy (/v1/user/check-username -> /v1/account/register/email/send -> /v1/account/register/email/verify -> /v1/account/profile/username -> /v1/account/warm/niche) #### POST /v1/account/register/email/verify — Email registration: verify code - **Docs / Raw MD:** https://tikultra.com/docs/api/register-email-verify | https://tikultra.com/docs/md/api/register-email-verify - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Scale and up | **Cost:** 50 cr - **Upstream:** /passport/email/register_verify_login/ - **Summary:** Complete 2-step email registration with the OTP code and persist a caller-owned Connected Workspace account_id (Scale+). - **Params:** context_id*:string, email*:string, code*:string, password*:string, birthday*:string, proxy*:string - **Workflow:** 2-Step Scale+ Email Registration with BYO Proxy (/v1/user/check-username -> /v1/account/register/email/send -> /v1/account/register/email/verify -> /v1/account/profile/username -> /v1/account/warm/niche) #### POST /v1/account/session — Refresh session - **Docs / Raw MD:** https://tikultra.com/docs/api/session-state | https://tikultra.com/docs/md/api/session-state - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 25 cr - **Upstream:** /passport/account/info/v2/ - **Summary:** Refresh a session and return its state. - **Params:** account_id*:string - **Workflow:** Account Sign-In, Session Import & Health Lifecycle (/v1/account/import -> /v1/account/login/otp/verify -> /v1/account/health -> /v1/account/session) #### GET /v1/account/health — Session health - **Docs / Raw MD:** https://tikultra.com/docs/api/account-health | https://tikultra.com/docs/md/api/account-health - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 15 cr - **Upstream:** /passport/account/info/v2/ - **Summary:** Whether a session is healthy, needs a refresh or has expired. - **Params:** account_id*:string - **Workflow:** Account Sign-In, Session Import & Health Lifecycle (/v1/account/import -> /v1/account/login/otp/verify -> /v1/account/health -> /v1/account/session) #### POST /v1/account/session/cold-reopen — Cold reopen lifecycle - **Docs / Raw MD:** https://tikultra.com/docs/api/session-cold-reopen | https://tikultra.com/docs/md/api/session-cold-reopen - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 15 cr - **Upstream:** /service/2/app_log/, /ri/report, /aweme/v1/feed/ - **Summary:** Execute cold process reopen sequence (AppLog launch, SceneColdStart, FYP pull, auto-report). - **Params:** account_id*:string - **Workflow:** Mobile Process Lifecycle, AppLog Telemetry & Niche Warming (/v1/account/session/cold-reopen -> /v1/account/warm/niche -> /v1/account/warm/watch-item -> /v1/account/session/background) #### POST /v1/account/session/warm-reopen — Warm reopen lifecycle - **Docs / Raw MD:** https://tikultra.com/docs/api/session-warm-reopen | https://tikultra.com/docs/md/api/session-warm-reopen - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 15 cr - **Upstream:** /service/2/app_log/, /ri/report, /aweme/v1/feed/ - **Summary:** Execute foreground resume lifecycle sequence (AppLog foreground launch, SceneSwitchToForeground, FYP pull). - **Params:** account_id*:string - **Workflow:** Mobile Process Lifecycle, AppLog Telemetry & Niche Warming (/v1/account/session/cold-reopen -> /v1/account/warm/niche -> /v1/account/warm/watch-item -> /v1/account/session/warm-reopen -> /v1/account/session/background) #### POST /v1/account/session/background — Session background flush - **Docs / Raw MD:** https://tikultra.com/docs/api/session-background | https://tikultra.com/docs/md/api/session-background - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 10 cr - **Upstream:** /service/2/app_log/ - **Summary:** Flush stay_out and terminate AppLog telemetry when backgrounding a session. - **Params:** account_id*:string, stay_duration_ms:integer - **Workflow:** Mobile Process Lifecycle, AppLog Telemetry & Niche Warming (/v1/account/session/cold-reopen -> /v1/account/warm/niche -> /v1/account/warm/watch-item -> /v1/account/session/background) #### POST /v1/account/session/tick — Session heartbeat tick - **Docs / Raw MD:** https://tikultra.com/docs/api/session-tick | https://tikultra.com/docs/md/api/session-tick - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 10 cr - **Upstream:** /ri/report, /service/2/app_log/ - **Summary:** Execute periodic in-session SceneAutoReport and AppLog heartbeat tick. - **Params:** account_id*:string - **Workflow:** Mobile Process Lifecycle, AppLog Telemetry & Niche Warming (/v1/account/session/cold-reopen -> /v1/account/warm/niche -> /v1/account/warm/watch-item -> /v1/account/session/tick -> /v1/account/session/background) #### POST /v1/account/applog — Flush AppLog batch - **Docs / Raw MD:** https://tikultra.com/docs/api/account-applog | https://tikultra.com/docs/md/api/account-applog - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 15 cr - **Upstream:** /service/2/app_log/ - **Summary:** Encode and flush a TTEncrypt AppLog event batch for a connected session. - **Params:** account_id*:string, events*:object[] - **Workflow:** Mobile Process Lifecycle, AppLog Telemetry & Niche Warming (/v1/account/session/cold-reopen -> /v1/account/warm/niche -> /v1/account/warm/watch-item -> /v1/account/applog -> /v1/account/session/background) #### POST /v1/account/realtime-feedback — Realtime feed feedback - **Docs / Raw MD:** https://tikultra.com/docs/api/account-realtime-feedback | https://tikultra.com/docs/md/api/account-realtime-feedback - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 15 cr - **Upstream:** /tiktok/v1/realtime/feedback/ - **Summary:** Dispatch real-time feed and video watch interaction signals. - **Params:** account_id*:string, aweme_id*:string, action_type*:string, play_duration_ms:integer - **Workflow:** Mobile Process Lifecycle, AppLog Telemetry & Niche Warming (/v1/account/session/cold-reopen -> /v1/account/warm/niche -> /v1/account/warm/watch-item -> /v1/account/realtime-feedback -> /v1/account/session/background) #### POST /v1/account/warm/niche — Warm session for niche - **Docs / Raw MD:** https://tikultra.com/docs/api/warm-niche | https://tikultra.com/docs/md/api/warm-niche - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 25 cr - **Upstream:** /aweme/v1/feed/, /aweme/v1/general/search/single/ - **Summary:** Calibrate a connected session’s For You feed toward a topic. - **Params:** account_id*:string, niche*:string, duration_sec:integer - **Workflow:** Mobile Process Lifecycle, AppLog Telemetry & Niche Warming (/v1/account/session/cold-reopen -> /v1/account/warm/niche -> /v1/account/warm/watch-item -> /v1/account/session/background) #### POST /v1/account/warm/seed-accounts — Warm from seed creators - **Docs / Raw MD:** https://tikultra.com/docs/api/warm-seed-accounts | https://tikultra.com/docs/md/api/warm-seed-accounts - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 25 cr - **Upstream:** /aweme/v1/user/profile/other/, /aweme/v1/aweme/post/, /service/2/app_log/ - **Summary:** Calibrate a connected session by visiting seed creator profiles and watching recent posts. - **Params:** account_id*:string, usernames*:string[], watch_per_profile:integer - **Workflow:** Mobile Process Lifecycle, AppLog Telemetry & Niche Warming (/v1/account/session/cold-reopen -> /v1/account/warm/niche -> /v1/account/warm/watch-item -> /v1/account/warm/seed-accounts -> /v1/account/session/background) #### POST /v1/account/warm/watch-item — Watch item telemetry - **Docs / Raw MD:** https://tikultra.com/docs/api/warm-watch-item | https://tikultra.com/docs/md/api/warm-watch-item - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 15 cr - **Upstream:** /aweme/v1/aweme/stats/, /service/2/app_log/ - **Summary:** Record a realistic single-video watch with AwemeStats and AppLog play events. - **Params:** account_id*:string, aweme_id*:string, play_delta_ms:integer, finish:boolean - **Workflow:** Mobile Process Lifecycle, AppLog Telemetry & Niche Warming (/v1/account/session/cold-reopen -> /v1/account/warm/niche -> /v1/account/warm/watch-item -> /v1/account/session/background) #### GET /v1/account/upload/precheck — Upload precheck - **Docs / Raw MD:** https://tikultra.com/docs/api/upload-precheck | https://tikultra.com/docs/md/api/upload-precheck - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 15 cr - **Upstream:** /tiktok/v1/infringement/precheck/ - **Summary:** Check direct-post eligibility and duration limits before uploading. - **Params:** account_id*:string - **Workflow:** One-Call Native Publishing & Creator Studio Analytics (/v1/account/health -> /v1/account/upload/precheck -> /v1/account/upload/video -> /v1/account/studio/overview) #### POST /v1/account/upload/video — Publish video - **Docs / Raw MD:** https://tikultra.com/docs/api/upload-video | https://tikultra.com/docs/md/api/upload-video - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 100 cr - **Upstream:** /aweme/v1/upload/authkey/, /tiktok/v1/infringement/precheck/, /aweme/v1/create/aweme/ - **Summary:** 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. - **Params:** account_id*:string, file:file, video_url:string, video_base64:string, caption:string, hashtags:string[], mentions:string[], visibility:string, allow_comment:boolean, allow_duet:boolean, allow_stitch:boolean, allow_download:boolean, cover_timestamp_ms:integer, poi_id:string, music_id:string, schedule_time:integer, aigc_generated:boolean, shop_product_ids:string[], os:string, app_flavour:string, app_version:string - **Workflow:** One-Call Native Publishing & Creator Studio Analytics (/v1/account/health -> /v1/account/upload/precheck -> /v1/account/upload/video -> /v1/account/studio/overview) #### POST /v1/account/upload/slideshow — Publish slideshow - **Docs / Raw MD:** https://tikultra.com/docs/api/upload-slideshow | https://tikultra.com/docs/md/api/upload-slideshow - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 100 cr - **Upstream:** /aweme/v1/upload/authkey/, /aweme/v1/create/photo/ - **Summary:** Upload and publish a photo carousel in one call. - **Params:** account_id*:string, files[]:file[], images:string[], title:string, caption:string, music_id:string, visibility:string, allow_comment:boolean, poi_id:string, os:string, app_flavour:string, app_version:string - **Workflow:** One-Call Native Publishing & Creator Studio Analytics (/v1/account/health -> /v1/account/upload/precheck -> /v1/account/upload/video -> /v1/account/upload/slideshow -> /v1/account/studio/overview) #### POST /v1/account/upload/delete — Delete post - **Docs / Raw MD:** https://tikultra.com/docs/api/delete-post | https://tikultra.com/docs/md/api/delete-post - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 15 cr - **Upstream:** /aweme/v1/aweme/delete/ - **Summary:** Delete one of your posts. - **Params:** account_id*:string, aweme_id*:string - **Workflow:** One-Call Native Publishing & Creator Studio Analytics (/v1/account/health -> /v1/account/upload/precheck -> /v1/account/upload/video -> /v1/account/upload/delete -> /v1/account/studio/overview) #### POST /v1/account/post/visibility — Post visibility - **Docs / Raw MD:** https://tikultra.com/docs/api/post-visibility | https://tikultra.com/docs/md/api/post-visibility - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 15 cr - **Upstream:** /aweme/v1/aweme/modify/visibility/ - **Summary:** Change who can see one of your posts. - **Params:** account_id*:string, aweme_id*:string, visibility*:string - **Workflow:** One-Call Native Publishing & Creator Studio Analytics (/v1/account/health -> /v1/account/upload/precheck -> /v1/account/upload/video -> /v1/account/post/visibility -> /v1/account/studio/overview) #### GET /v1/account/upload/places — Places for a post - **Docs / Raw MD:** https://tikultra.com/docs/api/upload-places | https://tikultra.com/docs/md/api/upload-places - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 15 cr - **Upstream:** /tiktok/poi/api/place/search - **Summary:** Search places to tag on a post. - **Params:** account_id*:string, keyword*:string - **Workflow:** One-Call Native Publishing & Creator Studio Analytics (/v1/account/health -> /v1/account/upload/precheck -> /v1/account/upload/video -> /v1/account/upload/places -> /v1/account/studio/overview) #### POST /v1/account/profile/update — Update profile - **Docs / Raw MD:** https://tikultra.com/docs/api/profile-update | https://tikultra.com/docs/md/api/profile-update - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 25 cr - **Upstream:** /aweme/v1/commit/user/ - **Summary:** Change your nickname, bio or links. - **Params:** account_id*:string, nickname:string, signature:string, bio_url:string - **Workflow:** Rare @Username Availability Monitoring & Claiming (/v1/user/bulk-check -> /v1/user/check-username -> /v1/account/health -> /v1/account/profile/update -> /v1/account/profile/username) #### POST /v1/account/profile/username — Change username - **Docs / Raw MD:** https://tikultra.com/docs/api/profile-username | https://tikultra.com/docs/md/api/profile-username - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 25 cr - **Upstream:** /passport/login_name/update/ - **Summary:** Change your @username. - **Params:** account_id*:string, unique_id*:string - **Workflow:** Rare @Username Availability Monitoring & Claiming (/v1/user/bulk-check -> /v1/user/check-username -> /v1/account/health -> /v1/account/profile/username) #### POST /v1/account/profile/avatar — Change avatar - **Docs / Raw MD:** https://tikultra.com/docs/api/profile-avatar | https://tikultra.com/docs/md/api/profile-avatar - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 25 cr - **Upstream:** /aweme/v1/upload/image/ - **Summary:** Upload a new profile picture. - **Params:** account_id*:string, image_url*:string - **Workflow:** Rare @Username Availability Monitoring & Claiming (/v1/user/bulk-check -> /v1/user/check-username -> /v1/account/health -> /v1/account/profile/avatar -> /v1/account/profile/username) #### POST /v1/account/profile/privacy — Privacy settings - **Docs / Raw MD:** https://tikultra.com/docs/api/profile-privacy | https://tikultra.com/docs/md/api/profile-privacy - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 25 cr - **Upstream:** /tiktok/privacy/user/settings/update/v1 - **Summary:** Private account, who can comment, duet, stitch or message. - **Params:** account_id*:string, settings*:object - **Workflow:** Rare @Username Availability Monitoring & Claiming (/v1/user/bulk-check -> /v1/user/check-username -> /v1/account/health -> /v1/account/profile/privacy -> /v1/account/profile/username) #### POST /v1/account/settings — App settings - **Docs / Raw MD:** https://tikultra.com/docs/api/account-settings | https://tikultra.com/docs/md/api/account-settings - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 15 cr - **Upstream:** /aweme/v1/user/set/settings/ - **Summary:** Change account settings. - **Params:** account_id*:string, settings*:object - **Workflow:** Rare @Username Availability Monitoring & Claiming (/v1/user/bulk-check -> /v1/user/check-username -> /v1/account/health -> /v1/account/settings -> /v1/account/profile/username) #### POST /v1/account/wellbeing — Digital wellbeing - **Docs / Raw MD:** https://tikultra.com/docs/api/wellbeing | https://tikultra.com/docs/md/api/wellbeing - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 15 cr - **Upstream:** /tiktok/v1/digital_wellbeing/settings/ - **Summary:** Screen time and restricted mode settings. - **Params:** account_id*:string, settings*:object - **Workflow:** Rare @Username Availability Monitoring & Claiming (/v1/user/bulk-check -> /v1/user/check-username -> /v1/account/health -> /v1/account/wellbeing -> /v1/account/profile/username) #### GET /v1/account/studio/overview — Studio analytics overview - **Docs / Raw MD:** https://tikultra.com/docs/api/studio-overview | https://tikultra.com/docs/md/api/studio-overview - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 20 cr - **Upstream:** /tiktok/v1/analytics/search_studio_card/, /tiktok/v1/creator/overview/ - **Summary:** Creator Studio post views, profile views, net followers and top posts. - **Params:** account_id*:string, window_days:integer - **Workflow:** One-Call Native Publishing & Creator Studio Analytics (/v1/account/health -> /v1/account/upload/precheck -> /v1/account/upload/video -> /v1/account/studio/overview) #### GET /v1/account/studio/notifications — Studio notifications - **Docs / Raw MD:** https://tikultra.com/docs/api/studio-notifications | https://tikultra.com/docs/md/api/studio-notifications - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 20 cr - **Upstream:** /aweme/v1/notice/multi/ - **Summary:** Creator Studio milestones, policy notices and content-gap alerts. - **Params:** account_id*:string, cursor:string, count:integer - **Workflow:** One-Call Native Publishing & Creator Studio Analytics (/v1/account/health -> /v1/account/upload/precheck -> /v1/account/upload/video -> /v1/account/studio/notifications -> /v1/account/studio/overview) #### POST /v1/account/comment — Post comment - **Docs / Raw MD:** https://tikultra.com/docs/api/comment | https://tikultra.com/docs/md/api/comment - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 25 cr - **Upstream:** /aweme/v1/comment/publish/ - **Summary:** Comment, or reply to a comment on your posts. - **Params:** account_id*:string, aweme_id*:string, text*:string, reply_to_comment_id:string - **Workflow:** Comment Lead Mining, Replies & Moderation (/v1/video/comments -> /v1/video/comments/replies -> /v1/account/comment -> /v1/account/comment/like) #### POST /v1/account/comment/like — Like comment - **Docs / Raw MD:** https://tikultra.com/docs/api/comment-like | https://tikultra.com/docs/md/api/comment-like - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 15 cr - **Upstream:** /aweme/v1/comment/digg/ - **Summary:** Heart a comment on your post. - **Params:** account_id*:string, aweme_id*:string, comment_id*:string - **Workflow:** Comment Lead Mining, Replies & Moderation (/v1/video/comments -> /v1/video/comments/replies -> /v1/account/comment -> /v1/account/comment/like) #### POST /v1/account/comment/unlike — Unlike comment - **Docs / Raw MD:** https://tikultra.com/docs/api/comment-unlike | https://tikultra.com/docs/md/api/comment-unlike - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 15 cr - **Upstream:** /aweme/v1/comment/digg/ - **Summary:** Remove a heart from a comment. - **Params:** account_id*:string, aweme_id*:string, comment_id*:string - **Workflow:** Comment Lead Mining, Replies & Moderation (/v1/video/comments -> /v1/video/comments/replies -> /v1/account/comment -> /v1/account/comment/unlike -> /v1/account/comment/like) #### POST /v1/account/comment/delete — Delete comment - **Docs / Raw MD:** https://tikultra.com/docs/api/comment-delete | https://tikultra.com/docs/md/api/comment-delete - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 15 cr - **Upstream:** /aweme/v1/comment/delete/ - **Summary:** Delete a comment on your post, or one you wrote. - **Params:** account_id*:string, comment_id*:string - **Workflow:** Comment Lead Mining, Replies & Moderation (/v1/video/comments -> /v1/video/comments/replies -> /v1/account/comment -> /v1/account/comment/delete -> /v1/account/comment/like) #### POST /v1/account/like — Like post - **Docs / Raw MD:** https://tikultra.com/docs/api/account-like | https://tikultra.com/docs/md/api/account-like - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 15 cr - **Upstream:** /aweme/v1/commit/item/digg/ - **Summary:** Like or unlike a video from a caller-owned Connected Workspace account (account_id) — never an SMM panel. - **Params:** account_id*:string, aweme_id*:string, action:integer - **Workflow:** Caller-Owned Account Engagement (Likes, Follows, Reposts & Saves) (/v1/account/login/otp/send -> /v1/video -> /v1/account/warm/watch-item -> /v1/account/like) #### POST /v1/account/follow — Follow creator - **Docs / Raw MD:** https://tikultra.com/docs/api/account-follow | https://tikultra.com/docs/md/api/account-follow - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 20 cr - **Upstream:** /aweme/v1/commit/follow/user/ - **Summary:** Follow or unfollow a creator from a caller-owned Connected Workspace account (account_id). - **Params:** account_id*:string, target_user_id*:string, target_sec_uid:string, action:integer - **Workflow:** Caller-Owned Account Engagement (Likes, Follows, Reposts & Saves) (/v1/account/login/otp/send -> /v1/video -> /v1/account/warm/watch-item -> /v1/account/follow -> /v1/account/like) #### POST /v1/account/repost — Repost video - **Docs / Raw MD:** https://tikultra.com/docs/api/account-repost | https://tikultra.com/docs/md/api/account-repost - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 15 cr - **Upstream:** /tiktok/v1/upvote/publish/ - **Summary:** Publish a repost annotation from a caller-owned Connected Workspace account (account_id). - **Params:** account_id*:string, aweme_id*:string, text:string - **Workflow:** Caller-Owned Account Engagement (Likes, Follows, Reposts & Saves) (/v1/account/login/otp/send -> /v1/video -> /v1/account/warm/watch-item -> /v1/account/repost -> /v1/account/like) #### POST /v1/account/share — Record share - **Docs / Raw MD:** https://tikultra.com/docs/api/account-share | https://tikultra.com/docs/md/api/account-share - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 15 cr - **Upstream:** /tiktok/share/link/shorten/v1/, /aweme/v1/aweme/stats/ - **Summary:** Generate a tracked share link and record share completion on a caller-owned Connected Workspace account (account_id). - **Params:** account_id*:string, aweme_id*:string, channel:string - **Workflow:** Caller-Owned Account Engagement (Likes, Follows, Reposts & Saves) (/v1/account/login/otp/send -> /v1/video -> /v1/account/warm/watch-item -> /v1/account/share -> /v1/account/like) #### POST /v1/account/favorite — Bookmark post - **Docs / Raw MD:** https://tikultra.com/docs/api/account-favorite | https://tikultra.com/docs/md/api/account-favorite - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 15 cr - **Upstream:** /aweme/v1/aweme/collect/ - **Summary:** Add or remove a video bookmark on a caller-owned Connected Workspace account (account_id). - **Params:** account_id*:string, aweme_id*:string, action:integer - **Workflow:** Caller-Owned Account Engagement (Likes, Follows, Reposts & Saves) (/v1/account/login/otp/send -> /v1/video -> /v1/account/warm/watch-item -> /v1/account/favorite -> /v1/account/like) #### POST /v1/account/music/collect — Collect sound - **Docs / Raw MD:** https://tikultra.com/docs/api/account-music-collect | https://tikultra.com/docs/md/api/account-music-collect - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 15 cr - **Upstream:** /aweme/v1/music/collect/ - **Summary:** Save or unsave a sound on a caller-owned Connected Workspace account (account_id). - **Params:** account_id*:string, music_id*:string, action:integer - **Workflow:** Caller-Owned Account Engagement (Likes, Follows, Reposts & Saves) (/v1/account/login/otp/send -> /v1/video -> /v1/account/warm/watch-item -> /v1/account/music/collect -> /v1/account/like) #### GET /v1/account/dm/inbox — Inbox - **Docs / Raw MD:** https://tikultra.com/docs/api/inbox | https://tikultra.com/docs/md/api/inbox - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 20 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /im/v1/messages/get_by_user - **Summary:** New messages across conversations. - **Params:** account_id*:string, cursor:string - **Workflow:** Autonomous Native Protobuf Direct Messaging (/v1/account/import -> /v1/account/session/warm-reopen -> /v1/account/dm/inbox -> /v1/account/dm/conversation/messages -> /v1/account/dm/conversation/read -> /v1/account/dm/send) #### GET /v1/account/dm/conversation/list — Conversations - **Docs / Raw MD:** https://tikultra.com/docs/api/dm-conversations | https://tikultra.com/docs/md/api/dm-conversations - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 20 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /im/v1/conversation/get_list - **Summary:** Your conversations, newest first. - **Params:** account_id*:string, cursor:string, count:integer - **Workflow:** Autonomous Native Protobuf Direct Messaging (/v1/account/import -> /v1/account/session/warm-reopen -> /v1/account/dm/inbox -> /v1/account/dm/conversation/messages -> /v1/account/dm/conversation/read -> /v1/account/dm/conversation/list -> /v1/account/dm/send) #### GET /v1/account/dm/conversation/messages — Conversation messages - **Docs / Raw MD:** https://tikultra.com/docs/api/dm-messages | https://tikultra.com/docs/md/api/dm-messages - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 20 cr | **Paginated:** `{ cursor, has_more }` - **Upstream:** /im/v1/messages/get_by_user - **Summary:** Messages in one conversation. - **Params:** account_id*:string, conversation_id*:string, cursor:string, count:integer - **Workflow:** Autonomous Native Protobuf Direct Messaging (/v1/account/import -> /v1/account/session/warm-reopen -> /v1/account/dm/inbox -> /v1/account/dm/conversation/messages -> /v1/account/dm/conversation/read -> /v1/account/dm/send) #### POST /v1/account/dm/conversation/create — Start conversation - **Docs / Raw MD:** https://tikultra.com/docs/api/dm-create | https://tikultra.com/docs/md/api/dm-create - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 20 cr - **Upstream:** /im/v1/conversation/create_v2 - **Summary:** Open a conversation with someone. - **Params:** account_id*:string, to*:string - **Workflow:** Autonomous Native Protobuf Direct Messaging (/v1/account/import -> /v1/account/session/warm-reopen -> /v1/account/dm/inbox -> /v1/account/dm/conversation/messages -> /v1/account/dm/conversation/read -> /v1/account/dm/conversation/create -> /v1/account/dm/send) #### POST /v1/account/dm/conversation/read — Mark read - **Docs / Raw MD:** https://tikultra.com/docs/api/dm-read | https://tikultra.com/docs/md/api/dm-read - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 20 cr - **Upstream:** /im/v1/conversation/mark_read - **Summary:** Mark a conversation as read. - **Params:** account_id*:string, conversation_id*:string - **Workflow:** Autonomous Native Protobuf Direct Messaging (/v1/account/import -> /v1/account/session/warm-reopen -> /v1/account/dm/inbox -> /v1/account/dm/conversation/messages -> /v1/account/dm/conversation/read -> /v1/account/dm/send) #### POST /v1/account/dm/typing — Typing indicator - **Docs / Raw MD:** https://tikultra.com/docs/api/dm-typing | https://tikultra.com/docs/md/api/dm-typing - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 15 cr - **Upstream:** /im/v1/message/send - **Summary:** Send a live typing indicator in a conversation. - **Params:** account_id*:string, conversation_id*:string, conversation_short_id:string - **Workflow:** Autonomous Native Protobuf Direct Messaging (/v1/account/import -> /v1/account/session/warm-reopen -> /v1/account/dm/inbox -> /v1/account/dm/conversation/messages -> /v1/account/dm/conversation/read -> /v1/account/dm/typing -> /v1/account/dm/send) #### POST /v1/account/dm/send — Send message - **Docs / Raw MD:** https://tikultra.com/docs/api/send-dm | https://tikultra.com/docs/md/api/send-dm - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 35 cr - **Upstream:** /im/v1/message/send - **Summary:** Send a text message. - **Params:** account_id*:string, conversation_id:string, to:string, text*:string - **Workflow:** Autonomous Native Protobuf Direct Messaging (/v1/account/import -> /v1/account/session/warm-reopen -> /v1/account/dm/inbox -> /v1/account/dm/conversation/messages -> /v1/account/dm/conversation/read -> /v1/account/dm/send) #### POST /v1/account/dm/send-image — Send image - **Docs / Raw MD:** https://tikultra.com/docs/api/dm-send-image | https://tikultra.com/docs/md/api/dm-send-image - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 35 cr - **Upstream:** /im/v1/message/send - **Summary:** Send an image. - **Params:** account_id*:string, conversation_id*:string, image_url*:string - **Workflow:** Autonomous Native Protobuf Direct Messaging (/v1/account/import -> /v1/account/session/warm-reopen -> /v1/account/dm/inbox -> /v1/account/dm/conversation/messages -> /v1/account/dm/conversation/read -> /v1/account/dm/send-image -> /v1/account/dm/send) #### POST /v1/account/dm/send-voice — Send voice note - **Docs / Raw MD:** https://tikultra.com/docs/api/dm-send-voice | https://tikultra.com/docs/md/api/dm-send-voice - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 35 cr - **Upstream:** /im/v1/message/send - **Summary:** Send a voice note. - **Params:** account_id*:string, conversation_id*:string, audio_url*:string - **Workflow:** Autonomous Native Protobuf Direct Messaging (/v1/account/import -> /v1/account/session/warm-reopen -> /v1/account/dm/inbox -> /v1/account/dm/conversation/messages -> /v1/account/dm/conversation/read -> /v1/account/dm/send-voice -> /v1/account/dm/send) #### POST /v1/account/dm/reply — Reply to message - **Docs / Raw MD:** https://tikultra.com/docs/api/dm-reply | https://tikultra.com/docs/md/api/dm-reply - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 35 cr - **Upstream:** /im/v1/message/send - **Summary:** Reply to a specific message. - **Params:** account_id*:string, conversation_id*:string, message_id*:string, text*:string - **Workflow:** Autonomous Native Protobuf Direct Messaging (/v1/account/import -> /v1/account/session/warm-reopen -> /v1/account/dm/inbox -> /v1/account/dm/conversation/messages -> /v1/account/dm/conversation/read -> /v1/account/dm/reply -> /v1/account/dm/send) #### POST /v1/account/dm/sticker — Send sticker - **Docs / Raw MD:** https://tikultra.com/docs/api/dm-sticker | https://tikultra.com/docs/md/api/dm-sticker - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 35 cr - **Upstream:** /im/v1/message/send - **Summary:** Send a sticker. - **Params:** account_id*:string, conversation_id*:string, sticker_id*:string - **Workflow:** Autonomous Native Protobuf Direct Messaging (/v1/account/import -> /v1/account/session/warm-reopen -> /v1/account/dm/inbox -> /v1/account/dm/conversation/messages -> /v1/account/dm/conversation/read -> /v1/account/dm/sticker -> /v1/account/dm/send) #### POST /v1/account/dm/share-video — Share video - **Docs / Raw MD:** https://tikultra.com/docs/api/dm-share-video | https://tikultra.com/docs/md/api/dm-share-video - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 35 cr - **Upstream:** /im/v1/message/send - **Summary:** Share a video in a conversation. - **Params:** account_id*:string, conversation_id*:string, aweme_id*:string - **Workflow:** Autonomous Native Protobuf Direct Messaging (/v1/account/import -> /v1/account/session/warm-reopen -> /v1/account/dm/inbox -> /v1/account/dm/conversation/messages -> /v1/account/dm/conversation/read -> /v1/account/dm/share-video -> /v1/account/dm/send) #### POST /v1/account/dm/react — React to message - **Docs / Raw MD:** https://tikultra.com/docs/api/dm-react | https://tikultra.com/docs/md/api/dm-react - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 15 cr - **Upstream:** /im/v1/message/send - **Summary:** Add an emoji reaction to a message. - **Params:** account_id*:string, message_id*:string, emoji*:string - **Workflow:** Autonomous Native Protobuf Direct Messaging (/v1/account/import -> /v1/account/session/warm-reopen -> /v1/account/dm/inbox -> /v1/account/dm/conversation/messages -> /v1/account/dm/conversation/read -> /v1/account/dm/react -> /v1/account/dm/send) #### POST /v1/account/dm/recall — Unsend message - **Docs / Raw MD:** https://tikultra.com/docs/api/dm-recall | https://tikultra.com/docs/md/api/dm-recall - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 15 cr - **Upstream:** /im/v1/message/send - **Summary:** Unsend a message you sent. - **Params:** account_id*:string, message_id*:string - **Workflow:** Autonomous Native Protobuf Direct Messaging (/v1/account/import -> /v1/account/session/warm-reopen -> /v1/account/dm/inbox -> /v1/account/dm/conversation/messages -> /v1/account/dm/conversation/read -> /v1/account/dm/recall -> /v1/account/dm/send) #### GET /v1/account/dm/group/info — Group info - **Docs / Raw MD:** https://tikultra.com/docs/api/dm-group-info | https://tikultra.com/docs/md/api/dm-group-info - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 20 cr - **Upstream:** /im/v1/conversation/get_list - **Summary:** A group chat’s name and settings. - **Params:** account_id*:string, conversation_id*:string - **Workflow:** Autonomous Native Protobuf Direct Messaging (/v1/account/import -> /v1/account/session/warm-reopen -> /v1/account/dm/inbox -> /v1/account/dm/conversation/messages -> /v1/account/dm/conversation/read -> /v1/account/dm/group/info -> /v1/account/dm/send) #### GET /v1/account/dm/group/members — Group members - **Docs / Raw MD:** https://tikultra.com/docs/api/dm-group-members | https://tikultra.com/docs/md/api/dm-group-members - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 20 cr - **Upstream:** /im/v1/conversation/get_list - **Summary:** The members of a group chat. - **Params:** account_id*:string, conversation_id*:string - **Workflow:** Autonomous Native Protobuf Direct Messaging (/v1/account/import -> /v1/account/session/warm-reopen -> /v1/account/dm/inbox -> /v1/account/dm/conversation/messages -> /v1/account/dm/conversation/read -> /v1/account/dm/group/members -> /v1/account/dm/send) #### GET /v1/account/dm/streaks — Streaks - **Docs / Raw MD:** https://tikultra.com/docs/api/dm-streaks | https://tikultra.com/docs/md/api/dm-streaks - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 20 cr - **Upstream:** /tiktok/v1/im/streaks/info - **Summary:** Message streaks with your contacts. - **Params:** account_id*:string - **Workflow:** Autonomous Native Protobuf Direct Messaging (/v1/account/import -> /v1/account/session/warm-reopen -> /v1/account/dm/inbox -> /v1/account/dm/conversation/messages -> /v1/account/dm/conversation/read -> /v1/account/dm/streaks -> /v1/account/dm/send) #### POST /v1/account/live/start — Start LIVE - **Docs / Raw MD:** https://tikultra.com/docs/api/live-start | https://tikultra.com/docs/md/api/live-start - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 100 cr - **Upstream:** /webcast/room/create/ - **Summary:** Create a LIVE room on your account and get the RTMP ingest. - **Params:** account_id*:string, title*:string - **Workflow:** Native LIVE Room Hosting, Moderation & Interactive Sessions (/v1/account/live/start -> /v1/account/live/ping -> /v1/account/live/moderate -> /v1/account/live/finish) #### POST /v1/account/live/ping — LIVE heartbeat - **Docs / Raw MD:** https://tikultra.com/docs/api/live-ping | https://tikultra.com/docs/md/api/live-ping - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 15 cr - **Upstream:** /webcast/room/ping/anchor/ - **Summary:** Keep your room open while you stream. - **Params:** account_id*:string, room_id*:string - **Workflow:** Native LIVE Room Hosting, Moderation & Interactive Sessions (/v1/account/live/start -> /v1/account/live/ping -> /v1/account/live/moderate -> /v1/account/live/finish) #### POST /v1/account/live/finish — End LIVE - **Docs / Raw MD:** https://tikultra.com/docs/api/live-finish | https://tikultra.com/docs/md/api/live-finish - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 15 cr - **Upstream:** /webcast/room/finish/ - **Summary:** End your LIVE. - **Params:** account_id*:string, room_id*:string - **Workflow:** Native LIVE Room Hosting, Moderation & Interactive Sessions (/v1/account/live/start -> /v1/account/live/ping -> /v1/account/live/moderate -> /v1/account/live/finish) #### POST /v1/account/live/moderate — Moderate LIVE - **Docs / Raw MD:** https://tikultra.com/docs/api/live-moderate | https://tikultra.com/docs/md/api/live-moderate - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 20 cr - **Upstream:** /webcast/room/chat/ - **Summary:** Post, pin or remove comments and mute viewers in your room. - **Params:** account_id*:string, room_id*:string, action*:string, text:string, target_id:string - **Workflow:** Native LIVE Room Hosting, Moderation & Interactive Sessions (/v1/account/live/start -> /v1/account/live/ping -> /v1/account/live/moderate -> /v1/account/live/finish) #### POST /v1/account/live/cohost — Co-host - **Docs / Raw MD:** https://tikultra.com/docs/api/live-cohost | https://tikultra.com/docs/md/api/live-cohost - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 20 cr - **Upstream:** /webcast/room/chat/ - **Summary:** Invite or accept a co-host in your room. - **Params:** account_id*:string, room_id*:string, username*:string - **Workflow:** Native LIVE Room Hosting, Moderation & Interactive Sessions (/v1/account/live/start -> /v1/account/live/ping -> /v1/account/live/moderate -> /v1/account/live/cohost -> /v1/account/live/finish) #### POST /v1/account/live/battle — LIVE match - **Docs / Raw MD:** https://tikultra.com/docs/api/live-battle | https://tikultra.com/docs/md/api/live-battle - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 20 cr - **Upstream:** /webcast/room/chat/ - **Summary:** Start or accept a LIVE match from your room. - **Params:** account_id*:string, room_id*:string, opponent*:string - **Workflow:** Native LIVE Room Hosting, Moderation & Interactive Sessions (/v1/account/live/start -> /v1/account/live/ping -> /v1/account/live/moderate -> /v1/account/live/battle -> /v1/account/live/finish) #### POST /v1/account/live/viewer — LIVE viewer session - **Docs / Raw MD:** https://tikultra.com/docs/api/live-viewer | https://tikultra.com/docs/md/api/live-viewer - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 20 cr - **Upstream:** /webcast/room/enter/, /webcast/im/fetch/, /webcast/room/like/ - **Summary:** Enter, heartbeat, like or leave a LIVE room from a connected session. - **Params:** account_id*:string, room_id*:string, action*:string, count:integer - **Workflow:** Native LIVE Room Hosting, Moderation & Interactive Sessions (/v1/account/live/start -> /v1/account/live/ping -> /v1/account/live/moderate -> /v1/account/live/viewer -> /v1/account/live/finish) #### POST /v1/account/live/gift — LIVE gift & wallet - **Docs / Raw MD:** https://tikultra.com/docs/api/live-gift | https://tikultra.com/docs/md/api/live-gift - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 35 cr - **Upstream:** /webcast/gift/send/, /webcast/wallet_api/diamond_buy/ - **Summary:** Send a gift, list room gifts or inspect coin wallet balance on a connected session. - **Params:** account_id*:string, room_id*:string, action*:string, gift_id:integer, count:integer - **Workflow:** Native LIVE Room Hosting, Moderation & Interactive Sessions (/v1/account/live/start -> /v1/account/live/ping -> /v1/account/live/moderate -> /v1/account/live/gift -> /v1/account/live/finish) #### GET /v1/account/shop/cart — Cart - **Docs / Raw MD:** https://tikultra.com/docs/api/shop-cart | https://tikultra.com/docs/md/api/shop-cart - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 25 cr - **Upstream:** /api/v1/shop/cart/get_cart - **Summary:** Your account's Shop cart. - **Params:** account_id*:string - **Workflow:** TikTok Shop SDUI Product Spy, Visual Search & Affiliate Discovery (/v1/shop/search -> /v1/shop/product-page -> /v1/shop/reviews -> /v1/account/shop/cart -> /v1/shop/live-bag) #### GET /v1/account/shop/order-center — Orders - **Docs / Raw MD:** https://tikultra.com/docs/api/shop-order-center | https://tikultra.com/docs/md/api/shop-order-center - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 25 cr - **Upstream:** /api/v1/trade/entrance/get - **Summary:** Your account's Shop orders. - **Params:** account_id*:string - **Workflow:** TikTok Shop SDUI Product Spy, Visual Search & Affiliate Discovery (/v1/shop/search -> /v1/shop/product-page -> /v1/shop/reviews -> /v1/account/shop/order-center -> /v1/shop/live-bag) #### GET /v1/account/shop/cs — Shop support chat - **Docs / Raw MD:** https://tikultra.com/docs/api/shop-cs | https://tikultra.com/docs/md/api/shop-cs - **Pool:** Caller-Owned Account · Dedicated 1:1 FullPool | **Access:** Growth and up | **Cost:** 25 cr - **Upstream:** /api/v1/cs/rt - **Summary:** Your conversations with Shop sellers’ support. - **Params:** account_id*:string - **Workflow:** TikTok Shop SDUI Product Spy, Visual Search & Affiliate Discovery (/v1/shop/search -> /v1/shop/product-page -> /v1/shop/reviews -> /v1/account/shop/cs -> /v1/shop/live-bag) ### Devices, signing & primitives #### GET /v1/resolve — Resolve - **Docs / Raw MD:** https://tikultra.com/docs/api/resolve | https://tikultra.com/docs/md/api/resolve - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Every plan | **Cost:** 2 cr - **Upstream:** redirect + /aweme/v1/aweme/detail/ - **Summary:** 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. - **Params:** input*:string - **Workflow:** Protocol Capture Decryption, Codecs & Batch Pipelines (/v1/resolve -> /v1/crypto/x-argus/decrypt -> /v1/crypto/ttencrypt/decrypt -> /v1/jobs/submit) #### POST /v1/resolve — Resolve (POST) - **Docs / Raw MD:** https://tikultra.com/docs/api/resolve-post | https://tikultra.com/docs/md/api/resolve-post - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Every plan | **Cost:** 2 cr - **Upstream:** redirect + /aweme/v1/aweme/detail/ - **Summary:** The same resolver, with a JSON body. - **Params:** input*:string - **Workflow:** Protocol Capture Decryption, Codecs & Batch Pipelines (/v1/resolve -> /v1/crypto/x-argus/decrypt -> /v1/crypto/ttencrypt/decrypt -> /v1/resolve -> /v1/jobs/submit) #### GET /v1/id-converter — ID converter - **Docs / Raw MD:** https://tikultra.com/docs/api/id-converter | https://tikultra.com/docs/md/api/id-converter - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Every plan | **Cost:** 2 cr - **Upstream:** local · snowflake + /aweme/v1/user/profile/other/ - **Summary:** Snowflake timestamps and uid ↔ sec_uid lookups. - **Params:** id:string, username:string - **Workflow:** Protocol Capture Decryption, Codecs & Batch Pipelines (/v1/resolve -> /v1/crypto/x-argus/decrypt -> /v1/crypto/ttencrypt/decrypt -> /v1/id-converter -> /v1/jobs/submit) #### POST /v1/crypto/protobuf/decode — Protobuf decode - **Docs / Raw MD:** https://tikultra.com/docs/api/protobuf-decode | https://tikultra.com/docs/md/api/protobuf-decode - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Every plan | **Cost:** 2 cr - **Upstream:** local · protobuf decoder - **Summary:** Decode a raw protobuf payload to JSON and inferred .proto schema. - **Params:** hex*:string - **Workflow:** Protocol Capture Decryption, Codecs & Batch Pipelines (/v1/resolve -> /v1/crypto/x-argus/decrypt -> /v1/crypto/ttencrypt/decrypt -> /v1/crypto/protobuf/decode -> /v1/jobs/submit) #### POST /v1/crypto/protobuf/encode — Protobuf encode - **Docs / Raw MD:** https://tikultra.com/docs/api/protobuf-encode | https://tikultra.com/docs/md/api/protobuf-encode - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Every plan | **Cost:** 2 cr - **Upstream:** local · protobuf encoder - **Summary:** Encode numbered field maps into raw protobuf hex and base64 wire frames. - **Params:** fields*:object - **Workflow:** Protocol Capture Decryption, Codecs & Batch Pipelines (/v1/resolve -> /v1/crypto/x-argus/decrypt -> /v1/crypto/ttencrypt/decrypt -> /v1/crypto/protobuf/encode -> /v1/jobs/submit) #### POST /v1/jobs/submit — Submit batch job - **Docs / Raw MD:** https://tikultra.com/docs/api/submit-batch-job | https://tikultra.com/docs/md/api/submit-batch-job - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Every plan | **Cost:** per task - **Upstream:** gateway · async batch queue (up to 500 tasks) - **Summary:** Up to 500 tasks, run async, billed per task. - **Params:** tasks*:object[], webhook_url:string - **Workflow:** Protocol Capture Decryption, Codecs & Batch Pipelines (/v1/resolve -> /v1/crypto/x-argus/decrypt -> /v1/crypto/ttencrypt/decrypt -> /v1/jobs/submit) #### GET /v1/jobs/{id} — Get job - **Docs / Raw MD:** https://tikultra.com/docs/api/get-job | https://tikultra.com/docs/md/api/get-job - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Every plan | **Cost:** Free - **Upstream:** gateway · async batch queue - **Summary:** A job’s progress and results. - **Params:** id*:string - **Workflow:** Protocol Capture Decryption, Codecs & Batch Pipelines (/v1/resolve -> /v1/crypto/x-argus/decrypt -> /v1/crypto/ttencrypt/decrypt -> /v1/jobs/{id} -> /v1/jobs/submit) #### GET /v1/devices — List devices - **Docs / Raw MD:** https://tikultra.com/docs/api/list-devices | https://tikultra.com/docs/md/api/list-devices - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Every plan | **Cost:** Free - **Upstream:** gateway · context registry - **Summary:** Every device context your keys have provisioned. - **Params:** none (x-api-key header only) - **Workflow:** Dedicated Device Provisioning & Sub-Millisecond Native Signing (/v1/devices/templates -> /v1/devices/provision -> /v1/devices/{id}/bootstrap -> /v1/devices -> /v1/crypto/sign) #### POST /v1/devices/provision — Provision device - **Docs / Raw MD:** https://tikultra.com/docs/api/provision-device | https://tikultra.com/docs/md/api/provision-device - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Growth and up | **Cost:** 10 cr - **Upstream:** /service/2/device_register/ - **Summary:** A dedicated mobile device context pinned to a city. - **Params:** os:string, app_flavour:string, app_version:string, region*:string, city:string, hardware_template:string - **Workflow:** Dedicated Device Provisioning & Sub-Millisecond Native Signing (/v1/devices/templates -> /v1/devices/provision -> /v1/devices/{id}/bootstrap -> /v1/crypto/sign) #### GET /v1/devices/templates — Hardware templates - **Docs / Raw MD:** https://tikultra.com/docs/api/device-templates | https://tikultra.com/docs/md/api/device-templates - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Every plan | **Cost:** Free - **Upstream:** gateway · client & device catalog - **Summary:** The 237 Android and 15 iOS hardware profiles. - **Params:** os:string - **Workflow:** Dedicated Device Provisioning & Sub-Millisecond Native Signing (/v1/devices/templates -> /v1/devices/provision -> /v1/devices/{id}/bootstrap -> /v1/crypto/sign) #### GET /v1/apps/versions — App versions - **Docs / Raw MD:** https://tikultra.com/docs/api/app-versions | https://tikultra.com/docs/md/api/app-versions - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Every plan | **Cost:** Free - **Upstream:** gateway · client & device catalog - **Summary:** Every supported (os, app_flavour, app_version). - **Params:** none (x-api-key header only) - **Workflow:** Dedicated Device Provisioning & Sub-Millisecond Native Signing (/v1/devices/templates -> /v1/devices/provision -> /v1/devices/{id}/bootstrap -> /v1/apps/versions -> /v1/crypto/sign) #### GET /v1/devices/{id} — Get device - **Docs / Raw MD:** https://tikultra.com/docs/api/get-device | https://tikultra.com/docs/md/api/get-device - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Every plan | **Cost:** Free - **Upstream:** gateway · context registry - **Summary:** One device context and its state. - **Params:** id*:string - **Workflow:** Dedicated Device Provisioning & Sub-Millisecond Native Signing (/v1/devices/templates -> /v1/devices/provision -> /v1/devices/{id}/bootstrap -> /v1/devices/{id} -> /v1/crypto/sign) #### POST /v1/devices/{id}/bootstrap — Bootstrap device - **Docs / Raw MD:** https://tikultra.com/docs/api/bootstrap-device | https://tikultra.com/docs/md/api/bootstrap-device - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Growth and up | **Cost:** 10 cr - **Upstream:** /service/2/device_register/, /service/2/app_alert_check/ - **Summary:** Register a provisioned device so it is ready for calls. - **Params:** id*:string, warmup:boolean - **Workflow:** Dedicated Device Provisioning & Sub-Millisecond Native Signing (/v1/devices/templates -> /v1/devices/provision -> /v1/devices/{id}/bootstrap -> /v1/crypto/sign) #### POST /v1/devices/{id}/report — Device security report - **Docs / Raw MD:** https://tikultra.com/docs/api/device-report | https://tikultra.com/docs/md/api/device-report - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Growth and up | **Cost:** 10 cr - **Upstream:** /sdi/get_seed, /ri/report - **Summary:** Execute scheduled security telemetry scenes on a provisioned device. - **Params:** id*:string, scene:string - **Workflow:** Dedicated Device Provisioning & Sub-Millisecond Native Signing (/v1/devices/templates -> /v1/devices/provision -> /v1/devices/{id}/bootstrap -> /v1/devices/{id}/report -> /v1/crypto/sign) #### POST /v1/devices/{id}/warm — Warm device feed - **Docs / Raw MD:** https://tikultra.com/docs/api/device-warm | https://tikultra.com/docs/md/api/device-warm - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Growth and up | **Cost:** 10 cr - **Upstream:** /aweme/v1/feed/, /service/2/app_log/ - **Summary:** Calibrate a provisioned guest device context toward a niche with organic feed pulls and AppLog telemetry. - **Params:** id*:string, niche*:string, duration_sec:integer - **Workflow:** Dedicated Device Provisioning & Sub-Millisecond Native Signing (/v1/devices/templates -> /v1/devices/provision -> /v1/devices/{id}/bootstrap -> /v1/devices/{id}/warm -> /v1/crypto/sign) #### POST /v1/crypto/sign — Sign request - **Docs / Raw MD:** https://tikultra.com/docs/api/sign-request | https://tikultra.com/docs/md/api/sign-request - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Every plan | **Cost:** 2 cr - **Upstream:** local · native request signer (<1 ms) - **Summary:** 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. - **Params:** os:string, app_flavour:string, app_version:string, method*:string, url*:string, headers:object, body:string, device_id:string - **Workflow:** Dedicated Device Provisioning & Sub-Millisecond Native Signing (/v1/devices/templates -> /v1/devices/provision -> /v1/devices/{id}/bootstrap -> /v1/crypto/sign) #### POST /v1/crypto/x-cylons — X-Cylons token - **Docs / Raw MD:** https://tikultra.com/docs/api/x-cylons | https://tikultra.com/docs/md/api/x-cylons - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Every plan | **Cost:** 2 cr - **Upstream:** local · X-Cylons SM3/MD5 signer - **Summary:** Generate an X-Cylons session-binding header from query, stub, and Lanus keys. - **Params:** query_string*:string, x_ss_stub:string, lanusk:string, lanusv:string, khronos:integer - **Workflow:** Dedicated Device Provisioning & Sub-Millisecond Native Signing (/v1/devices/templates -> /v1/devices/provision -> /v1/devices/{id}/bootstrap -> /v1/crypto/x-cylons -> /v1/crypto/sign) #### POST /v1/crypto/x-cylons/decrypt — X-Cylons decrypt - **Docs / Raw MD:** https://tikultra.com/docs/api/x-cylons-decrypt | https://tikultra.com/docs/md/api/x-cylons-decrypt - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Every plan | **Cost:** 2 cr - **Upstream:** local · X-Cylons SM3/MD5 inspector - **Summary:** Decrypt an external X-Cylons header and verify its Lanus MD5 and SM3 digests. - **Params:** x_cylons*:string, query_string:string, x_ss_stub:string, lanusk:string, lanusv:string - **Workflow:** Protocol Capture Decryption, Codecs & Batch Pipelines (/v1/resolve -> /v1/crypto/x-argus/decrypt -> /v1/crypto/ttencrypt/decrypt -> /v1/crypto/x-cylons/decrypt -> /v1/jobs/submit) #### POST /v1/crypto/mssdk/decrypt — MSSDK decrypt - **Docs / Raw MD:** https://tikultra.com/docs/api/mssdk-decrypt | https://tikultra.com/docs/md/api/mssdk-decrypt - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Every plan | **Cost:** 2 cr - **Upstream:** local · MSSDK frame cipher inspector - **Summary:** Decrypt and inspect an external MSSDK binary frame into decoded bytes and JSON. - **Params:** operation*:string, payload_base64*:string, os:string, app_flavour:string, app_version:string, device_id:string - **Workflow:** Protocol Capture Decryption, Codecs & Batch Pipelines (/v1/resolve -> /v1/crypto/x-argus/decrypt -> /v1/crypto/ttencrypt/decrypt -> /v1/crypto/mssdk/decrypt -> /v1/jobs/submit) #### POST /v1/crypto/x-argus/decrypt — X-Argus decrypt - **Docs / Raw MD:** https://tikultra.com/docs/api/x-argus-decrypt | https://tikultra.com/docs/md/api/x-argus-decrypt - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Every plan | **Cost:** 2 cr - **Upstream:** local · X-Argus cipher & protobuf inspector - **Summary:** Decrypt and inspect an external X-Argus header into typed fields. - **Params:** x_argus*:string, os:string, app_flavour:string, app_version:string - **Workflow:** Protocol Capture Decryption, Codecs & Batch Pipelines (/v1/resolve -> /v1/crypto/x-argus/decrypt -> /v1/crypto/ttencrypt/decrypt -> /v1/jobs/submit) #### POST /v1/crypto/x-ladon/decrypt — X-Ladon decrypt - **Docs / Raw MD:** https://tikultra.com/docs/api/x-ladon-decrypt | https://tikultra.com/docs/md/api/x-ladon-decrypt - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Every plan | **Cost:** 2 cr - **Upstream:** local · X-Ladon cipher inspector - **Summary:** Decrypt an external X-Ladon header into timestamp, license ID and aid. - **Params:** x_ladon*:string, aid:string - **Workflow:** Protocol Capture Decryption, Codecs & Batch Pipelines (/v1/resolve -> /v1/crypto/x-argus/decrypt -> /v1/crypto/ttencrypt/decrypt -> /v1/crypto/x-ladon/decrypt -> /v1/jobs/submit) #### POST /v1/crypto/x-gorgon/decrypt — X-Gorgon decrypt - **Docs / Raw MD:** https://tikultra.com/docs/api/x-gorgon-decrypt | https://tikultra.com/docs/md/api/x-gorgon-decrypt - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Every plan | **Cost:** 2 cr - **Upstream:** local · X-Gorgon cipher inspector - **Summary:** Decrypt an external X-Gorgon header into query digest, timestamp and SDK version. - **Params:** x_gorgon*:string - **Workflow:** Protocol Capture Decryption, Codecs & Batch Pipelines (/v1/resolve -> /v1/crypto/x-argus/decrypt -> /v1/crypto/ttencrypt/decrypt -> /v1/crypto/x-gorgon/decrypt -> /v1/jobs/submit) #### POST /v1/crypto/ttencrypt/encrypt — TTEncrypt encode - **Docs / Raw MD:** https://tikultra.com/docs/api/ttencrypt-encrypt | https://tikultra.com/docs/md/api/ttencrypt-encrypt - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Every plan | **Cost:** 2 cr - **Upstream:** local · TTEncrypt codec - **Summary:** Encrypt telemetry or registration JSON with TTEncrypt. - **Params:** plaintext*:string, compress:boolean - **Workflow:** Protocol Capture Decryption, Codecs & Batch Pipelines (/v1/resolve -> /v1/crypto/x-argus/decrypt -> /v1/crypto/ttencrypt/decrypt -> /v1/crypto/ttencrypt/encrypt -> /v1/jobs/submit) #### POST /v1/crypto/ttencrypt/decrypt — TTEncrypt decode - **Docs / Raw MD:** https://tikultra.com/docs/api/ttencrypt-decrypt | https://tikultra.com/docs/md/api/ttencrypt-decrypt - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Every plan | **Cost:** 2 cr - **Upstream:** local · TTEncrypt codec - **Summary:** Decrypt an external TTEncrypt frame into UTF-8 and parsed JSON. - **Params:** ciphertext_base64*:string - **Workflow:** Protocol Capture Decryption, Codecs & Batch Pipelines (/v1/resolve -> /v1/crypto/x-argus/decrypt -> /v1/crypto/ttencrypt/decrypt -> /v1/jobs/submit) #### POST /v1/crypto/zstd/compress — zstd compress - **Docs / Raw MD:** https://tikultra.com/docs/api/zstd-compress | https://tikultra.com/docs/md/api/zstd-compress - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Every plan | **Cost:** 2 cr - **Upstream:** local · zstd codec - **Summary:** Compress a payload with zstd. - **Params:** data_base64*:string - **Workflow:** Protocol Capture Decryption, Codecs & Batch Pipelines (/v1/resolve -> /v1/crypto/x-argus/decrypt -> /v1/crypto/ttencrypt/decrypt -> /v1/crypto/zstd/compress -> /v1/jobs/submit) #### POST /v1/crypto/zstd/decompress — zstd decompress - **Docs / Raw MD:** https://tikultra.com/docs/api/zstd-decompress | https://tikultra.com/docs/md/api/zstd-decompress - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Every plan | **Cost:** 2 cr - **Upstream:** local · zstd codec - **Summary:** Decompress a zstd payload. - **Params:** data_base64*:string - **Workflow:** Protocol Capture Decryption, Codecs & Batch Pipelines (/v1/resolve -> /v1/crypto/x-argus/decrypt -> /v1/crypto/ttencrypt/decrypt -> /v1/crypto/zstd/decompress -> /v1/jobs/submit) #### POST /v1/crypto/passport-hash — Passport identifier hash - **Docs / Raw MD:** https://tikultra.com/docs/api/passport-hash | https://tikultra.com/docs/md/api/passport-hash - **Pool:** Protocol Primitive & Fleet Engine | **Access:** Every plan | **Cost:** 2 cr - **Upstream:** local · Passport XOR5 & TTP hash - **Summary:** Compute Passport XOR-5 hex, TTP identifier SHA-256 and session scramble values. - **Params:** value*:string, identifier_type:string - **Workflow:** Protocol Capture Decryption, Codecs & Batch Pipelines (/v1/resolve -> /v1/crypto/x-argus/decrypt -> /v1/crypto/ttencrypt/decrypt -> /v1/crypto/passport-hash -> /v1/jobs/submit)