Trenz Open Platform API
Trenz Open Platform API for cross-border e-commerce data, content creation, social media management and advertising.
Authentication
All requests must include X-API-Key header or Authorization: Bearer <API-Key>.
Error Codes
| HTTP | Code | Description |
|---|---|---|
| 400 | BAD_REQUEST | Malformed request |
| 400 | INVALID_PARAM | Invalid parameter |
| 400 | MISSING_PARAM | Required parameter missing |
| 400 | INVALID_SORT_FIELD | Invalid sort field |
| 400 | INVALID_INCLUDE | Invalid include parameter |
| 400 | PAGE_SIZE_EXCEEDED | Page size exceeded |
| 401 | AUTH_MISSING_KEY | API Key missing |
| 401 | AUTH_INVALID_KEY | API Key invalid |
| 401 | AUTH_KEY_REVOKED | API Key revoked |
| 401 | AUTH_KEY_SUSPENDED | API Key suspended |
| 402 | INSUFFICIENT_BALANCE | Insufficient balance |
| 403 | FORBIDDEN_SCOPE | No permission to access this resource |
| 404 | ROUTE_NOT_FOUND | Endpoint not found |
| 404 | TASK_NOT_FOUND | Async task not found |
| 429 | RATE_LIMITED | Rate limit exceeded |
| 429 | QUOTA_EXCEEDED | Quota exceeded |
| 500 | INTERNAL_ERROR | Internal server error |
| 502 | BACKEND_ERROR | Upstream service error |
| 503 | BACKEND_UNAVAILABLE | Upstream service unavailable |
| 504 | BACKEND_TIMEOUT | Upstream service timeout |
Tags
Data/Ads
Parameters
Ad Type Reference
Allowed values forad_type:
| Value | Ad Type |
|---|---|
| 1 | TikTok Shop Ads |
| 2 | Independent Site Ads |
| 3 | App Ads |
| 4 | Game Ads |
| 5 | Brand Ads |
| 6 | Lead Ads |
| 7 | Engagement Ads |
Product Category ID Reference
Thecategory parameter is the ad's associated product category ID:
| Category ID | Category |
|---|---|
| 601450 | Beauty & Personal Care |
| 601152 | Womenswear & Underwear |
| 700645 | Health |
| 603014 | Sports & Outdoor |
| 601739 | Phones & Electronics |
| 600942 | Home Appliances |
| 824328 | Menswear & Underwear |
| 605248 | Fashion Accessories |
| 700437 | Food & Beverages |
| 600001 | Household Products |
| 604453 | Furniture |
| 600024 | Kitchenware |
| 600154 | Home Textiles |
| 824584 | Luggage & Bags |
| 604206 | Toys & Hobbies |
| 601352 | Shoes |
| 604579 | Tools & Hardware |
| 604968 | Home Improvement |
| 602118 | Pet Supplies |
| 601755 | Computers & Office |
| 602284 | Baby & Maternity |
| 605196 | Automotive & Motorcycle |
| 951432 | Collectibles |
| 801928 | Books, Magazines & Audio/Video |
| 953224 | Jewelry & Accessories |
| 856720 | Pre-Owned Goods |
| 802184 | Kids' Fashion |
These are Level-1 categories. Passing a Level-1 ID filters all ads in that category.
Data/Creatives
Parameters
country: Country code. Allowed values: us, th, my, vn, mx, de, fr, it, es, jp, br, gb, ph, sg, id
Product Category ID Reference
Thecategory parameter is the creative's associated product category ID:
| Category ID | Category |
|---|---|
| 601450 | Beauty & Personal Care |
| 601152 | Womenswear & Underwear |
| 700645 | Health |
| 603014 | Sports & Outdoor |
| 601739 | Phones & Electronics |
| 600942 | Home Appliances |
| 824328 | Menswear & Underwear |
| 605248 | Fashion Accessories |
| 700437 | Food & Beverages |
| 600001 | Household Products |
| 604453 | Furniture |
| 600024 | Kitchenware |
| 600154 | Home Textiles |
| 824584 | Luggage & Bags |
| 604206 | Toys & Hobbies |
| 601352 | Shoes |
| 604579 | Tools & Hardware |
| 604968 | Home Improvement |
| 602118 | Pet Supplies |
| 601755 | Computers & Office |
| 602284 | Baby & Maternity |
| 605196 | Automotive & Motorcycle |
| 951432 | Collectibles |
| 801928 | Books, Magazines & Audio/Video |
| 953224 | Jewelry & Accessories |
| 856720 | Pre-Owned Goods |
| 802184 | Kids' Fashion |
These are Level-1 categories. Passing a Level-1 ID filters all creatives in that category.
Data/Creators
Parameters
category: Creator category ID. Creator categories differ from product categories — they are content-niche tags. No list is provided yet; we recommend first searching without this parameter and then using thecategory_labelfield from the response for further filtering.has_contact: Whether the creator has public contact info (true/false), filters creators with public email or social handles.
Data/Lives
Parameters
category: Streamer category ID; uses the same taxonomy as creator categories. No list is provided yet; we recommend first searching without this parameter.is_living: Whether currently live-streaming (true/false)is_commercial: Whether this is a commerce live stream (true/false)
Product Category ID Reference
Theproduct_category parameter is the product category ID for commerce lives:
| Category ID | Category |
|---|---|
| 601450 | Beauty & Personal Care |
| 601152 | Womenswear & Underwear |
| 700645 | Health |
| 603014 | Sports & Outdoor |
| 601739 | Phones & Electronics |
| 600942 | Home Appliances |
| 824328 | Menswear & Underwear |
| 605248 | Fashion Accessories |
| 700437 | Food & Beverages |
| 600001 | Household Products |
| 604453 | Furniture |
| 600024 | Kitchenware |
| 600154 | Home Textiles |
| 824584 | Luggage & Bags |
| 604206 | Toys & Hobbies |
| 601352 | Shoes |
| 604579 | Tools & Hardware |
| 604968 | Home Improvement |
| 602118 | Pet Supplies |
| 601755 | Computers & Office |
| 602284 | Baby & Maternity |
| 605196 | Automotive & Motorcycle |
| 951432 | Collectibles |
| 801928 | Books, Magazines & Audio/Video |
| 953224 | Jewelry & Accessories |
| 856720 | Pre-Owned Goods |
| 802184 | Kids' Fashion |
These are Level-1 categories. Passing a Level-1 ID filters all lives in that category.
Data/Products
Product Category ID Reference
Thecategory parameter in search endpoints takes a numeric category ID. Below is the TikTok Level-1 category list:
| Category ID | Category |
|---|---|
| 601450 | Beauty & Personal Care |
| 601152 | Womenswear & Underwear |
| 700645 | Health |
| 603014 | Sports & Outdoor |
| 601739 | Phones & Electronics |
| 600942 | Home Appliances |
| 824328 | Menswear & Underwear |
| 605248 | Fashion Accessories |
| 700437 | Food & Beverages |
| 600001 | Household Products |
| 604453 | Furniture |
| 600024 | Kitchenware |
| 600154 | Home Textiles |
| 824584 | Luggage & Bags |
| 604206 | Toys & Hobbies |
| 601352 | Shoes |
| 604579 | Tools & Hardware |
| 604968 | Home Improvement |
| 602118 | Pet Supplies |
| 601755 | Computers & Office |
| 602284 | Baby & Maternity |
| 605196 | Automotive & Motorcycle |
| 951432 | Collectibles |
| 801928 | Books, Magazines & Audio/Video |
| 953224 | Jewelry & Accessories |
| 856720 | Pre-Owned Goods |
| 802184 | Kids' Fashion |
These are Level-1 categories. Passing a Level-1 ID filters all products under that category.
Data/Sellers
Parameters
seller_type: Seller type (1=Overseas Non-Brand, 2=Local, 3=Brand, 4=Non-Brand)
Product Category ID Reference
Thecategory parameter is the seller's primary product category ID; it uses the same taxonomy as product search:
| Category ID | Category |
|---|---|
| 601450 | Beauty & Personal Care |
| 601152 | Womenswear & Underwear |
| 700645 | Health |
| 603014 | Sports & Outdoor |
| 601739 | Phones & Electronics |
| 600942 | Home Appliances |
| 824328 | Menswear & Underwear |
| 605248 | Fashion Accessories |
| 700437 | Food & Beverages |
| 600001 | Household Products |
| 604453 | Furniture |
| 600024 | Kitchenware |
| 600154 | Home Textiles |
| 824584 | Luggage & Bags |
| 604206 | Toys & Hobbies |
| 601352 | Shoes |
| 604579 | Tools & Hardware |
| 604968 | Home Improvement |
| 602118 | Pet Supplies |
| 601755 | Computers & Office |
| 602284 | Baby & Maternity |
| 605196 | Automotive & Motorcycle |
| 951432 | Collectibles |
| 801928 | Books, Magazines & Audio/Video |
| 953224 | Jewelry & Accessories |
| 856720 | Pre-Owned Goods |
| 802184 | Kids' Fashion |
These are Level-1 categories. Passing a Level-1 ID filters all sellers primarily in that category.
Data/Videos
Parameters
is_commercial: Whether this is a commerce video (true/false)
Product Category ID Reference
Thecategory parameter is the video's associated product category ID:
| Category ID | Category |
|---|---|
| 601450 | Beauty & Personal Care |
| 601152 | Womenswear & Underwear |
| 700645 | Health |
| 603014 | Sports & Outdoor |
| 601739 | Phones & Electronics |
| 600942 | Home Appliances |
| 824328 | Menswear & Underwear |
| 605248 | Fashion Accessories |
| 700437 | Food & Beverages |
| 600001 | Household Products |
| 604453 | Furniture |
| 600024 | Kitchenware |
| 600154 | Home Textiles |
| 824584 | Luggage & Bags |
| 604206 | Toys & Hobbies |
| 601352 | Shoes |
| 604579 | Tools & Hardware |
| 604968 | Home Improvement |
| 602118 | Pet Supplies |
| 601755 | Computers & Office |
| 602284 | Baby & Maternity |
| 605196 | Automotive & Motorcycle |
| 951432 | Collectibles |
| 801928 | Books, Magazines & Audio/Video |
| 953224 | Jewelry & Accessories |
| 856720 | Pre-Owned Goods |
| 802184 | Kids' Fashion |
These are Level-1 categories. Passing a Level-1 ID filters all videos in that category.
Content/AI Analysis
Content/AI Copywriting
Content/AI Image
All
*_url fields in this section require publicly accessible URLs. To upload local files, first call the 'Generate Presigned Upload URL' endpoint under 'File Upload'.Content/AI Video
All
*_url fields in this section require publicly accessible URLs. To upload local files, first call the 'Generate Presigned Upload URL' endpoint under 'File Upload'.Content/Avatar
All
*_url fields in this section require publicly accessible URLs. To upload local files, first call the 'Generate Presigned Upload URL' endpoint under 'File Upload'.Content/Material Search
Content/Tools
Social/1.Account Management
You must bind at least one social account before using any social media feature. TikTok QR-code login is currently supported.
Once bound, call 'Social Account List' to view all connected accounts with their status and metrics.
Social/2.Video Publishing
One-step publishing via 'Upload and Publish Video', with support for immediate and scheduled publishing across multiple accounts.
Prerequisite: Bind a Social Account
You must bind at least one social account before publishing. Go to 'Social/1.Account Management' and use 'TikTok QR Code Login' + 'TikTok QR Code Status' for QR-based binding. Once bound, retrieve theid field from 'Social Account List' — this is the platform_account_id required by the publishing endpoint below.
Step 1: Upload File
1.1 Call 'Generate Presigned Upload URL' to get a temporary upload URL (this endpoint is under 'File Upload')
Response example:Code
Code
Record the returnedobject_keyands3_bucket— they are needed in the following steps.
1.2 Upload the file to presigned_url via PUT
Code
presigned_url is valid for 1 hour. File size limits depend on the target platform (TikTok max 4GB, YouTube max 256GB, Instagram Reels max 1GB).
Step 2: Validate Video Info (Recommended)
After upload, call 'Validate Video Info' to check that the video matches the target platform's spec (resolution, duration, bitrate, etc.) and avoid publishing failures:Code
This endpoint checks encoding, resolution, duration, etc. against the requirements of TikTok, YouTube, Instagram and other platforms.
Step 3: Call 'Upload and Publish Video'
Code
bucket_name= thes3_bucketreturned in Step 1,bucket_key= theobject_keyreturned in Step 1. Supports publishing to multiple accounts in parallel via thepublicationsarray. The returnedsession_tokenis used to poll publishing progress.
Scheduled Publishing
Setscheduled_at (Unix seconds) in each publications entry to schedule publishing. Each account can have its own schedule:
Code
scheduled_at must fall within 5 minutes to 90 days from now. Omit or set to 0 for immediate publishing; values under 5 minutes are auto-demoted to immediate.
Scheduled publications can be rescheduled via the 'Reschedule' endpoint.
Step 4: Poll 'Publish Session Status'
Code
Recommended poll interval: 3–5 seconds. Repeat until status is completed or failed.
Cancel Publishing (Optional)
- 'Cancel Publish Session' cancels an in-progress session:
POST /open/v1/social/publish/session/cancel - 'Cancel Individual Publish' cancels a submitted publication:
POST /open/v1/social/publish/cancel
Social/3.Video Management
Social/4.Comment Management
Social/5.Analytics
Social/6.Creation Tools
Social/7.TikTok Shop
Ads/Accounts
Ads/Campaigns
Ads/Landing Pages
Ads/Leads & Reports
Async Tasks
Async Task Workflow
- Submit the task (e.g. POST /open/v1/ai/videos/content-analysis) → returns
task_id - Poll status: GET /open/v1/tasks/{task_id}
- status="running" → keep polling (recommended interval 3-5 sec)
- status="success" → the
resultfield contains the full result - status="failed" → the
error_messagefield contains the error details
- Successful task results are persisted and can be retrieved again at any time
All AI analysis and AI generation endpoints are async.
They return task_id immediately without blocking.
File Upload
Schemas

