Auth type: OAuthDocumentation Index
Fetch the complete documentation index at: https://hyperfx.ai/docs/llms.txt
Use this file to discover all available pages before exploring further.
For general setup steps, permissions, and troubleshooting, start with: App Integrations.
Connect TikTok Ads
- Go to Settings → Apps in Hyper
- Select TikTok Ads → Connect New
- Complete OAuth and select the ad account
Common capabilities
- Manage TikTok advertising campaigns
- Optimize ad performance and bidding strategies
- Monitor campaign metrics and reporting
Use in Chat
Enable TikTok Ads in the tool selector. Ask your agent for campaign summaries or to adjust ad settings.Use in Agents
Add TikTok Ads to an agent’s toolkits and select the connection. Require approval for budget or publish actions.Use in Flows
Automate campaign management, performance reporting, and optimization using TikTok Ads action nodes.Troubleshooting
- Wrong account: reconnect and select the intended ad account
- Permission errors: re-authorize with required scopes
Available Actions
Hyper agents can run the following actions for this integration. Each action can be individually set to Enabled, Requires Approval, or Disabled in your agent’s toolkit settings. Actions can be set to one of three control states:| State | Behavior |
|---|---|
| Enabled | Agent runs the action automatically |
| Requires Approval | Agent pauses and waits for your confirmation before proceeding |
| Disabled | Action is blocked and cannot be used |
| Action | Description |
|---|---|
| Ad Benchmarks | Get ad benchmarks with performance comparison across dimensions |
| Ad Image Upload | Upload image to Asset Library for creating ads |
| Ad Video Info | Get video information from Asset Library |
| Ad Video Search | Search for video creatives in Asset Library with filtering options |
| Ad Video Upload | Upload a video to Asset Library for use in ad creatives |
| Add Bc Partner | Add partner to Business Center for collaboration and strategic asset sharing |
| Apply Custom Audiences | Apply or disconnect custom audiences to/from ad groups |
| Assign Asset | Assign assets to users within a Business Center with role-based access control for audiences, catalogs, stores, and other shared resources |
| Async Report Task Create | Create asynchronous report task with comprehensive configuration. Data level is required for BASIC, AUDIENCE, and CATALOG reports. Dimensions parameter is required for all reports |
| Batch Bind Automated Rule | Batch bind objects to a TikTok automated rule |
| Bc Transfer | Process Business Center payment transfers for budget management and financial operations |
| Cancel Custom Audience Sharing | Cancel sharing of TikTok custom audiences with other advertisers |
| Capitalize Catalog | Migrate catalogs under your ad account to your Business Center |
| Check Shop Availability For Gmv Max | Check the availability of a TikTok Shop for Product GMV Max campaigns |
| Create Ad | Create a new TikTok ad with creative elements |
| Create Adgroup | Create a TikTok adgroup under a campaign with comprehensive targeting and configuration options (uses AdgroupApi.adgroup_create) |
| Create Advertiser | Create a new ad account under a Business Center with comprehensive configuration options for billing, contact, and qualification information |
| Create Asset Group | Create an asset group in a Business Center to organize assets and manage member access with role-based permissions |
| Create Automated Rule | Create a TikTok automated rule for campaign optimization |
| Create Billing Group | Create a billing group in a Business Center for consolidated financial management and billing operations |
| Create Campaign | Create a new TikTok advertising campaign |
| Create Catalog | Create a catalog by specifying information such as name, targeted locations, and currency |
| Create Catalog Feed | Create a catalog feed for automated product data synchronization |
| Create Custom Audience | Create a TikTok custom audience by file |
| Create Gmv Max Campaign | Create a new GMV Max campaign |
| Create Lookalike Audience | Create a TikTok lookalike audience based on a seed audience |
| Create Negative Keywords | Create negative keywords for Search Ads campaigns or ad groups to prevent ads from showing for specific search terms |
| Create Rule Based Audience | Create a TikTok rule-based custom audience using behavioral criteria |
| Create Saved Audience | Create a TikTok saved audience with comprehensive targeting criteria |
| Create Split Test | Create a TikTok split test (A/B test) for campaign optimization |
| Creative Asset Delete | Delete creative assets from Asset Library |
| Creative Asset Share | Share creative assets with other advertiser accounts |
| Creative Image Edit | Edit an image according to size requirements and apply creative trimmings |
| Creative Portfolio Create | Create a creative portfolio for organizing assets and content |
| Creative Portfolio Get | Get a creative portfolio by ID |
| Creative Portfolio List | List creative portfolios within an ad account with filtering and pagination |
| Creative Report | Get creative basic reports with performance metrics and filtering |
| Creative Shareable Link Create | Create a shareable link for creative assets |
| Delete Asset Admin | Delete assets from a Business Center with permanent removal of audiences, pixels, catalogs, and other shared resources |
| Delete Asset Group | Delete asset groups in a Business Center to remove members’ access and organizational structure |
| Delete Catalog | Delete a catalog from a Business Center |
| Delete Catalog Feed | Delete a catalog feed from a Business Center |
| Delete Catalog Products | Delete catalog products in bulk by product type and IDs |
| Delete Catalog Sets | Delete catalog product sets in bulk by product set IDs |
| Delete Catalog Videos | Delete catalog videos in bulk for video asset management |
| Delete Custom Audiences | Delete TikTok custom audiences |
| Delete Negative Keywords | Delete negative keywords for Search Ads campaigns or ad groups |
| Delete Saved Audiences | Delete TikTok saved audiences |
| Discovery Detail | Get details of a popular hashtag for discovery insights |
| Discovery Trending List | Get a list of popular trending hashtags |
| End Split Test | End (stop) a TikTok split test permanently |
| File Image Ad Info | Get image information from Asset Library |
| Get Adgroups | Get TikTok adgroups with filters (uses AdgroupApi.adgroup_get) |
| Get Ads | Get TikTok ads with filtering options |
| Get Advertiser Accounts | Get TikTok advertiser accounts for the authenticated user |
| Get Advertiser Balance | Get ad account balance and budget information for comprehensive financial management and spending oversight |
| Get Asset | Retrieve assets from a Business Center with user-focused filtering for ownership tracking and collaboration insights |
| Get Asset Admin | Retrieve assets from a Business Center with comprehensive filtering and pagination for audiences, pixels, catalogs, and other shared resources |
| Get Asset Group | Get the assets or members of an Asset Group in a Business Center with detailed role and permission information |
| Get Asset Member | Get members by assets with detailed role and permission information for access control management |
| Get Asset Partner | Get partners by assets with detailed partnership and collaboration information for strategic business development |
| Get Audience Insight Overlap | Analyze audience overlap between custom audiences for strategic insights |
| Get Automated Rule Result Details | Get detailed TikTok automated rule execution results with comprehensive information |
| Get Automated Rule Results | Get TikTok automated rule execution results and performance data |
| Get Automated Rules | Get TikTok automated rules with filtering and pagination |
| Get Available Stores | Get the list of available first-party stores (TikTok Shops) under an ad account |
| Get Bc Invoice Unpaid | Get total unpaid amount of Business Center accounts for financial management and payment oversight |
| Get Bc Members | Get Business Center members for team management and access control oversight |
| Get Bc Partner Assets | Get Business Center partner assets for monitoring and partnership management |
| Get Bc Partners | Get Business Center partners for partnership management and collaboration oversight |
| Get Bc Pixel Links | Get Business Center pixel links for pixel management and usage tracking |
| Get Billing Groups | Get all billing groups in a Business Center with comprehensive financial organization and billing management insights |
| Get Business Centers | Get Business Centers that you have access to with comprehensive organizational and access management insights |
| Get Campaigns | Get TikTok advertising campaigns. If advertiser_id is not provided, uses the primary advertiser account |
| Get Campaigns Sandbox | Get TikTok advertising campaigns from sandbox environment for testing. Uses sandbox API instead of production |
| Get Catalog | Get all catalogs or a particular catalog from a Business Center |
| Get Catalog Category Insights | Get trending catalog product categories with insights data for category performance analysis and targeting optimization |
| Get Catalog Feed | Get all feeds or a particular feed from a catalog |
| Get Catalog Feed Log | Get the last 10 operations of a catalog feed for monitoring and troubleshooting |
| Get Catalog Insight Filters | Get available filter values for catalog product insights to analyze trending products |
| Get Catalog Overview | Get catalog overview with product audit status counts |
| Get Catalog Product Insights | Get trending catalog products with insights data for performance analysis and campaign optimization |
| Get Catalog Products | Retrieve catalog products with advanced filtering, ordering, and pagination across all catalog types |
| Get Catalog Sets | Get catalog product sets with optional filtering and product counts |
| Get Catalog Videos | Get catalog videos with optional filtering and pagination |
| Get Current Advertiser Ids | Get current advertiser IDs with optional cache refresh. Use this to see all available advertiser accounts |
| Get Custom Audiences | Get details of specified TikTok custom audiences |
| Get Exclusive Authorization Status | Get the TikTok Shop exclusive authorization status of an ad account for GMV Max campaigns |
| Get Gmv Max Campaign Detail | Get detailed information about a specific GMV Max campaign |
| Get Gmv Max Campaigns | Get GMV Max campaigns within a TikTok ad account |
| Get Gmv Max Identities | Get identities for GMV Max campaigns associated with a TikTok Shop |
| Get Gmv Max Posts | Get TikTok posts available for Product GMV Max campaigns using a specific TikTok Shop |
| Get Negative Keywords | Get the list of negative keywords for Search Ads campaigns or ad groups |
| Get Shop Products | Get products within a TikTok Shop |
| Get Specific Automated Rules | Get specific TikTok automated rules by their IDs |
| Get Split Test Results | Get the results and performance data of a TikTok split test |
| Get Tiktok Shops For Gmv Max | Get TikTok Shops that an advertiser account has access to for GMV Max campaigns |
| Grant Exclusive Authorization | Grant an ad account exclusive authorization to create GMV Max Campaigns for a TikTok Shop |
| In Second Performance | Get in-second performance data for video content with detailed metrics |
| Invite Bc Members | Invite members to Business Center for team expansion and collaboration management |
| List Asset Groups | Get all Asset Groups in a Business Center with summary information and organizational overview |
| List Custom Audiences | List all TikTok custom audiences with optional filtering |
| List Saved Audiences | List TikTok saved audiences with optional filtering and pagination |
| Playable Get | Get a list of playables with filtering and pagination options |
| Playable Save | Save a playable to the advertiser account |
| Remove Products | Remove products from catalog by their IDs for efficient catalog cleanup and management across all catalog types |
| Report Integrated Get | Run synchronous integrated reports with comprehensive filtering and metrics. Report types: BASIC (basic report), AUDIENCE (audience report), PLAYABLE_MATERIAL (playable ads report), CATALOG (DSA report), BC (Business Center report), TT_SHOP (GMV max ads report). Data level is required for BASIC, AUDIENCE, and CATALOG reports. Dimensions parameter is required for all reports |
| Report Task Cancel | Cancel asynchronous report task |
| Report Task Check | Check asynchronous report task status |
| Run Gmv Max Campaign Report | Run comprehensive reports for GMV Max campaigns with metrics, dimensions, and filtering |
| Run Winning Adgroup | Run the winning ad group from a TikTok split test |
| Share Custom Audiences | Share TikTok custom audiences with other advertisers |
| Transfer Bc Pixel | Transfer pixel from advertiser to Business Center for centralized pixel management |
| Update Ad | Update fields on an existing TikTok ad (creatives, status) |
| Update Ad Status | Bulk update TikTok ad status (ENABLE, DISABLE, DELETE) |
| Update Adgroup | Update fields on an existing adgroup (partial update) |
| Update Adgroup Status | Bulk update adgroup status (ENABLE, DISABLE, DELETE) |
| Update Automated Rule | Update an existing TikTok automated rule |
| Update Bc Member | Update Business Center member information for role management and access control |
| Update Billing Group | Update settings of a billing group for financial reorganization and administrative management |
| Update Campaign | Update fields on an existing TikTok campaign (name, budget, modes, objective) |
| Update Campaign Status | Bulk update TikTok campaign status (ENABLE, DISABLE, DELETE) |
| Update Catalog | Update catalog name for catalog management and organization |
| Update Catalog Feed | Update a catalog feed configuration and settings |
| Update Catalog Set | Update catalog product set name and/or filter conditions |
| Update Custom Audience | Update a TikTok custom audience name or data |
| Update Gmv Max Campaign | Update an existing GMV Max campaign |
| Update Negative Keyword | Update a negative keyword for Search Ads campaigns or ad groups |
| Update Split Test Time | Update the start and end time of a TikTok split test |
| Upload Bc Image | Upload certificate images for Business Center ad account verification and compliance documentation |
| Upload Products Via File Url | Upload products to catalog via CSV file URL for bulk product management |
| Upload Products Via Json Schema | Upload products to catalog via JSON schema for comprehensive product data management across all 8 catalog types |
| Video Insights Report | Get video insights reports with comprehensive video performance metrics |