Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
docs: update toolkits and API data
Sushmithamallesh committed
Sep 22, 2026 at 15:05 UTC
f5faa5423d467a9d813999ae0e687e779a3736c1
4 files changed
+1283
-1415
docs/public/data/toolkits-list.json
+1
-1
@@ -11460,7 +11460,7 @@
11460
"name": "TikTok Ads",
11461
"logo": "https://logos.composio.dev/api/tiktok_ads",
11462
"category": "marketing",
11463
- "toolCount": 418,
11463
+ "toolCount": 142,
11464
"triggerCount": 0
11465
},
11466
{
docs/public/data/toolkits.json
+32
-1412
@@ -334548,85 +334548,20 @@
334548
"composioManagedAuthSchemes": [
334549
"OAUTH2"
334550
],
334551
- "toolCount": 418,
334551
+ "toolCount": 142,
334552
"triggerCount": 0,
334553
- "version": "20260918_00",
334553
+ "version": "20260922_00",
334554
"tools": [
334555
- {
334556
- "slug": "TIKTOK_ADS_ADD_BC_PARTNER",
334557
- "name": "Add a partner to a BC",
334558
- "description": "Add another Business Center as a partner and optionally share advertiser or catalog assets with it."
334559
- },
334560
- {
334561
- "slug": "TIKTOK_ADS_APPEAL_ADGROUP",
334562
- "name": "Appeal a rejection",
334563
- "description": "Submit an appeal for a rejected ad group or an ad within it. This starts an external TikTok review, cannot be withdrawn through this tool, and may require human follow-up; confirm the rejection and supporting evidence before submitting."
334564
- },
334555
{
334556
"slug": "TIKTOK_ADS_APPEAL_SMART_PLUS_AD",
334557
"name": "Appeal Smart+ Ad",
334558
"description": "Submit an appeal for a Smart+ ad review decision. Once submitted, the appeal cannot be withdrawn through this tool."
334559
},
334570
- {
334571
- "slug": "TIKTOK_ADS_APPLY_DMP_CUSTOM_AUDIENCE",
334572
- "name": "Apply or Disconnect a Custom Audience",
334573
- "description": "Apply a custom audience to ad groups or disconnect it from them."
334574
- },
334575
- {
334576
- "slug": "TIKTOK_ADS_ASSIGN_BC_ASSET",
334577
- "name": "Assign an asset",
334578
- "description": "Assign a Business Center asset and its asset-specific role to a member."
334579
- },
334580
- {
334581
- "slug": "TIKTOK_ADS_ASSIGN_BC_MEMBER",
334582
- "name": "Assign Members to a Child Business Center",
334583
- "description": "Assign one or more existing members from source child Business Centers to a target child Business Center, optionally setting basic and finance roles."
334584
- },
334560
{
334561
"slug": "TIKTOK_ADS_ASSIGN_TIKTOK_ACCOUNT_TO_ADVERTISER",
334562
"name": "Assign TikTok Account To Advertiser",
334563
"description": "Link a TikTok account to an ad account in the same Business Center."
334564
},
334590
- {
334591
- "slug": "TIKTOK_ADS_AUTHORIZE_BC_ASSET_ACCOUNT",
334592
- "name": "Obtain TikTok Account Ad Delivery Authorization URL",
334593
- "description": "Generate a URL through which a human TikTok account owner can grant ad delivery permissions to a Business Center. This action only creates the authorization URL; it does not grant permissions, and an agent cannot open or scan the URL and complete the owner's approval step."
334594
- },
334595
- {
334596
- "slug": "TIKTOK_ADS_AUTHORIZE_IDENTITY_MUSIC",
334597
- "name": "Get Music Authorization Info of a Video",
334598
- "description": "Check whether every song in a TikTok post is authorized for a specific identity, targeting-location set, and ad deployment window. This does not grant creator or post authorization; the selected identity and post must already be authorized for advertiser use."
334599
- },
334600
- {
334601
- "slug": "TIKTOK_ADS_AUTHORIZE_TT_VIDEO",
334602
- "name": "Apply a Spark Post Authorization Code",
334603
- "description": "Apply a creator-issued authorization code so an advertiser may use that specific TikTok post as a Spark Ad. The creator must generate the code, and duet, stitch, or mentioned-original posts also require the original post's authorization code."
334604
- },
334605
- {
334606
- "slug": "TIKTOK_ADS_BIND_CATALOG_EVENTSOURCE",
334607
- "name": "Bind an event source to a catalog",
334608
- "description": "Bind a mobile app, website Pixel, or both to a catalog."
334609
- },
334610
- {
334611
- "slug": "TIKTOK_ADS_BIND_OPTIMIZER_RULE_BATCH",
334612
- "name": "Bind/Unbind rules",
334613
- "description": "Bind or unbind optimizer rules from existing advertising objects."
334614
- },
334615
- {
334616
- "slug": "TIKTOK_ADS_CANCEL_DMP_CUSTOM_AUDIENCE_SHARE",
334617
- "name": "Cancel Custom Audience Sharing",
334618
- "description": "Stop sharing a custom audience with an advertiser."
334619
- },
334620
- {
334621
- "slug": "TIKTOK_ADS_CANCEL_REPORT_TASK",
334622
- "name": "Cancel asynchronous report task",
334623
- "description": "Cancel a queued or processing asynchronous TikTok report task. Confirm the advertiser and disposable task ID before calling because cancellation is irreversible."
334624
- },
334625
- {
334626
- "slug": "TIKTOK_ADS_CANCEL_RF_ORDER",
334627
- "name": "Cancel the R&F ad order",
334628
- "description": "Cancel the R&F ad order. This operation is destructive or irreversible; confirm exact disposable targets before calling. This operation can affect billing, credit, invoices, budgets, contracts, or payments; require explicit approval and an isolated account."
334629
- },
334565
{
334566
"slug": "TIKTOK_ADS_CHANGELOG_TASK_DOWNLOAD",
334567
"name": "Get Change Log Download Task Result",
@@ -334637,36 +334572,21 @@
334572
"name": "Check Advertiser Term Status",
334573
"description": "Check whether a TikTok advertiser has signed a specified agreement."
334574
},
334640
- {
334641
- "slug": "TIKTOK_ADS_CHECK_BLOCKEDWORD",
334642
- "name": "Check the statuses of words",
334643
- "description": "Check whether specified words are blocked for an advertiser without changing moderation settings."
334644
- },
334645
- {
334646
- "slug": "TIKTOK_ADS_CHECK_BLOCKEDWORD_TASK",
334647
- "name": "Check the status of a blocked-word export task",
334648
- "description": "Check whether a blocked-word export task is running, succeeded, or failed. Call the download action only after SUCCEED."
334649
- },
334650
- {
334651
- "slug": "TIKTOK_ADS_CHECK_CAMPAIGN_COPY_TASK",
334652
- "name": "Get Manual Campaign Copy Task Results",
334653
- "description": "Get the results of an asynchronous copy task for a Manual Campaign. Availability may depend on account entitlement."
334654
- },
334575
{
334576
"slug": "TIKTOK_ADS_CHECK_CHANGELOG_TASK",
334577
"name": "Check Change Log Download Task",
334578
"description": "Check whether an advertiser change-log download task is processing, successful, or failed."
334579
},
334660
- {
334661
- "slug": "TIKTOK_ADS_CHECK_COMMENT_TASK",
334662
- "name": "Get the status of a comment export task",
334663
- "description": "Check whether a comment export task is running, succeeded, or failed. Call the download action only after SUCCEED."
334664
- },
334580
{
334581
"slug": "TIKTOK_ADS_CHECK_FILE_NAMES",
334582
"name": "Check File Names",
334583
"description": "Check whether one or more image or video file names are already used in an advertiser account."
334584
},
334585
+ {
334586
+ "slug": "TIKTOK_ADS_CHECK_GMV_MAX_OCCUPIED_CUSTOM_SHOP_ADS",
334587
+ "name": "Check GMV Max Occupied Custom Shop Ads",
334588
+ "description": "Check which Shopping Ads occupy one TikTok Shop identity or product asset."
334589
+ },
334590
{
334591
"slug": "TIKTOK_ADS_CHECK_GMV_MAX_STORE_AVAILABILITY",
334592
"name": "Check TikTok Shop GMV Max Availability",
@@ -334677,11 +334597,6 @@
334597
"name": "Check MMM Data Request",
334598
"description": "Check one MMM export job. Poll conservatively because TikTok documents up to 24 hours of processing but no polling-rate contract."
334599
},
334680
- {
334681
- "slug": "TIKTOK_ADS_CHECK_REPORT_TASK",
334682
- "name": "Check asynchronous report task",
334683
- "description": "Check, without polling, whether an asynchronous report task is queued, processing, successful, failed, or canceled."
334684
- },
334600
{
334601
"slug": "TIKTOK_ADS_CHECK_SMART_PLUS_CAMPAIGN_COPY_TASK",
334602
"name": "Check Smart+ Campaign Copy Task",
@@ -334692,71 +334607,6 @@
334607
"name": "Check UnionPay Verification Requirement",
334608
"description": "Check whether a business license requires UnionPay verification before submitting advertiser verification details."
334609
},
334695
- {
334696
- "slug": "TIKTOK_ADS_CHECK_VBO_ELIGIBILITY",
334697
- "name": "Check Value-Based Optimization eligibility",
334698
- "description": "Check VBO bidding eligibility for a proposed campaign configuration; some options require allowlisting."
334699
- },
334700
- {
334701
- "slug": "TIKTOK_ADS_CONFIRM_TERM",
334702
- "name": "Sign Terms",
334703
- "description": "Sign the selected advertiser agreement."
334704
- },
334705
- {
334706
- "slug": "TIKTOK_ADS_CONVERT_TIKTOK_LINK",
334707
- "name": "Get a TikTok in-app link",
334708
- "description": "Convert an open TikTok URL to an internal TikTok link; availability may require allowlisting."
334709
- },
334710
- {
334711
- "slug": "TIKTOK_ADS_CREATE_AD",
334712
- "name": "Create ads",
334713
- "description": "Create one or more ordinary ads in an existing ad group using documented creative settings."
334714
- },
334715
- {
334716
- "slug": "TIKTOK_ADS_CREATE_ADGROUP",
334717
- "name": "Create an ad group",
334718
- "description": "Create an ad group. Availability may depend on TikTok allowlisting or account entitlement."
334719
- },
334720
- {
334721
- "slug": "TIKTOK_ADS_CREATE_ADGROUP_RF",
334722
- "name": "Create an R&F ad group",
334723
- "description": "Create an R&F ad group. Availability may depend on TikTok allowlisting or account entitlement."
334724
- },
334725
- {
334726
- "slug": "TIKTOK_ADS_CREATE_APP",
334727
- "name": "Create an app",
334728
- "description": "Create a mobile app for an advertiser."
334729
- },
334730
- {
334731
- "slug": "TIKTOK_ADS_CREATE_BC",
334732
- "name": "Create a Business Center",
334733
- "description": "Create a persistent TikTok Business Center organization. This may establish a new administrative and billing boundary with no cleanup operation documented for this tool; obtain explicit approval immediately before execution and verify the name, company, registration area, currency, timezone, type, and contact data."
334734
- },
334735
- {
334736
- "slug": "TIKTOK_ADS_CREATE_BC_ADVERTISER",
334737
- "name": "Create an ad account",
334738
- "description": "Create a persistent ad account in a Business Center, optionally configure its invoice grouping, Payment Portfolio linkage, and spending budget. Account creation can succeed even if portfolio binding or budget setup fails. Obtain explicit owner and finance approval immediately before execution; verify identity, region, currency, timezone, qualifications, tax data, payer, portfolio, and budget settings, then inspect both setup-result objects. Some options require TikTok allowlisting."
334739
- },
334740
- {
334741
- "slug": "TIKTOK_ADS_CREATE_BC_BILLING_GROUP",
334742
- "name": "Create a Billing Group",
334743
- "description": "Create a persistent Billing Group and assign ad accounts to it. This changes invoice grouping and may make the group the Business Center default; obtain explicit approval immediately before execution and verify the Business Center, account IDs, immutable group type, email recipients, and is_primary setting."
334744
- },
334745
- {
334746
- "slug": "TIKTOK_ADS_CREATE_BC_INVOICE_TASK",
334747
- "name": "Create an asynchronous invoice download task",
334748
- "description": "Create a task that generates an invoice list, batch of invoice PDFs, or detailed billing report for later download. This exports finance-sensitive data and creates external task state; obtain explicit approval immediately before execution, verify the Business Center, invoice, output type, date range, payment filters, and campaign, and retrieve the result only to an approved storage destination."
334749
- },
334750
- {
334751
- "slug": "TIKTOK_ADS_CREATE_BLOCKEDWORD",
334752
- "name": "Create blocked words",
334753
- "description": "Add exact words to an advertiser's moderation block list. Review the words and advertiser ID before calling because future matching comments may be affected."
334754
- },
334755
- {
334756
- "slug": "TIKTOK_ADS_CREATE_BLOCKEDWORD_TASK",
334757
- "name": "Create a blocked-word export task",
334758
- "description": "Create an asynchronous export task for an advertiser's blocked words. Save the returned task ID, poll CHECK_BLOCKEDWORD_TASK until SUCCEED, then download it."
334759
- },
334610
{
334611
"slug": "TIKTOK_ADS_CREATE_BUSINESS_CENTER_ASSET_GROUP",
334612
"name": "Create Business Center Asset Group",
@@ -334772,31 +334622,6 @@
334622
"name": "Create Business Spark Ad",
334623
"description": "Create a campaign, ad group, and Spark Ad in one request. TikTok's endpoint contract does not document their initial delivery status; the created resources may become eligible for delivery and spend, so verify their status after creation."
334624
},
334775
- {
334776
- "slug": "TIKTOK_ADS_CREATE_CAMPAIGN",
334777
- "name": "Create a campaign",
334778
- "description": "Create a Manual Campaign with documented campaign, objective, budget, RTA, and iOS settings."
334779
- },
334780
- {
334781
- "slug": "TIKTOK_ADS_CREATE_CAMPAIGN_COPY_TASK",
334782
- "name": "Create an asynchronous copy task for a Manual Campaign",
334783
- "description": "Create an asynchronous Manual Campaign copy task. Copied nested resources may default to enabled unless explicitly disabled."
334784
- },
334785
- {
334786
- "slug": "TIKTOK_ADS_CREATE_CAMPAIGN_SPC",
334787
- "name": "Create a campaign through the shared SPC route",
334788
- "description": "Create a current Smart+ Catalog or Advanced Dedicated Campaign through TikTok's shared SPC route; legacy Smart+ modes are deprecated."
334789
- },
334790
- {
334791
- "slug": "TIKTOK_ADS_CREATE_CATALOG",
334792
- "name": "Create a catalog",
334793
- "description": "Create a catalog in a TikTok Business Center; some catalog types require allowlisting."
334794
- },
334795
- {
334796
- "slug": "TIKTOK_ADS_CREATE_CATALOG_FEED",
334797
- "name": "Create a feed",
334798
- "description": "Create a scheduled catalog feed. INCREMENTAL preserves products omitted from the next import; OVERWRITE permanently removes omitted products, so confirm the complete source file before using it."
334799
- },
334625
{
334626
"slug": "TIKTOK_ADS_CREATE_CATALOG_PRODUCT_DIAGNOSTIC_TASK",
334627
"name": "Create Catalog Product Diagnostic Task",
@@ -334807,76 +334632,21 @@
334632
"name": "Create Catalog Product Set by File",
334633
"description": "Create an E-commerce catalog product set from an uploaded CSV file."
334634
},
334810
- {
334811
- "slug": "TIKTOK_ADS_CREATE_CATALOG_SET",
334812
- "name": "Create a product set by conditions",
334813
- "description": "Create a catalog product set using one AND or OR condition group."
334814
- },
334635
{
334636
"slug": "TIKTOK_ADS_CREATE_CHANGELOG_TASK",
334637
"name": "Create Change Log Download Task",
334638
"description": "Create an asynchronous download task for an advertiser's change log."
334639
},
334820
- {
334821
- "slug": "TIKTOK_ADS_CREATE_COMMENT_TASK",
334822
- "name": "Create a comment export task",
334823
- "description": "Create an asynchronous comment export for a specific advertiser, ad group, and date range. Review the filter because exported comments may contain personal data; poll CHECK_COMMENT_TASK before downloading."
334824
- },
334825
- {
334826
- "slug": "TIKTOK_ADS_CREATE_CREATIVE_ADS_PREVIEW",
334827
- "name": "Preview an ad or creative",
334828
- "description": "Generate a review-only preview for an existing ad, portfolio, Instant Page, image, video, or proposed ad configuration; this does not create an ad."
334829
- },
334640
{
334641
"slug": "TIKTOK_ADS_CREATE_CREATIVE_AUTO_MESSAGE",
334642
"name": "Create Creative Welcome Message",
334643
"description": "Create a welcome message within a TikTok advertiser account."
334644
},
334835
- {
334836
- "slug": "TIKTOK_ADS_CREATE_CREATIVE_PORTFOLIO",
334837
- "name": "Create a portfolio",
334838
- "description": "Create a typed creative portfolio. Availability may depend on TikTok entitlement."
334839
- },
334645
{
334646
"slug": "TIKTOK_ADS_CREATE_CREATIVE_PRE_REVIEW_TASK",
334647
"name": "Create Creative Pre-Review Task",
334648
"description": "Create a task to pre-review creative materials for one location."
334649
},
334845
- {
334846
- "slug": "TIKTOK_ADS_CREATE_CREATIVE_SHAREABLE_LINK",
334847
- "name": "Create a creative shareable link",
334848
- "description": "Create a link for sharing up to 20 named creative assets. TikTok does not document the link lifetime or revocation behavior."
334849
- },
334850
- {
334851
- "slug": "TIKTOK_ADS_CREATE_CRM",
334852
- "name": "Create a CRM Event Set",
334853
- "description": "Create a CRM Event Set configuration in an advertiser account. This does not report or ingest CRM events; an advertiser can have at most 50 CRM Event Sets."
334854
- },
334855
- {
334856
- "slug": "TIKTOK_ADS_CREATE_CUSTOM_CONVERSION",
334857
- "name": "Create a Custom Conversion",
334858
- "description": "Create a Custom Conversion configuration; this does not ingest conversion events."
334859
- },
334860
- {
334861
- "slug": "TIKTOK_ADS_CREATE_DMP_CUSTOM_AUDIENCE",
334862
- "name": "Create a Customer File Audience",
334863
- "description": "Create a custom audience from previously uploaded encrypted customer files."
334864
- },
334865
- {
334866
- "slug": "TIKTOK_ADS_CREATE_DMP_CUSTOM_AUDIENCE_LOOKALIKE",
334867
- "name": "Create a Lookalike Audience",
334868
- "description": "Create a lookalike custom audience from an eligible source audience."
334869
- },
334870
- {
334871
- "slug": "TIKTOK_ADS_CREATE_DMP_CUSTOM_AUDIENCE_RULE",
334872
- "name": "Create a Rule-Based Custom Audience",
334873
- "description": "Create a custom audience from conditional inclusion and exclusion event rules."
334874
- },
334875
- {
334876
- "slug": "TIKTOK_ADS_CREATE_DMP_SAVED_AUDIENCE",
334877
- "name": "Create a Saved Audience",
334878
- "description": "Create a reusable Saved Audience from targeting criteria."
334879
- },
334650
{
334651
"slug": "TIKTOK_ADS_CREATE_GMV_MAX_CAMPAIGN",
334652
"name": "Create GMV Max Campaign",
@@ -334887,66 +334657,11 @@
334657
"name": "Create GMV Max Session",
334658
"description": "Create a max delivery session for a product or a creative boost session for a video."
334659
},
334890
- {
334891
- "slug": "TIKTOK_ADS_CREATE_GMV_MAX_CUSTOMIZED_POSTS",
334892
- "name": "Create shop-level customized TikTok posts",
334893
- "description": "Create shop-level customized TikTok posts."
334894
- },
334895
- {
334896
- "slug": "TIKTOK_ADS_CREATE_GMV_MAX_EXCLUSIVE_AUTHORIZATION",
334897
- "name": "Grant an ad account exclusive authorization for a TikTok Shop",
334898
- "description": "Grant an ad account exclusive authorization for a TikTok Shop."
334899
- },
334900
- {
334901
- "slug": "TIKTOK_ADS_CREATE_IDENTITY",
334902
- "name": "Create an Identity",
334903
- "description": "Create a customized advertiser identity. This does not authorize a TikTok creator account or a creator post; use the relevant TikTok account or Spark post authorization flow for those identities."
334904
- },
334660
{
334661
"slug": "TIKTOK_ADS_CREATE_MMM_DATA_REQUEST",
334662
"name": "Create MMM Data Request",
334663
"description": "Create an irreversible Media Mix Modeling export job after explicit confirmation. Processing can take up to 24 hours, and the request cannot be cancelled through this tool once submitted."
334664
},
334910
- {
334911
- "slug": "TIKTOK_ADS_CREATE_OFFLINE",
334912
- "name": "Create an Offline Event Set",
334913
- "description": "Create an Offline Event Set configuration; this does not upload or ingest offline events."
334914
- },
334915
- {
334916
- "slug": "TIKTOK_ADS_CREATE_OPTIMIZER_RULE",
334917
- "name": "Create rules",
334918
- "description": "Create automated optimizer rules."
334919
- },
334920
- {
334921
- "slug": "TIKTOK_ADS_CREATE_PAGE_LEAD_MOCK",
334922
- "name": "Create a test lead",
334923
- "description": "Create a disposable test lead for an Instant Form or direct-message source; remove it after testing."
334924
- },
334925
- {
334926
- "slug": "TIKTOK_ADS_CREATE_PAYMENT_PORTFOLIO",
334927
- "name": "Create a Payment Portfolio",
334928
- "description": "Create a SHARED Payment Portfolio and link ad accounts so they jointly use centrally managed funds. This creates persistent financial configuration; obtain explicit finance-owner approval immediately before execution and verify the name, every account ID, same-client eligibility, and administrator access."
334929
- },
334930
- {
334931
- "slug": "TIKTOK_ADS_CREATE_PIXEL",
334932
- "name": "Create a Pixel",
334933
- "description": "Create a TikTok Pixel configuration; this does not ingest web events."
334934
- },
334935
- {
334936
- "slug": "TIKTOK_ADS_CREATE_PIXEL_EVENT",
334937
- "name": "Create Pixel Events",
334938
- "description": "Create standard Pixel Event configurations and rules; this endpoint does not ingest event occurrences."
334939
- },
334940
- {
334941
- "slug": "TIKTOK_ADS_CREATE_REPORT_TASK",
334942
- "name": "Create asynchronous report task",
334943
- "description": "Create an asynchronous TikTok report task and return its task ID; use the separate check and download tools to observe completion and retrieve output."
334944
- },
334945
- {
334946
- "slug": "TIKTOK_ADS_CREATE_SMART_CREATIVE_ADS",
334947
- "name": "Create Smart Creative Ads",
334948
- "description": "Create current Smart Creative ads in an ad group configured with creative_material_mode=SMART_CREATIVE. TikTok returns a mock processing result without ad IDs; wait 2-3 seconds and call GET_SMART_CREATIVE_MATERIALS to read final data. This is not the retired DYNAMIC ACO mode."
334949
- },
334665
{
334666
"slug": "TIKTOK_ADS_CREATE_SMART_PLUS_AD",
334667
"name": "Create Smart+ Ad",
@@ -334967,101 +334682,26 @@
334682
"name": "Create Smart+ Campaign Copy Task",
334683
"description": "Create and start an asynchronous copy task for an Upgraded Smart+ campaign. The copied campaign defaults to DISABLE, but copied ad groups and copied ads default to ENABLE. To keep all copied resources ineligible for delivery and spend, explicitly set operation_status to DISABLE on the campaign and on every copied ad group and ad; otherwise provider defaults may enable nested resources."
334684
},
334970
- {
334971
- "slug": "TIKTOK_ADS_CREATE_SPLIT_TEST",
334972
- "name": "Create a split test",
334973
- "description": "Create an ad-group or campaign-level split test. Campaign-level tests may require allowlisting."
334974
- },
334685
{
334686
"slug": "TIKTOK_ADS_CREATE_VIDEO_FIX_TASKS",
334687
"name": "Create Video Fix Tasks",
334688
"description": "Create up to 10 Smart Fix tasks for advertiser-owned videos."
334689
},
334980
- {
334981
- "slug": "TIKTOK_ADS_DELETE_BC_ASSET_ADMIN",
334982
- "name": "Delete assets from a BC",
334983
- "description": "Remove the specified asset from the Business Center. This revokes the Business Center relationship and can move a lead asset back to its prior ad account. Confirm the exact Business Center, asset type, and disposable asset ID before calling."
334984
- },
334985
- {
334986
- "slug": "TIKTOK_ADS_DELETE_BC_MEMBER",
334987
- "name": "Delete a member or revoke an invitation",
334988
- "description": "Remove an existing member from the Business Center or revoke a pending invitation. This revokes access or invalidates the invitation; confirm the exact disposable user ID or email before calling."
334989
- },
334990
- {
334991
- "slug": "TIKTOK_ADS_DELETE_BC_PARTNER",
334992
- "name": "Delete a partner from a BC",
334993
- "description": "Remove the partner relationship from the Business Center. This revokes the partner relationship and associated access; confirm both exact disposable Business Center IDs before calling."
334994
- },
334995
- {
334996
- "slug": "TIKTOK_ADS_DELETE_BC_PARTNER_ASSET",
334997
- "name": "Cancel the sharing of assets",
334998
- "description": "Cancel sharing the specified assets with the partner Business Center. The partner loses access to those assets; confirm the exact disposable partner and asset IDs before calling."
334999
- },
335000
- {
335001
- "slug": "TIKTOK_ADS_DELETE_BLOCKEDWORD",
335002
- "name": "Delete blocked words",
335003
- "description": "Destructively remove exact words from an advertiser's moderation block list. Confirm the advertiser and disposable targets before calling; comments containing removed words may no longer be flagged."
335004
- },
334690
{
334691
"slug": "TIKTOK_ADS_DELETE_BUSINESS_CENTER_ASSET_GROUP",
334692
"name": "Delete Business Center Asset Group",
334693
"description": "Delete one Asset Group from a TikTok Business Center. This destructive operation revokes members' access to the grouped assets, but does not delete the underlying members or assets."
334694
},
335010
- {
335011
- "slug": "TIKTOK_ADS_DELETE_CATALOG",
335012
- "name": "Delete a catalog",
335013
- "description": "Permanently delete a catalog from a Business Center."
335014
- },
335015
- {
335016
- "slug": "TIKTOK_ADS_DELETE_CATALOG_FEED",
335017
- "name": "Delete a feed",
335018
- "description": "Permanently delete a catalog feed."
335019
- },
335020
- {
335021
- "slug": "TIKTOK_ADS_DELETE_CATALOG_PRODUCT",
335022
- "name": "Remove products",
335023
- "description": "Remove products from a catalog using the ID list for that catalog type."
335024
- },
335025
- {
335026
- "slug": "TIKTOK_ADS_DELETE_CATALOG_SET",
335027
- "name": "Delete product sets",
335028
- "description": "Permanently delete one to ten catalog product sets."
335029
- },
334695
{
334696
"slug": "TIKTOK_ADS_DELETE_CATALOG_VIDEO",
334697
"name": "Delete Catalog Video",
334698
"description": "Permanently delete one uploaded video from an E-commerce catalog. This does not remove copies already synchronized to advertiser creative libraries."
334699
},
335035
- {
335036
- "slug": "TIKTOK_ADS_DELETE_COMMENT",
335037
- "name": "Delete a comment",
335038
- "description": "Permanently delete one TikTok comment. Before calling, confirm the exact advertiser, ad, video, identity, and disposable comment IDs; deletion cannot be undone."
335039
- },
334700
{
334701
"slug": "TIKTOK_ADS_DELETE_CREATIVE_ASSETS",
334702
"name": "Delete Creative Assets",
334703
"description": "Delete video or image assets owned by a TikTok advertiser account."
334704
},
335045
- {
335046
- "slug": "TIKTOK_ADS_DELETE_CREATIVE_PORTFOLIO",
335047
- "name": "Delete creative portfolios",
335048
- "description": "Permanently delete up to 100 eligible creative portfolios. Use only explicitly confirmed disposable targets; one invalid ID fails the batch."
335049
- },
335050
- {
335051
- "slug": "TIKTOK_ADS_DELETE_CUSTOM_CONVERSION",
335052
- "name": "Delete a Custom Conversion",
335053
- "description": "Delete a Custom Conversion configuration; this does not delete ingested events."
335054
- },
335055
- {
335056
- "slug": "TIKTOK_ADS_DELETE_DMP_CUSTOM_AUDIENCE",
335057
- "name": "Delete Custom Audiences",
335058
- "description": "Delete between one and 100 custom audiences."
335059
- },
335060
- {
335061
- "slug": "TIKTOK_ADS_DELETE_DMP_SAVED_AUDIENCE",
335062
- "name": "Delete Saved Audiences",
335063
- "description": "Delete up to 100 Saved Audiences."
335064
- },
334705
{
334706
"slug": "TIKTOK_ADS_DELETE_GMV_MAX_CAMPAIGN_SESSION",
334707
"name": "Delete GMV Max Session",
@@ -335077,26 +334717,6 @@
334717
"name": "Delete Customized Identity",
334718
"description": "Permanently delete a customized user identity from an advertiser account."
334719
},
335080
- {
335081
- "slug": "TIKTOK_ADS_DELETE_OFFLINE",
335082
- "name": "Delete an Offline Event Set",
335083
- "description": "Delete an Offline Event Set configuration; this is not an event-ingestion operation."
335084
- },
335085
- {
335086
- "slug": "TIKTOK_ADS_DELETE_PAGE_LEAD_MOCK",
335087
- "name": "Delete a test lead",
335088
- "description": "Permanently delete one exact disposable TikTok test lead. Confirm the owner and lead ID before calling."
335089
- },
335090
- {
335091
- "slug": "TIKTOK_ADS_DELETE_PIXEL_EVENT",
335092
- "name": "Delete a Pixel Event",
335093
- "description": "Delete a Pixel Event configuration; this does not delete ingested event occurrences."
335094
- },
335095
- {
335096
- "slug": "TIKTOK_ADS_DELETE_PLAYABLE",
335097
- "name": "Delete a playable asset",
335098
- "description": "Permanently delete one exact playable asset. Confirm the advertiser and a disposable playable ID before calling."
335099
- },
334720
{
334721
"slug": "TIKTOK_ADS_DELETE_SEARCH_AD_NEGATIVE_KEYWORDS",
334722
"name": "Delete Search Ad Negative Keywords",
@@ -335127,176 +334747,21 @@
334747
"name": "Disable Business Center Advertiser",
334748
"description": "Irreversibly disable one ad account in a TikTok Business Center. TikTok may reject accounts that are delivering ads, suspended, unpaid, mid-transfer, or have unbilled autopay charges."
334749
},
335130
- {
335131
- "slug": "TIKTOK_ADS_DISCOVER_SEARCH_KEYWORD_IDEAS",
335132
- "name": "Discover new keywords",
335133
- "description": "Discover search keyword ideas and historical search metrics."
335134
- },
335135
- {
335136
- "slug": "TIKTOK_ADS_DOWNLOAD_BC_INVOICE",
335137
- "name": "Download an invoice synchronously",
335138
- "description": "Download one Business Center invoice. The file contains finance-sensitive billing data; confirm the Business Center and invoice IDs, obtain authorization to access the invoice, and store or share the returned file only in an approved location."
335139
- },
335140
- {
335141
- "slug": "TIKTOK_ADS_DOWNLOAD_BLOCKEDWORD_TASK",
335142
- "name": "Download exported blocked words",
335143
- "description": "Download the result of a succeeded blocked-word export task. Confirm the advertiser and task IDs and store the moderation data only in an approved location."
335144
- },
335145
- {
335146
- "slug": "TIKTOK_ADS_DOWNLOAD_COMMENT_TASK",
335147
- "name": "Download exported comments",
335148
- "description": "Download CSV content from a succeeded comment export task. The file can contain public user content and identifiers; confirm the advertiser and task, then store or share it only in an approved location."
335149
- },
335150
- {
335151
- "slug": "TIKTOK_ADS_DOWNLOAD_PAGE_LEAD_TASK",
335152
- "name": "Download leads from a completed export task",
335153
- "description": "Download the CSV or ZIP produced by a completed TikTok lead export task. The file contains customer lead data, expires about 10 minutes after generation, and must be stored or shared only in an approved location."
335154
- },
335155
- {
335156
- "slug": "TIKTOK_ADS_DOWNLOAD_REPORT_TASK",
335157
- "name": "Get asynchronous report download",
335158
- "description": "Retrieve output for a successful asynchronous report task. Returns temporary download URL metadata for CSV_DOWNLOAD or XLSX_DOWNLOAD tasks, or inline UTF-8 CSV content for CSV_STRING tasks."
335159
- },
335160
- {
335161
- "slug": "TIKTOK_ADS_DOWNLOAD_SEARCH_AD_NEGATIVE_KEYWORD",
335162
- "name": "Download negative keywords",
335163
- "description": "Request the documented negative-keyword download result for a campaign or ad group."
335164
- },
335165
- {
335166
- "slug": "TIKTOK_ADS_EDIT_CREATIVE_IMAGE",
335167
- "name": "Edit an image",
335168
- "description": "Resize or Gaussian-pad an advertiser image."
335169
- },
335170
- {
335171
- "slug": "TIKTOK_ADS_END_SPLIT_TEST",
335172
- "name": "End a split test",
335173
- "description": "End an in-progress split test. This transition is irreversible."
335174
- },
335175
- {
335176
- "slug": "TIKTOK_ADS_ESTIMATE_AD_AUDIENCE_SIZE",
335177
- "name": "Estimate audience size",
335178
- "description": "Estimate audience size for documented placement, promotion, and targeting settings. Availability may depend on account entitlement."
335179
- },
335180
- {
335181
- "slug": "TIKTOK_ADS_ESTIMATE_RF_INVENTORY",
335182
- "name": "Get inventory estimates",
335183
- "description": "Get inventory estimates. Availability may depend on TikTok allowlisting or account entitlement."
335184
- },
335185
- {
335186
- "slug": "TIKTOK_ADS_GENERATE_CREATIVE_SMART_TEXT",
335187
- "name": "Generate Smart Text recommendations",
335188
- "description": "Generate Smart Text recommendations for an ad group."
335189
- },
335190
- {
335191
- "slug": "TIKTOK_ADS_GET_ACCOUNT_VERIFICATION",
335192
- "name": "Check the verification status of your account",
335193
- "description": "Check the verification status of an ad account or Business Center."
335194
- },
335195
- {
335196
- "slug": "TIKTOK_ADS_GET_ACCOUNT_VERIFICATION_FILETYPE",
335197
- "name": "Get available verification document types for a region",
335198
- "description": "Get available verification document types for a region."
335199
- },
334750
{
334751
"slug": "TIKTOK_ADS_GET_AD_BENCHMARK_REPORT",
334752
"name": "Get Ad Benchmarks",
334753
"description": "Get one page of ad benchmark dimensions and dynamic numeric metrics, scoped by exactly one ad_ids, adgroup_ids, or campaign_ids filter."
334754
},
335205
- {
335206
- "slug": "TIKTOK_ADS_GET_ADDITIONAL_INTEREST_CATEGORIES",
335207
- "name": "Get additional interest categories by ID",
335208
- "description": "Get up to 50 additional interest categories by ID and language."
335209
- },
335210
- {
335211
- "slug": "TIKTOK_ADS_GET_ADGROUP_DIAGNOSES",
335212
- "name": "Get diagnoses for ad groups",
335213
- "description": "Get issue diagnoses and suggestions for selected ad groups."
335214
- },
335215
- {
335216
- "slug": "TIKTOK_ADS_GET_ADGROUP_QUOTA",
335217
- "name": "Get the dynamic quota on active ad groups",
335218
- "description": "Get the dynamic quota on active ad groups."
335219
- },
335220
- {
335221
- "slug": "TIKTOK_ADS_GET_ADGROUP_REVIEW",
335222
- "name": "Get review info of ad groups",
335223
- "description": "Get review info of ad groups."
335224
- },
335225
- {
335226
- "slug": "TIKTOK_ADS_GET_ADGROUP_RF_ESTIMATED",
335227
- "name": "Get estimated info of R&F ad groups",
335228
- "description": "Get estimated info of R&F ad groups."
335229
- },
335230
- {
335231
- "slug": "TIKTOK_ADS_GET_AD_REVIEW",
335232
- "name": "Get review info of ads",
335233
- "description": "Get review information for one to 100 ads."
335234
- },
334755
{
334756
"slug": "TIKTOK_ADS_GET_ADVERTISER_ACCOUNTS",
334757
"name": "Get Advertiser Accounts",
335238
- "description": "Discover every advertiser account authorized for this connection when no IDs are supplied, or return full profile, status, timezone, and currency details for specified authorized advertiser IDs. Developer app credentials are injected securely from the OAuth auth config and are never action inputs."
335239
- },
335240
- {
335241
- "slug": "TIKTOK_ADS_GET_APP",
335242
- "name": "Get info of an app",
335243
- "description": "Get information about a mobile app configured for an advertiser."
335244
- },
335245
- {
335246
- "slug": "TIKTOK_ADS_GET_APP_OPTIMIZATION_EVENT",
335247
- "name": "Get App Conversion Events",
335248
- "description": "Get app conversion events available for advertising optimization."
335249
- },
335250
- {
335251
- "slug": "TIKTOK_ADS_GET_APP_OPTIMIZATION_EVENT_RETARGETING",
335252
- "name": "Get App Retargeting Events",
335253
- "description": "Get app retargeting events available for audience rules."
334758
+ "description": "Return profile, status, timezone, currency, and other default details for specified authorized TikTok advertiser accounts."
334759
},
334760
{
334761
"slug": "TIKTOK_ADS_GET_ASSET_BINDING_QUOTA",
334762
"name": "Get Asset Binding Quota",
334763
"description": "Get advertiser binding quota usage for a TikTok identity asset."
334764
},
335260
- {
335261
- "slug": "TIKTOK_ADS_GET_AUDIENCE_INSIGHT",
335262
- "name": "Get Details of Audience Overlap",
335263
- "description": "Get overlap details for a benchmark custom audience and up to four comparison audiences."
335264
- },
335265
- {
335266
- "slug": "TIKTOK_ADS_GET_AUDIENCE_INSIGHTS",
335267
- "name": "Get Audience Insights",
335268
- "description": "Get one audience insight dimension for locations or a custom audience."
335269
- },
335270
- {
335271
- "slug": "TIKTOK_ADS_GET_BC_ASSET_ADMIN",
335272
- "name": "Get assets as admin",
335273
- "description": "Get one page of assets administered by a Business Center."
335274
- },
335275
- {
335276
- "slug": "TIKTOK_ADS_GET_BC_ASSET_MEMBER",
335277
- "name": "Get members by an asset",
335278
- "description": "Get one page of Business Center members assigned to an asset."
335279
- },
335280
- {
335281
- "slug": "TIKTOK_ADS_GET_BC_INVOICE",
335282
- "name": "Get the invoices of a Business Center",
335283
- "description": "Return one page of Business Center invoices using documented type, payment, title, ID, and issuance-time filters. This exposes finance-sensitive invoice, tax, address, and balance data; confirm the Business Center and restrict the result to authorized recipients."
335284
- },
335285
- {
335286
- "slug": "TIKTOK_ADS_GET_BC_INVOICE_TASK",
335287
- "name": "Get an asynchronous invoice download task",
335288
- "description": "Get one asynchronous invoice download task and return its documented status, download URL, or XLSX stream. The result contains finance-sensitive billing data; confirm the Business Center and task IDs and use an approved storage destination."
335289
- },
335290
- {
335291
- "slug": "TIKTOK_ADS_GET_BC_INVOICE_UNPAID",
335292
- "name": "Get the unpaid amount of a Business Center",
335293
- "description": "Read the reconciliation-invoice unpaid amount for a Business Center. This exposes finance-sensitive balance data; confirm the Business Center and limit disclosure of the returned amount and currency to authorized recipients."
335294
- },
335295
- {
335296
- "slug": "TIKTOK_ADS_GET_BC_PARTNER_ASSET",
335297
- "name": "Get the assets of a partner",
335298
- "description": "Get one page of assets shared with or by a partner Business Center."
335299
- },
334765
{
334766
"slug": "TIKTOK_ADS_GET_BID_PROTECTION_DETAILS",
334767
"name": "Get Bid Protection Details",
@@ -335307,11 +334772,6 @@
334772
"name": "Get Bid Protection Statuses",
334773
"description": "Get bid protection statuses for up to 200 campaigns or ad groups."
334774
},
335310
- {
335311
- "slug": "TIKTOK_ADS_GET_BRAND_SAFETY_PARTNER_AUTHORIZATION_STATUS",
335312
- "name": "Get the authorization status of a Brand Safety partner",
335313
- "description": "Get a Brand Safety measurement partner's authorization status."
335314
- },
334775
{
334776
"slug": "TIKTOK_ADS_GET_BUSINESS_CENTER_ADVERTISER_ATTRIBUTES",
334777
"name": "Get Business Center Advertiser Attributes",
@@ -335332,126 +334792,31 @@
334792
"name": "Get Campaign Quota Information",
334793
"description": "Get SKAN Dedicated Campaign quota information by ad network."
334794
},
335335
- {
335336
- "slug": "TIKTOK_ADS_GET_CATALOG_AVAILABLE_COUNTRY",
335337
- "name": "Get available regions",
335338
- "description": "Get regions where ads for catalogs in a Business Center can be delivered."
335339
- },
334795
{
334796
"slug": "TIKTOK_ADS_GET_CATALOG_CATEGORY_INSIGHTS",
334797
"name": "Get Catalog Category Insights",
334798
"description": "Get up to 50 top trending product categories and availability metrics for an eligible E-commerce catalog, optionally filtered by category IDs."
334799
},
335345
- {
335346
- "slug": "TIKTOK_ADS_GET_CATALOG_EVENTSOURCE_BIND",
335347
- "name": "Get event source binding info of a catalog",
335348
- "description": "Get apps and pixels bound as event sources to a catalog."
335349
- },
335350
- {
335351
- "slug": "TIKTOK_ADS_GET_CATALOG_FEED",
335352
- "name": "Get feeds",
335353
- "description": "Get all feeds in a catalog or one feed by ID."
335354
- },
335355
- {
335356
- "slug": "TIKTOK_ADS_GET_CATALOG_FEED_LOG",
335357
- "name": "Get the log of a feed",
335358
- "description": "Get processing log entries for a catalog feed."
335359
- },
334800
{
334801
"slug": "TIKTOK_ADS_GET_CATALOG_INSIGHT_FILTERS",
334802
"name": "Get Catalog Insight Filters",
334803
"description": "Get one page of provider-approved category, brand, or availability filter values for product insight endpoints. TikTok returns no pagination metadata, so choose page and page_size explicitly when requesting additional pages."
334804
},
335365
- {
335366
- "slug": "TIKTOK_ADS_GET_CATALOG_LEXICON",
335367
- "name": "Get the lexicon list for a catalog",
335368
- "description": "Get the provider-defined lexicon list for a catalog."
335369
- },
335370
- {
335371
- "slug": "TIKTOK_ADS_GET_CATALOG_LOCATION_CURRENCY",
335372
- "name": "Get locations and currencies",
335373
- "description": "Get supported country or region and currency combinations for catalogs."
335374
- },
335375
- {
335376
- "slug": "TIKTOK_ADS_GET_CATALOG_OVERVIEW",
335377
- "name": "Get the overview of a catalog",
335378
- "description": "Get product audit totals for a catalog."
335379
- },
335380
- {
335381
- "slug": "TIKTOK_ADS_GET_CATALOG_PRODUCT",
335382
- "name": "Get products",
335383
- "description": "Get one page of catalog products with optional IDs, filters, and ordering."
335384
- },
334805
{
334806
"slug": "TIKTOK_ADS_GET_CATALOG_PRODUCT_DIAGNOSTIC_TASK",
334807
"name": "Get Catalog Product Diagnostic Task",
334808
"description": "Get an asynchronous catalog product diagnostic task result."
334809
},
335390
- {
335391
- "slug": "TIKTOK_ADS_GET_CATALOG_PRODUCT_LOG",
335392
- "name": "Get the product handling log",
335393
- "description": "Get processing counts, errors, warnings, and downloads for a product handling task."
335394
- },
335395
- {
335396
- "slug": "TIKTOK_ADS_GET_CATALOG_SET",
335397
- "name": "Get product sets",
335398
- "description": "Get all product sets in a catalog or one product set by ID."
335399
- },
335400
- {
335401
- "slug": "TIKTOK_ADS_GET_CATALOG_SET_PRODUCT",
335402
- "name": "Get products in a product set",
335403
- "description": "Get one page of products in a catalog product set."
335404
- },
335405
- {
335406
- "slug": "TIKTOK_ADS_GET_CATALOG_VIDEO_LOG",
335407
- "name": "Get the catalog video handling log",
335408
- "description": "Get processing counts, errors, warnings, and downloads for a catalog video task."
335409
- },
335410
- {
335411
- "slug": "TIKTOK_ADS_GET_CATALOG_VIDEO_PACKAGE",
335412
- "name": "Get video packages",
335413
- "description": "Get catalog video packages, optionally restricted to one package ID."
335414
- },
335415
- {
335416
- "slug": "TIKTOK_ADS_GET_COMMENT_REFERENCE",
335417
- "name": "Get related comments",
335418
- "description": "Read one page of comments related to a specific TikTok comment and return an opaque continuation cursor. This action does not alter moderation state."
335419
- },
335420
- {
335421
- "slug": "TIKTOK_ADS_GET_CONTENT_EXCLUSION_CATEGORY_DETAILS",
335422
- "name": "Get details of content exclusion categories",
335423
- "description": "Get details for content exclusion or vertical sensitivity category IDs."
335424
- },
335425
- {
335426
- "slug": "TIKTOK_ADS_GET_CONTEXTUAL_TAG_DETAILS",
335427
- "name": "Get details of contextual tags",
335428
- "description": "Get details for specified contextual tag IDs."
335429
- },
334810
{
334811
"slug": "TIKTOK_ADS_GET_CREATIVE_ASSETS",
334812
"name": "Get Creative Assets",
334813
"description": "Return metadata for specified video or image assets in an authorized advertiser's Ads Asset Library."
334814
},
335435
- {
335436
- "slug": "TIKTOK_ADS_GET_CREATIVE_PORTFOLIO",
335437
- "name": "Get a portfolio by ID",
335438
- "description": "Get a creative portfolio by ID. Availability may depend on TikTok entitlement."
335439
- },
334815
{
334816
"slug": "TIKTOK_ADS_GET_CREATIVE_PRE_REVIEW_TASK",
334817
"name": "Get Creative Pre-Review Task",
334818
"description": "Get the result of a creative pre-review task."
334819
},
335445
- {
335446
- "slug": "TIKTOK_ADS_GET_CREATIVE_REPORT",
335447
- "name": "Get creative report",
335448
- "description": "Return one page of creative material performance with exact JSON-encoded filter and field-selection query parameters."
335449
- },
335450
- {
335451
- "slug": "TIKTOK_ADS_GET_CTM_MESSAGE_EVENT_SET",
335452
- "name": "Get the message event sets for ad creation",
335453
- "description": "Get message event sets available for instant-messaging ad creation."
335454
- },
334820
{
334821
"slug": "TIKTOK_ADS_GET_CUSTOM_AUDIENCE_DETAILS",
334822
"name": "Get Custom Audience Details",
@@ -335463,230 +334828,45 @@
334828
"description": "Get the advertisers with which a specific TikTok custom audience has been shared, including each sharing status."
334829
},
334830
{
335466
- "slug": "TIKTOK_ADS_GET_CUSTOM_CONVERSION",
335467
- "name": "Get the details of a Custom Conversion",
335468
- "description": "Get one Custom Conversion configured for a Pixel or app event source."
335469
- },
335470
- {
335471
- "slug": "TIKTOK_ADS_GET_DIAGNOSTIC_CATALOG_EVENTSOURCE_ISSUE",
335472
- "name": "Get catalog event source diagnostic information",
335473
- "description": "Get detected catalog app or pixel event source issues and suggested solutions."
335474
- },
335475
- {
335476
- "slug": "TIKTOK_ADS_GET_DIAGNOSTIC_CATALOG_EVENTSOURCE_METRIC",
335477
- "name": "Get catalog event trends and match rate",
335478
- "description": "Get daily app or pixel event trends and catalog content-ID match rates."
335479
- },
335480
- {
335481
- "slug": "TIKTOK_ADS_GET_DMP_CUSTOM_AUDIENCE_APPLY_LOG",
335482
- "name": "Get the Application Log of Audiences",
335483
- "description": "Return one page of audience application history."
335484
- },
335485
- {
335486
- "slug": "TIKTOK_ADS_GET_FILE_MUSIC",
335487
- "name": "Get the music list",
335488
- "description": "Get one page of advertiser music and return a continuation cursor."
335489
- },
335490
- {
335491
- "slug": "TIKTOK_ADS_GET_FILE_VIDEO_SUGGESTCOVER",
335492
- "name": "Get suggested thumbnails for a video",
335493
- "description": "Get up to ten suggested thumbnail images for an advertiser video."
335494
- },
335495
- {
335496
- "slug": "TIKTOK_ADS_GET_GMV_MAX_BID_RECOMMENDATION",
335497
- "name": "Get GMV Max Bid Recommendation",
335498
- "description": "Get TikTok's recommended GMV Max bid for an eligible advertiser and shop."
335499
- },
335500
- {
335501
- "slug": "TIKTOK_ADS_GET_GMV_MAX_CAMPAIGN",
335502
- "name": "Get GMV Max Campaigns",
335503
- "description": "Get one page of GMV Max campaigns."
335504
- },
335505
- {
335506
- "slug": "TIKTOK_ADS_GET_GMV_MAX_CAMPAIGN_INFO",
335507
- "name": "Get GMV Max Campaign Info",
335508
- "description": "Get information for one GMV Max campaign owned by an authorized advertiser."
335509
- },
335510
- {
335511
- "slug": "TIKTOK_ADS_GET_GMV_MAX_CAMPAIGN_SESSIONS",
335512
- "name": "Get GMV Max Sessions",
335513
- "description": "Get max delivery or creative boost session details by 1 to 20 exact session IDs. This is an ID lookup, not the active-session campaign listing; use LIST_GMV_MAX_CAMPAIGN_SESSIONS to list active sessions for one Product GMV Max campaign."
335514
- },
335515
- {
335516
- "slug": "TIKTOK_ADS_GET_GMV_MAX_EXCLUSIVE_AUTHORIZATION",
335517
- "name": "Get GMV Max Exclusive Authorization",
335518
- "description": "Get an advertiser account's exclusive authorization status for a TikTok Shop."
335519
- },
335520
- {
335521
- "slug": "TIKTOK_ADS_GET_GMV_MAX_REPORT",
335522
- "name": "Get GMV Max Report",
335523
- "description": "Run one paginated Product or LIVE GMV Max campaign report."
335524
- },
335525
- {
335526
- "slug": "TIKTOK_ADS_GET_GMV_MAX_VIDEO_PRODUCT_LINKS",
335527
- "name": "Get product linkage details of videos in customized posts",
335528
- "description": "Get product linkage details of videos in customized posts."
335529
- },
335530
- {
335531
- "slug": "TIKTOK_ADS_GET_IDENTITY_GET",
335532
- "name": "Get the Identity List",
335533
- "description": "Return one page of advertiser identities. Creator-account capabilities and availability are authorization gates: inspect can_pull_video, can_push_video, ads_only_mode, is_gpppa, and available_status before using an identity for posts or Spark Ads."
335534
- },
335535
- {
335536
- "slug": "TIKTOK_ADS_GET_IDENTITY_INFO",
335537
- "name": "Get Info About an Identity",
335538
- "description": "Get one advertiser identity. BC_AUTH_TT identities require the authorizing Business Center ID; returned capability flags determine whether that creator can retrieve, publish, or manage content."
335539
- },
335540
- {
335541
- "slug": "TIKTOK_ADS_GET_IDENTITY_LIVE",
335542
- "name": "Get Live Videos Under an Identity",
335543
- "description": "Return one page of live videos for an authorized TikTok account identity. The identity must expose live access; BC_AUTH_TT also requires its authorizing Business Center ID."
335544
- },
335545
- {
335546
- "slug": "TIKTOK_ADS_GET_IDENTITY_NATIVE_SERIES",
335547
- "name": "List Available TikTok Series",
335548
- "description": "Return one page of TikTok Series from a specified TikTok account identity that the advertiser can promote. This only lists available Series and does not create or purchase them."
335549
- },
335550
- {
335551
- "slug": "TIKTOK_ADS_GET_IDENTITY_VIDEO_GET",
335552
- "name": "Get Posts Under an Identity",
335553
- "description": "Return one page of posts visible through an authorized identity. AUTH_CODE exposes only creator-authorized posts; TT_USER and BC_AUTH_TT access depends on the account's can_pull_video capability, privacy status, and Business Center authorization."
335554
- },
335555
- {
335556
- "slug": "TIKTOK_ADS_GET_IDENTITY_VIDEO_INFO",
335557
- "name": "Get Info About TikTok Posts",
335558
- "description": "Get one or up to 20 posts associated with an authorized identity. Private/friends-only visibility and expired AUTH_CODE authorization can limit returned media; BC_AUTH_TT requires its authorizing Business Center ID."
335559
- },
335560
- {
335561
- "slug": "TIKTOK_ADS_GET_LEAD",
335562
- "name": "Get an Instant Form or Direct-Message Lead",
335563
- "description": "Retrieve lead answers and attribution metadata. The response can contain names, contact details, and other personal data supplied through form or direct-message questions; call only for an authorized advertiser or Business Center library, minimize retention, and do not disclose or reuse it outside the consented lead-processing purpose."
335564
- },
335565
- {
335566
- "slug": "TIKTOK_ADS_GET_LEAD_FIELD",
335567
- "name": "Get Lead Fields",
335568
- "description": "Retrieve only the field names and form metadata for Instant Form or direct-message leads. Lead schemas can reveal what personal data is collected; use only for an authorized advertiser or Business Center library and do not expose the result beyond the intended lead-processing purpose."
335569
- },
335570
- {
335571
- "slug": "TIKTOK_ADS_GET_MINIS",
335572
- "name": "Get the TikTok Minis within an ad account",
335573
- "description": "Get one page of TikTok Minis within an ad account."
335574
- },
335575
- {
335576
- "slug": "TIKTOK_ADS_GET_MMM_DOWNLOAD_URL",
335577
- "name": "Get MMM Download URL",
335578
- "description": "Obtain a seven-day signed URL for a completed MMM compressed CSV. This action does not follow the URL or download the sensitive report."
335579
- },
335580
- {
335581
- "slug": "TIKTOK_ADS_GET_MMM_REQUEST_HISTORY",
335582
- "name": "Get MMM Request History",
335583
- "description": "Retrieve MMM request metadata for a UTC+0 date interval. TikTok returns each history item as JSON-formatted text and does not document pagination."
335584
- },
335585
- {
335586
- "slug": "TIKTOK_ADS_GET_OFFLINE",
335587
- "name": "Get Offline Event Sets",
335588
- "description": "List Offline Event Set configurations; this management endpoint does not ingest offline events."
335589
- },
335590
- {
335591
- "slug": "TIKTOK_ADS_GET_OPTIMIZER_RULE",
335592
- "name": "Get rules by ID",
335593
- "description": "Get automated optimizer rules by ID."
335594
- },
335595
- {
335596
- "slug": "TIKTOK_ADS_GET_OPTIMIZER_RULE_RESULT",
335597
- "name": "Get result details",
335598
- "description": "Get automated optimizer rule result details."
335599
- },
335600
- {
335601
- "slug": "TIKTOK_ADS_GET_PAGE",
335602
- "name": "Get Instant Pages",
335603
- "description": "Return one page of Instant Forms and other TikTok Instant Page types."
335604
- },
335605
- {
335606
- "slug": "TIKTOK_ADS_GET_PAGE_FIELD",
335607
- "name": "Get the fields of an Instant Form",
335608
- "description": "Get the field definitions and metadata for one TikTok Instant Form."
335609
- },
335610
- {
335611
- "slug": "TIKTOK_ADS_GET_PAGE_LEAD_MOCK",
335612
- "name": "Get a test lead",
335613
- "description": "Get the current test lead for an Instant Form or direct-message lead source."
335614
- },
335615
- {
335616
- "slug": "TIKTOK_ADS_GET_PAGE_LIBRARY",
335617
- "name": "Get form libraries",
335618
- "description": "Return one page of Business Center form libraries accessible to the connected user."
335619
- },
335620
- {
335621
- "slug": "TIKTOK_ADS_GET_PANGLE_BLOCK_LIST",
335622
- "name": "Get the Pangle Block List",
335623
- "description": "Get an advertiser's Pangle app block list and its last modification time."
335624
- },
335625
- {
335626
- "slug": "TIKTOK_ADS_GET_PAYMENT_PORTFOLIO",
335627
- "name": "Get Payment Portfolios",
335628
- "description": "Return one page of Payment Portfolios, cash balances, and credit line usage. This exposes highly sensitive financial capacity and account relationships; confirm the Business Center and filters and disclose results only to authorized finance administrators."
335629
- },
335630
- {
335631
- "slug": "TIKTOK_ADS_GET_PAYMENT_PORTFOLIO_ADVERTISER",
335632
- "name": "Get ad accounts linked to a Payment Portfolio",
335633
- "description": "Return one page of ad accounts linked to a Payment Portfolio. This is read-only but reveals finance-sensitive payment relationships; confirm the portfolio ID and disclose the result only to authorized finance administrators."
335634
- },
335635
- {
335636
- "slug": "TIKTOK_ADS_GET_PAYMENT_PORTFOLIO_USER",
335637
- "name": "Get authorized users for a Payment Portfolio",
335638
- "description": "Return one page of users authorized for a Payment Portfolio. This is read-only but reveals finance access assignments; confirm the portfolio ID and disclose the result only to authorized administrators."
335639
- },
335640
- {
335641
- "slug": "TIKTOK_ADS_GET_PIXEL_EVENT_STATS",
335642
- "name": "Get Pixel Event statistics",
335643
- "description": "Get UTC Pixel Event statistics; this reporting endpoint does not ingest events."
335644
- },
335645
- {
335646
- "slug": "TIKTOK_ADS_GET_PIXEL_INSTANT_PAGE_EVENT",
335647
- "name": "Get Instant Page events",
335648
- "description": "Get supported TikTok Instant Page event options for an optimization goal."
334831
+ "slug": "TIKTOK_ADS_GET_GMV_MAX_BID_RECOMMENDATION",
334832
+ "name": "Get GMV Max Bid Recommendation",
334833
+ "description": "Get TikTok's recommended GMV Max bid for an eligible advertiser and shop."
334834
},
334835
{
335651
- "slug": "TIKTOK_ADS_GET_PLAYABLE",
335652
- "name": "Get playable assets",
335653
- "description": "Return one page of playable assets for an advertiser."
334836
+ "slug": "TIKTOK_ADS_GET_GMV_MAX_CAMPAIGN_INFO",
334837
+ "name": "Get GMV Max Campaign Info",
334838
+ "description": "Get information for one GMV Max campaign owned by an authorized advertiser."
334839
},
334840
{
335656
- "slug": "TIKTOK_ADS_GET_RECOMMENDED_CREATIVE_CTA",
335657
- "name": "Get recommended CTAs",
335658
- "description": "Get standard or Dynamic CTA recommendations for an advertiser."
334841
+ "slug": "TIKTOK_ADS_GET_GMV_MAX_CAMPAIGN_SESSIONS",
334842
+ "name": "Get GMV Max Sessions",
334843
+ "description": "Get max delivery or creative boost session details by 1 to 20 exact session IDs. This is an ID lookup, not the active-session campaign listing; use LIST_GMV_MAX_CAMPAIGN_SESSIONS to list active sessions for one Product GMV Max campaign."
334844
},
334845
{
335661
- "slug": "TIKTOK_ADS_GET_REPORT_INTEGRATED",
335662
- "name": "Run synchronous integrated report",
335663
- "description": "Return one page of a synchronous TikTok report with dimensions, metrics, advertiser lists, and filters encoded as provider JSON query values."
334846
+ "slug": "TIKTOK_ADS_GET_GMV_MAX_EXCLUSIVE_AUTHORIZATION",
334847
+ "name": "Get GMV Max Exclusive Authorization",
334848
+ "description": "Get an advertiser account's exclusive authorization status for a TikTok Shop."
334849
},
334850
{
335666
- "slug": "TIKTOK_ADS_GET_RF_DELIVERY_TIMEZONE",
335667
- "name": "Get R&F time zones",
335668
- "description": "Get R&F time zones."
334851
+ "slug": "TIKTOK_ADS_GET_GMV_MAX_REPORT",
334852
+ "name": "Get GMV Max Report",
334853
+ "description": "Run one paginated Product or LIVE GMV Max campaign report."
334854
},
334855
{
335671
- "slug": "TIKTOK_ADS_GET_SEARCH_AD_HEALTH_DIAGNOSES",
335672
- "name": "Get Search Ads Campaign Health diagnoses",
335673
- "description": "Get Search Ads Campaign Health diagnoses for an ad group or ads."
334856
+ "slug": "TIKTOK_ADS_GET_MMM_DOWNLOAD_URL",
334857
+ "name": "Get MMM Download URL",
334858
+ "description": "Obtain a seven-day signed URL for a completed MMM compressed CSV. This action does not follow the URL or download the sensitive report."
334859
},
334860
{
335676
- "slug": "TIKTOK_ADS_GET_SEARCH_REGION",
335677
- "name": "Get available locations by advertiser ID",
335678
- "description": "Get all locations available to an advertiser, with translated names."
334861
+ "slug": "TIKTOK_ADS_GET_MMM_REQUEST_HISTORY",
334862
+ "name": "Get MMM Request History",
334863
+ "description": "Retrieve MMM request metadata for a UTC+0 date interval. TikTok returns each history item as JSON-formatted text and does not document pagination."
334864
},
334865
{
334866
"slug": "TIKTOK_ADS_GET_SHOWCASE_IDENTITY",
334867
"name": "Get Showcase Identity",
334868
"description": "Get the identity with Showcase permission under an ad account."
334869
},
335685
- {
335686
- "slug": "TIKTOK_ADS_GET_SMART_CREATIVE_MATERIALS",
335687
- "name": "Get Smart Creative Materials",
335688
- "description": "Get current Smart Creative materials for 1-100 ad groups. The provider returns one complete bounded result and documents no page or cursor wire parameters. This reads SMART_CREATIVE mode, not retired DYNAMIC ACO."
335689
- },
334870
{
334871
"slug": "TIKTOK_ADS_GET_SMART_PLUS_MATERIAL_REPORT",
334872
"name": "Get Smart+ Material Report",
@@ -335707,46 +334887,6 @@
334887
"name": "Get Smart+ Review Info",
334888
"description": "Get review information for Smart+ ads or ad materials."
334889
},
335710
- {
335711
- "slug": "TIKTOK_ADS_GET_SPLIT_TEST_RESULT",
335712
- "name": "Get the results of a split test",
335713
- "description": "Get the current status and statistical results of a split test."
335714
- },
335715
- {
335716
- "slug": "TIKTOK_ADS_GET_STORE_PRODUCT",
335717
- "name": "Get products within a TikTok Shop",
335718
- "description": "Get one page of products within a TikTok Shop."
335719
- },
335720
- {
335721
- "slug": "TIKTOK_ADS_GET_SUBSCRIPTION",
335722
- "name": "Get subscription details of a developer app",
335723
- "description": "Return one page of webhook subscriptions configured for a developer application."
335724
- },
335725
- {
335726
- "slug": "TIKTOK_ADS_GET_TARGETING_HASHTAGS",
335727
- "name": "Get targeting hashtags by ID",
335728
- "description": "Get targeting hashtag names and availability by keyword ID."
335729
- },
335730
- {
335731
- "slug": "TIKTOK_ADS_GET_TARGETING_TAG_DETAILS",
335732
- "name": "Get targeting information",
335733
- "description": "Get geographical or ISP targeting tag details by targeting ID."
335734
- },
335735
- {
335736
- "slug": "TIKTOK_ADS_GET_TERM",
335737
- "name": "Get Terms",
335738
- "description": "Get an advertiser agreement in the requested language."
335739
- },
335740
- {
335741
- "slug": "TIKTOK_ADS_GET_TIKTOK_INVENTORY_FILTERS",
335742
- "name": "Get the Brand Safety Hub settings of an ad account",
335743
- "description": "Get the Brand Safety Hub settings configured for an advertiser account."
335744
- },
335745
- {
335746
- "slug": "TIKTOK_ADS_GET_TT_VIDEO",
335747
- "name": "Get Info About a Spark Ad Post",
335748
- "description": "Resolve a creator-issued Spark post authorization code into post, creator, media, and authorization-window details. Possessing advertiser OAuth does not authorize the creator's post; the creator must issue the code, and expired or restricted posts may not be usable."
335749
- },
334890
{
334891
"slug": "TIKTOK_ADS_GET_VIDEO_FIX_TASK",
334892
"name": "Get Video Fix Task",
@@ -335758,9 +334898,9 @@
334898
"description": "Get one page of in-second AD or VIDEO performance. VIDEO mode supports either lifetime data or a bounded start_time/end_time window and returns dynamic metric arrays with ad_id, video_id, and duration info."
334899
},
334900
{
335761
- "slug": "TIKTOK_ADS_INVITE_BC_MEMBER",
335762
- "name": "Invite members to a BC",
335763
- "description": "Invite users to a Business Center and optionally assign advertiser and finance roles."
334901
+ "slug": "TIKTOK_ADS_LIST_AD_ACCOUNTS_LINKED_TO_TIKTOK_ACCOUNT",
334902
+ "name": "List Ad Accounts Linked to TikTok Account",
334903
+ "description": "List one page of ad accounts linked to one TikTok account asset in a Business Center."
334904
},
334905
{
334906
"slug": "TIKTOK_ADS_LIST_AD_GROUPS",
@@ -335787,41 +334927,11 @@
334927
"name": "List Advertiser Qualifications",
334928
"description": "List one page of reusable advertiser qualification records in a Business Center, optionally filtered by verification status."
334929
},
335790
- {
335791
- "slug": "TIKTOK_ADS_LIST_ADVERTISER_TIMEZONES",
335792
- "name": "Get time zones",
335793
- "description": "Get time zones available to advertisers."
335794
- },
334930
{
334931
"slug": "TIKTOK_ADS_LIST_ADVERTISER_TRANSACTIONS",
334932
"name": "List Advertiser Transactions",
334933
"description": "List one page of advertiser billing transactions accessible through a Business Center, with optional transaction type, fund type, account, and UTC date filters."
334934
},
335800
- {
335801
- "slug": "TIKTOK_ADS_LIST_APP",
335802
- "name": "Get the app list",
335803
- "description": "Get the mobile apps configured for an advertiser."
335804
- },
335805
- {
335806
- "slug": "TIKTOK_ADS_LIST_APP_ATTRIBUTION_SOURCES",
335807
- "name": "Get available attribution sources and data sources for an app",
335808
- "description": "Get attribution sources and data sources available for a mobile app."
335809
- },
335810
- {
335811
- "slug": "TIKTOK_ADS_LIST_BC_BILLING_GROUP_ADVERTISER",
335812
- "name": "Get the advertiser list of a Billing Group",
335813
- "description": "Return one page of ad accounts assigned to a Billing Group. This is read-only but exposes finance-sensitive billing membership; confirm the Business Center and Billing Group before retrieving or sharing the result."
335814
- },
335815
- {
335816
- "slug": "TIKTOK_ADS_LIST_BC_INVOICE_TASK",
335817
- "name": "Get asynchronous invoice download task list",
335818
- "description": "Return one page of asynchronous invoice download tasks and their download URLs. These references expose finance-sensitive billing files; confirm the Business Center and share or download them only to approved destinations."
335819
- },
335820
- {
335821
- "slug": "TIKTOK_ADS_LIST_BLOCKEDWORD",
335822
- "name": "Get blocked words",
335823
- "description": "Return one page of an advertiser's blocked-word moderation list and an opaque continuation cursor when more results exist."
335824
- },
334935
{
334936
"slug": "TIKTOK_ADS_LIST_BUSINESS_CENTER_ACCOUNT_COSTS",
334937
"name": "List Business Center Account Costs",
@@ -335907,21 +335017,6 @@
335017
"name": "Get Catalog Videos",
335018
"description": "Get one page of uploaded videos from a catalog."
335019
},
335910
- {
335911
- "slug": "TIKTOK_ADS_LIST_COMMENT",
335912
- "name": "Get comments",
335913
- "description": "Read one page of comments for a specific advertiser, ad group, and date range. Returns an opaque continuation cursor and does not change moderation state."
335914
- },
335915
- {
335916
- "slug": "TIKTOK_ADS_LIST_CONTENT_EXCLUSION_CATEGORIES",
335917
- "name": "Get available content exclusion categories",
335918
- "description": "Get content exclusion and vertical sensitivity categories for an objective."
335919
- },
335920
- {
335921
- "slug": "TIKTOK_ADS_LIST_CONTEXTUAL_TAGS",
335922
- "name": "Get available contextual tags",
335923
- "description": "Get contextual tags available for an objective and optional regions."
335924
- },
335020
{
335021
"slug": "TIKTOK_ADS_LIST_CREATIVE_AUTO_MESSAGES",
335022
"name": "Get Creative Welcome Messages",
@@ -335937,26 +335032,11 @@
335032
"name": "List Creative Portfolios",
335033
"description": "List one provider page of interactive creative portfolios for an advertiser."
335034
},
335940
- {
335941
- "slug": "TIKTOK_ADS_LIST_CRM",
335942
- "name": "Get CRM Event Sets",
335943
- "description": "Get CRM Event Sets for an advertiser, optionally filtered by name or ID."
335944
- },
335035
{
335036
"slug": "TIKTOK_ADS_LIST_CUSTOM_AUDIENCES",
335037
"name": "List Custom Audiences",
335038
"description": "List one page of owned and shared custom audiences for an authorized advertiser, optionally restricted to specified audience IDs."
335039
},
335950
- {
335951
- "slug": "TIKTOK_ADS_LIST_CUSTOM_CONVERSION",
335952
- "name": "Get Custom Conversions associated with an event source",
335953
- "description": "Return one page of Custom Conversions configured for a Pixel or app event source."
335954
- },
335955
- {
335956
- "slug": "TIKTOK_ADS_LIST_DMP_SAVED_AUDIENCE",
335957
- "name": "Get Details of Saved Audiences",
335958
- "description": "Return one page of Saved Audience details."
335959
- },
335040
{
335041
"slug": "TIKTOK_ADS_LIST_GMV_MAX_CAMPAIGN_SESSIONS",
335042
"name": "List GMV Max Campaign Sessions",
@@ -335972,11 +335052,6 @@
335052
"name": "List GMV Max Identities",
335053
"description": "List identities available to an advertiser for GMV Max campaigns."
335054
},
335975
- {
335976
- "slug": "TIKTOK_ADS_LIST_GMV_MAX_OCCUPYING_ADS",
335977
- "name": "Check GMV Max Occupied Custom Shop Ads",
335978
- "description": "Check which Shopping Ads occupy one TikTok Shop identity or product asset."
335979
- },
335055
{
335056
"slug": "TIKTOK_ADS_LIST_GMV_MAX_STORES",
335057
"name": "List TikTok Shops for GMV Max",
@@ -335987,31 +335062,11 @@
335062
"name": "List GMV Max Videos",
335063
"description": "List one page of authorized or custom-post-eligible TikTok posts for a Product GMV Max campaign."
335064
},
335990
- {
335991
- "slug": "TIKTOK_ADS_LIST_OPTIMIZER_RULE",
335992
- "name": "Get rules by filters",
335993
- "description": "Get one page of automated optimizer rules by filters."
335994
- },
335995
- {
335996
- "slug": "TIKTOK_ADS_LIST_OPTIMIZER_RULE_RESULT",
335997
- "name": "Get rule results",
335998
- "description": "Get one page of automated optimizer rule results."
335999
- },
335065
{
335066
"slug": "TIKTOK_ADS_LIST_PANGLE_AUDIENCE_PACKAGES",
335067
"name": "List Pangle Audience Packages",
335068
"description": "List the include and exclude audience packages available for an advertiser's Pangle targeting configuration."
335069
},
336005
- {
336006
- "slug": "TIKTOK_ADS_LIST_PHONE_REGION_CODES",
336007
- "name": "Get phone region codes",
336008
- "description": "Get region names, region codes, and calling codes for phone numbers."
336009
- },
336010
- {
336011
- "slug": "TIKTOK_ADS_LIST_PIXEL",
336012
- "name": "Get Pixels",
336013
- "description": "Return one page of Pixels and their configured Pixel Events."
336014
- },
335070
{
335071
"slug": "TIKTOK_ADS_LIST_RECOMMENDED_SEARCH_KEYWORDS",
335072
"name": "Get Recommended Search Keywords",
@@ -336047,56 +335102,6 @@
335102
"name": "Get Smart+ Campaigns",
335103
"description": "List Smart+ campaign details through TikTok's dedicated /smart_plus/campaign/get/ endpoint. Select this instead of LIST_CAMPAIGNS for an exact Smart+ endpoint read; use LIST_CAMPAIGNS for regular or mixed-automation inventory."
335104
},
336050
- {
336051
- "slug": "TIKTOK_ADS_LIST_STORE",
336052
- "name": "Get available stores under an ad account",
336053
- "description": "Get available TikTok Shops under an ad account."
336054
- },
336055
- {
336056
- "slug": "TIKTOK_ADS_LIST_TARGETABLE_CARRIERS",
336057
- "name": "Get carriers",
336058
- "description": "Get carriers available for ad targeting by country or region."
336059
- },
336060
- {
336061
- "slug": "TIKTOK_ADS_LIST_TARGETABLE_DEVICE_MODELS",
336062
- "name": "Get device models",
336063
- "description": "Get device models available for ad targeting."
336064
- },
336065
- {
336066
- "slug": "TIKTOK_ADS_LIST_TARGETABLE_ISPS",
336067
- "name": "Get internet service providers",
336068
- "description": "Get ISP targeting tags supported for specified country- or region-level locations."
336069
- },
336070
- {
336071
- "slug": "TIKTOK_ADS_LIST_TARGETABLE_LANGUAGES",
336072
- "name": "Get languages",
336073
- "description": "Get languages available for ad targeting."
336074
- },
336075
- {
336076
- "slug": "TIKTOK_ADS_LIST_TARGETABLE_OS_VERSIONS",
336077
- "name": "Get OS versions",
336078
- "description": "Get operating-system versions available for targeting."
336079
- },
336080
- {
336081
- "slug": "TIKTOK_ADS_LIST_TARGETABLE_REGIONS",
336082
- "name": "Get targeting regions",
336083
- "description": "Get locations available for an advertiser's placement, objective, and campaign settings."
336084
- },
336085
- {
336086
- "slug": "TIKTOK_ADS_LIST_TARGETING_ACTION_CATEGORIES",
336087
- "name": "Get action categories",
336088
- "description": "Get targeting action categories available to an advertiser."
336089
- },
336090
- {
336091
- "slug": "TIKTOK_ADS_LIST_TARGETING_INTEREST_CATEGORIES",
336092
- "name": "Get interest categories",
336093
- "description": "Get advertiser interest categories, optionally filtered by placement and special industry."
336094
- },
336095
- {
336096
- "slug": "TIKTOK_ADS_LIST_TIKTOK_LINKED_AD_ACCOUNTS",
336097
- "name": "List Ad Accounts Linked to TikTok Account",
336098
- "description": "List one page of ad accounts linked to one TikTok account asset in a Business Center."
336099
- },
335105
{
335106
"slug": "TIKTOK_ADS_LIST_TRENDING_CATALOG_PRODUCTS",
335107
"name": "Get Trending Catalog Products",
@@ -336117,86 +335122,6 @@
335122
"name": "Get Trending Search Keywords",
335123
"description": "Get the top 20 TikTok search keywords, optionally personalized for a Business Account."
335124
},
336120
- {
336121
- "slug": "TIKTOK_ADS_LIST_TT_VIDEO",
336122
- "name": "Get Spark Ad Posts",
336123
- "description": "Return one page of Spark posts bound to an advertiser. Each post remains subject to its creator-issued authorization status and window; advertiser OAuth alone does not grant rights to use a creator's post."
336124
- },
336125
- {
336126
- "slug": "TIKTOK_ADS_MIGRATE_CATALOG",
336127
- "name": "Migrate a catalog to a BC",
336128
- "description": "Migrate a catalog from an ad account to a Business Center."
336129
- },
336130
- {
336131
- "slug": "TIKTOK_ADS_PROMOTE_SPLIT_TEST",
336132
- "name": "Run the winning ad group",
336133
- "description": "End a split test by promoting its selected winning ad group and starting that ad group's delivery, which may incur spend."
336134
- },
336135
- {
336136
- "slug": "TIKTOK_ADS_QUERY_RF_CONTRACT",
336137
- "name": "Query contracts",
336138
- "description": "Query contracts. This operation can affect billing, credit, invoices, budgets, contracts, or payments; require explicit approval and an isolated account. Availability may depend on TikTok allowlisting or account entitlement."
336139
- },
336140
- {
336141
- "slug": "TIKTOK_ADS_RECOMMEND_BID",
336142
- "name": "Get a suggested bid",
336143
- "description": "Get a suggested bid for an objective and target locations."
336144
- },
336145
- {
336146
- "slug": "TIKTOK_ADS_RECOMMEND_INTEREST_CATEGORIES",
336147
- "name": "Recommend additional interest categories",
336148
- "description": "Recommend additional interest categories from one or more seed keywords."
336149
- },
336150
- {
336151
- "slug": "TIKTOK_ADS_RECOMMEND_SEARCH_KEYWORDS",
336152
- "name": "Get recommended search keywords",
336153
- "description": "Get one page of recommended search keywords from exactly one seed type."
336154
- },
336155
- {
336156
- "slug": "TIKTOK_ADS_RECOMMEND_TARGETING_CATEGORIES",
336157
- "name": "Recommend targeting categories",
336158
- "description": "Recommend interest and action targeting categories for specified regions and an optional app."
336159
- },
336160
- {
336161
- "slug": "TIKTOK_ADS_RECOMMEND_TARGETING_HASHTAGS",
336162
- "name": "Search for targeting hashtags",
336163
- "description": "Generate targeting hashtag recommendations from up to ten seed keywords."
336164
- },
336165
- {
336166
- "slug": "TIKTOK_ADS_REPLY_TO_COMMENT",
336167
- "name": "Reply to a comment",
336168
- "description": "Publish a public reply as the specified TikTok identity. Confirm the account, target comment, identity, and final text before calling; the reply is externally visible."
336169
- },
336170
- {
336171
- "slug": "TIKTOK_ADS_SAVE_PLAYABLE",
336172
- "name": "Save a playable asset",
336173
- "description": "Save and name a previously uploaded playable asset for an advertiser."
336174
- },
336175
- {
336176
- "slug": "TIKTOK_ADS_SEARCH_FILE_IMAGE_AD",
336177
- "name": "Search for images",
336178
- "description": "Search for one page of advertiser images and return a continuation cursor."
336179
- },
336180
- {
336181
- "slug": "TIKTOK_ADS_SEARCH_FILE_VIDEO_AD",
336182
- "name": "Search for videos",
336183
- "description": "Search for one page of advertiser videos and return a continuation cursor."
336184
- },
336185
- {
336186
- "slug": "TIKTOK_ADS_SEARCH_TARGETING",
336187
- "name": "Search or list interest and behavior targeting",
336188
- "description": "Search for or list targeting categories and hashtags for interests and behaviors."
336189
- },
336190
- {
336191
- "slug": "TIKTOK_ADS_SEARCH_TARGETING_LOCATIONS",
336192
- "name": "Search targeting tags",
336193
- "description": "Search geographical targeting tags by location, ZIP-code, or postal-code keywords."
336194
- },
336195
- {
336196
- "slug": "TIKTOK_ADS_SET_AUDIENCE_SEGMENT",
336197
- "name": "Create or Delete an Audience Segment",
336198
- "description": "Create a named audience segment or delete one by audience ID."
336199
- },
335125
{
335126
"slug": "TIKTOK_ADS_SET_SEARCH_AD_NEGATIVE_KEYWORDS",
335127
"name": "Set Search Ad Negative Keywords",
@@ -336227,111 +335152,21 @@
335152
"name": "Share Creative Assets",
335153
"description": "Share controlled creative assets from one advertiser with specified target advertiser accounts."
335154
},
336230
- {
336231
- "slug": "TIKTOK_ADS_SHARE_CUSTOM_AUDIENCES",
336232
- "name": "Share Custom Audiences",
336233
- "description": "Share up to ten custom audiences with up to ten advertisers in the same Business Center."
336234
- },
335155
{
335156
"slug": "TIKTOK_ADS_SMART_PLUS_AD_PREVIEW",
335157
"name": "Preview Smart+ Ad",
335158
"description": "Generate a preview link or iframe for a proposed or existing Upgraded Smart+ ad. This is a human-review handoff: have a person inspect the returned rendering before using a separate creation or update tool. This tool never creates or updates an ad."
335159
},
336240
- {
336241
- "slug": "TIKTOK_ADS_SUBMIT_ACCOUNT_VERIFICATION",
336242
- "name": "Submit a verification request for your account",
336243
- "description": "Submit sensitive business or individual identity details for external review of an ad account or Business Center; the submission cannot be withdrawn through this tool."
336244
- },
336245
- {
336246
- "slug": "TIKTOK_ADS_SUBMIT_CREATIVE_SMART_TEXT",
336247
- "name": "Submit Smart Text feedback",
336248
- "description": "Submit Smart Text recommendation parameters through the feedback route."
336249
- },
336250
- {
336251
- "slug": "TIKTOK_ADS_SUBMIT_LEAD_EVENTS",
336252
- "name": "Create or poll a lead download task",
336253
- "description": "Create an asynchronous export task for leads from one Instant Form or ad, or poll an existing task. This is a lead export endpoint, not Events API ingestion; only ad-account or Business Center admins can use it."
336254
- },
335160
{
335161
"slug": "TIKTOK_ADS_SUBMIT_UNIONPAY_VERIFICATION",
335162
"name": "Submit UnionPay Verification",
335163
"description": "Submit identity and UnionPay account details to verify an eligible business license. This starts a sensitive review with no documented rollback."
335164
},
336260
- {
336261
- "slug": "TIKTOK_ADS_SUBSCRIBE_SUBSCRIPTION",
336262
- "name": "Create a subscription",
336263
- "description": "Create a webhook subscription for a developer application and external callback URL."
336264
- },
336265
- {
336266
- "slug": "TIKTOK_ADS_TRANSFER_BC",
336267
- "name": "Process a payment",
336268
- "description": "Irreversibly recharge or deduct cash, vouchers, or credit for an ad account or Business Center. This moves real financial value and cannot be assumed reversible. Require explicit finance-owner confirmation immediately before execution; verify the level, payer and payee IDs, portfolio, RECHARGE versus REFUND direction, currency context, every amount, minimum transfer limits, and a fresh idempotency request ID. Never retry with a different request ID after an uncertain result. Some behavior is allowlist-only."
336269
- },
336270
- {
336271
- "slug": "TIKTOK_ADS_TRANSFER_BC_PIXEL",
336272
- "name": "Transfer a pixel from advertiser to BC",
336273
- "description": "Permanently transfer ownership of the specified advertiser pixel to the destination Business Center. This ownership transfer is irreversible through this tool; confirm the exact pixel and destination Business Center before calling."
336274
- },
336275
- {
336276
- "slug": "TIKTOK_ADS_TRANSFER_PAGE_LIBRARY",
336277
- "name": "Migrate leads to a Business Center",
336278
- "description": "Migrate an advertiser's leads into a newly created Business Center form library. Confirm both account IDs before changing lead ownership location."
336279
- },
336280
- {
336281
- "slug": "TIKTOK_ADS_UNASSIGN_BC_ASSET",
336282
- "name": "Unassign an asset",
336283
- "description": "Revoke the specified member's access to the Business Center asset. The member immediately loses the assigned permissions; confirm the exact disposable member and asset before calling."
336284
- },
335165
{
335166
"slug": "TIKTOK_ADS_UNASSIGN_TIKTOK_ACCOUNT_FROM_ADVERTISER",
335167
"name": "Unassign TikTok Account From Advertiser",
335168
"description": "Unlink a TikTok account from an ad account in the same Business Center. This destructively removes the existing account association."
335169
},
336290
- {
336291
- "slug": "TIKTOK_ADS_UNBIND_CATALOG_EVENTSOURCE",
336292
- "name": "Unbind an event source from a catalog",
336293
- "description": "Unbind a mobile app, website Pixel, or both from a catalog."
336294
- },
336295
- {
336296
- "slug": "TIKTOK_ADS_UNBIND_TT_VIDEO",
336297
- "name": "Unbind a Spark Ad Post",
336298
- "description": "Irreversibly remove an advertiser's binding to the exact Spark post. Confirm the advertiser and post with the user before calling; using the post again requires a valid creator-issued authorization flow."
336299
- },
336300
- {
336301
- "slug": "TIKTOK_ADS_UNSUBSCRIBE_SUBSCRIPTION",
336302
- "name": "Cancel a subscription",
336303
- "description": "Irreversibly cancel a developer-app webhook subscription."
336304
- },
336305
- {
336306
- "slug": "TIKTOK_ADS_UPDATE_AD",
336307
- "name": "Update ads",
336308
- "description": "Update ordinary ads and their documented creative fields."
336309
- },
336310
- {
336311
- "slug": "TIKTOK_ADS_UPDATE_ADGROUP",
336312
- "name": "Update an ad group",
336313
- "description": "Update an ad group. Availability may depend on TikTok allowlisting or account entitlement."
336314
- },
336315
- {
336316
- "slug": "TIKTOK_ADS_UPDATE_ADGROUP_BUDGET",
336317
- "name": "Update the budgets of ad groups",
336318
- "description": "Update the budgets of ad groups. This operation can affect billing, credit, invoices, budgets, contracts, or payments; require explicit approval and an isolated account."
336319
- },
336320
- {
336321
- "slug": "TIKTOK_ADS_UPDATE_ADGROUP_RF",
336322
- "name": "Update an R&F ad group",
336323
- "description": "Update an R&F ad group. Availability may depend on TikTok allowlisting or account entitlement."
336324
- },
336325
- {
336326
- "slug": "TIKTOK_ADS_UPDATE_ADGROUP_STATUS",
336327
- "name": "Update the statuses of ad groups",
336328
- "description": "Enable, disable, or permanently delete up to 20 ad groups. Enabling may resume ad delivery and spend; allow_partial_success can leave only some requested ad groups changed."
336329
- },
336330
- {
336331
- "slug": "TIKTOK_ADS_UPDATE_AD_STATUS",
336332
- "name": "Update the statuses of ads",
336333
- "description": "Enable, disable, or permanently delete regular or ACO ads. Enabling may resume ad delivery and spend."
336334
- },
335170
{
335171
"slug": "TIKTOK_ADS_UPDATE_ADVERTISER_ACCOUNT",
335172
"name": "Update Advertiser Account",
@@ -336342,101 +335177,16 @@
335177
"name": "Update Advertiser Budgets",
335178
"description": "Consequential financial action that updates, resets, increments, deducts, or sets minimum budgets for ad accounts in a Business Center. These changes can alter or reset spend controls and may be irreversible; verify the Business Center, ad accounts, operation, and amounts before execution."
335179
},
336345
- {
336346
- "slug": "TIKTOK_ADS_UPDATE_APP",
336347
- "name": "Update an app",
336348
- "description": "Update a mobile app configured for an advertiser."
336349
- },
336350
- {
336351
- "slug": "TIKTOK_ADS_UPDATE_BC_ASSET_GROUP",
336352
- "name": "Update an Asset Group",
336353
- "description": "Rename an Asset Group or add or remove its advertiser assets or members."
336354
- },
336355
- {
336356
- "slug": "TIKTOK_ADS_UPDATE_BC_BILLING_GROUP",
336357
- "name": "Update a Billing Group",
336358
- "description": "Update Billing Group membership, name, email recipients, or default status. Providing new_billing_group_emails replaces the entire existing list, removing accounts changes invoice grouping, and is_primary changes the default group. Obtain explicit approval immediately before execution and verify every changed value."
336359
- },
336360
- {
336361
- "slug": "TIKTOK_ADS_UPDATE_BC_MEMBER",
336362
- "name": "Update info of a BC member",
336363
- "description": "Update a Business Center member's name, basic role, or finance role."
336364
- },
336365
- {
336366
- "slug": "TIKTOK_ADS_UPDATE_BC_PIXEL_LINK",
336367
- "name": "Link or unlink a pixel and ad accounts",
336368
- "description": "Ensure the requested link or unlink relationship between a Business Center pixel and advertiser accounts."
336369
- },
336370
- {
336371
- "slug": "TIKTOK_ADS_UPDATE_BLOCKEDWORD",
336372
- "name": "Update a blocked word",
336373
- "description": "Replace one exact blocked word in an advertiser's moderation list. Confirm both old and new values before calling because the moderation behavior changes immediately."
336374
- },
336375
- {
336376
- "slug": "TIKTOK_ADS_UPDATE_CAMPAIGN",
336377
- "name": "Update a campaign",
336378
- "description": "Update the mutable fields of an existing campaign."
336379
- },
336380
- {
336381
- "slug": "TIKTOK_ADS_UPDATE_CAMPAIGN_STATUS",
336382
- "name": "Update the operation statuses of campaigns",
336383
- "description": "Enable, disable, or permanently delete campaigns. Enabling may resume ad delivery and spend; postback_window_mode is accepted only while disabling."
336384
- },
335180
{
335181
"slug": "TIKTOK_ADS_UPDATE_CATALOG",
335182
"name": "Update Catalog",
335183
"description": "Update the name of a catalog owned by a TikTok Business Center."
335184
},
336390
- {
336391
- "slug": "TIKTOK_ADS_UPDATE_CATALOG_FEED",
336392
- "name": "Update a feed",
336393
- "description": "Update a catalog feed or schedule. INCREMENTAL preserves products omitted from the next import; OVERWRITE permanently removes omitted products, so confirm the complete source file before using it."
336394
- },
335185
{
335186
"slug": "TIKTOK_ADS_UPDATE_CATALOG_FEED_SCHEDULE_STATUS",
335187
"name": "Update Catalog Feed Schedule Status",
335188
"description": "Set one catalog feed schedule to ON or OFF. Read the current status first because TikTok rejects an unchanged value; ON starts recurring ingestion."
335189
},
336400
- {
336401
- "slug": "TIKTOK_ADS_UPDATE_CATALOG_PRODUCT",
336402
- "name": "Update catalog products",
336403
- "description": "Update up to 5,000 products using the fields documented for each catalog type."
336404
- },
336405
- {
336406
- "slug": "TIKTOK_ADS_UPDATE_CATALOG_SET",
336407
- "name": "Update a product set",
336408
- "description": "Update a product set name, filter conditions, or both."
336409
- },
336410
- {
336411
- "slug": "TIKTOK_ADS_UPDATE_COMMENT_STATUS",
336412
- "name": "Update the statuses of comments",
336413
- "description": "Change the moderation visibility status of exact comments. Confirm the advertiser, every comment ID, and whether the operation hides or restores comments before calling; this affects public content."
336414
- },
336415
- {
336416
- "slug": "TIKTOK_ADS_UPDATE_CUSTOM_CONVERSION",
336417
- "name": "Update a Custom Conversion",
336418
- "description": "Update the name or description of a Custom Conversion configuration."
336419
- },
336420
- {
336421
- "slug": "TIKTOK_ADS_UPDATE_DMP_CUSTOM_AUDIENCE",
336422
- "name": "Update a Custom Audience",
336423
- "description": "Rename, refresh from files, enhance, or convert a custom audience subtype."
336424
- },
336425
- {
336426
- "slug": "TIKTOK_ADS_UPDATE_DMP_CUSTOM_AUDIENCE_LOOKALIKE",
336427
- "name": "Update Lookalike Audiences",
336428
- "description": "Update specified lookalike custom audiences."
336429
- },
336430
- {
336431
- "slug": "TIKTOK_ADS_UPDATE_FILE_IMAGE_AD",
336432
- "name": "Update the name of an image",
336433
- "description": "Update an advertiser image name."
336434
- },
336435
- {
336436
- "slug": "TIKTOK_ADS_UPDATE_FILE_VIDEO_AD",
336437
- "name": "Update the name of a video",
336438
- "description": "Update an advertiser video name."
336439
- },
335190
{
335191
"slug": "TIKTOK_ADS_UPDATE_GMV_MAX_CAMPAIGN",
335192
"name": "Update GMV Max Campaign",
@@ -336452,66 +335202,16 @@
335202
"name": "Update GMV Max Session",
335203
"description": "Update documented budget or schedule fields for a max delivery or creative boost session. schedule_start_time applies to max delivery sessions."
335204
},
336455
- {
336456
- "slug": "TIKTOK_ADS_UPDATE_OFFLINE",
336457
- "name": "Update an Offline Event Set",
336458
- "description": "Update an Offline Event Set configuration; this does not upload or ingest events."
336459
- },
336460
- {
336461
- "slug": "TIKTOK_ADS_UPDATE_OPTIMIZER_RULE",
336462
- "name": "Update rules",
336463
- "description": "Update automated optimizer rules."
336464
- },
336465
- {
336466
- "slug": "TIKTOK_ADS_UPDATE_OPTIMIZER_RULE_STATUSES",
336467
- "name": "Update the statuses of rules",
336468
- "description": "Turn automated optimizer rules on or off, or permanently delete them."
336469
- },
335205
{
335206
"slug": "TIKTOK_ADS_UPDATE_PANGLE_BLOCK_LIST",
335207
"name": "Update Pangle Block List",
335208
"description": "Update an advertiser's Pangle app block list by adding apps, removing apps, or clearing the existing list before adding replacements. Provide at least one non-empty app list or set clear_old_app to true."
335209
},
336475
- {
336476
- "slug": "TIKTOK_ADS_UPDATE_PAYMENT_PORTFOLIO_ADVERTISER",
336477
- "name": "Link ad accounts to a Payment Portfolio",
336478
- "description": "Link up to 20 ad accounts to an Advanced Payment Portfolio, changing which centrally managed funds those accounts can use. Obtain explicit finance-owner approval immediately before execution and verify the portfolio, every ad account, same-client eligibility, and administrator access; the whole call fails for one invalid ID."
336479
- },
336480
- {
336481
- "slug": "TIKTOK_ADS_UPDATE_PAYMENT_PORTFOLIO_CREDIT_LINE",
336482
- "name": "Allocate the credit line to Payment Portfolios",
336483
- "description": "Change the credit-line percentages allocated to up to 10 Payment Portfolios. This directly changes available advertising credit now and whenever the total credit line changes; obtain explicit finance-owner approval immediately before execution and verify every portfolio, used minimum, percentage, and the intended total allocation."
336484
- },
336485
- {
336486
- "slug": "TIKTOK_ADS_UPDATE_PIXEL",
336487
- "name": "Update a Pixel",
336488
- "description": "Update Pixel naming, matching, cookie, or expanded-data-sharing configuration."
336489
- },
336490
- {
336491
- "slug": "TIKTOK_ADS_UPDATE_PIXEL_EVENT",
336492
- "name": "Update a Pixel Event",
336493
- "description": "Update a Pixel Event configuration; this endpoint does not ingest event occurrences."
336494
- },
335210
{
335211
"slug": "TIKTOK_ADS_UPDATE_SEARCH_AD_NEGATIVE_KEYWORD",
335212
"name": "Update Search Ad Negative Keyword",
335213
"description": "Update the name or match type of one negative keyword attached to a Search Ads campaign or ad group."
335214
},
336500
- {
336501
- "slug": "TIKTOK_ADS_UPDATE_SEGMENT",
336502
- "name": "Add or delete audience segment mappings",
336503
- "description": "Add or delete user and device mappings for explicitly selected disposable audiences."
336504
- },
336505
- {
336506
- "slug": "TIKTOK_ADS_UPDATE_SMART_CREATIVE_MATERIALS",
336507
- "name": "Update Smart Creative Materials",
336508
- "description": "Update current Smart Creative materials outside Smart+ campaigns. With patch_update=true, omitted top-level fields remain unchanged, but every provided array replaces the entire prior array; first read and resend all existing array items to avoid data loss. Automatically generated ad names cannot be updated. This does not target retired DYNAMIC ACO."
336509
- },
336510
- {
336511
- "slug": "TIKTOK_ADS_UPDATE_SMART_CREATIVE_MATERIAL_STATUS",
336512
- "name": "Update Smart Creative Material Status",
336513
- "description": "Enable or disable current Smart Creative materials. Enabling a material can make it eligible for delivery and spend. This does not target retired DYNAMIC ACO."
336514
- },
335215
{
335216
"slug": "TIKTOK_ADS_UPDATE_SMART_PLUS_AD",
335217
"name": "Update Smart+ Ad",
@@ -336552,95 +335252,15 @@
335252
"name": "Update Smart+ Campaign Status",
335253
"description": "Explicitly delete, disable, or enable Smart+ campaigns. For safe mutation QA, use DISABLE on owned test campaigns; this action never chooses ENABLE or DELETE by default."
335254
},
336555
- {
336556
- "slug": "TIKTOK_ADS_UPDATE_SPLIT_TEST",
336557
- "name": "Update the time of a split test",
336558
- "description": "Update the start and end time of a split test."
336559
- },
336560
- {
336561
- "slug": "TIKTOK_ADS_UPDATE_TIKTOK_INVENTORY_FILTERS",
336562
- "name": "Set or update the Brand Safety Hub settings of an ad account",
336563
- "description": "Set or update an advertiser account's Brand Safety Hub settings."
336564
- },
336565
- {
336566
- "slug": "TIKTOK_ADS_UPLOAD_ACCOUNT_VERIFICATION",
336567
- "name": "Upload verification documents",
336568
- "description": "Upload one or two verification document images."
336569
- },
335255
{
335256
"slug": "TIKTOK_ADS_UPLOAD_BUSINESS_CERTIFICATE_IMAGE",
335257
"name": "Upload Business Certificate Image",
335258
"description": "Upload a business certificate image for an ad account through a Business Center where the connected user is an administrator."
335259
},
336575
- {
336576
- "slug": "TIKTOK_ADS_UPLOAD_CATALOG_PRODUCT",
336577
- "name": "Upload catalog products",
336578
- "description": "Upload up to 5,000 products using the fields documented for each catalog type."
336579
- },
336580
- {
336581
- "slug": "TIKTOK_ADS_UPLOAD_CATALOG_PRODUCTS_BY_FILE_URL",
336582
- "name": "Upload products via a file URL",
336583
- "description": "Ingest a CSV catalog feed from a directly accessible HTTP or HTTPS URL. INCREMENTAL preserves omitted products; OVERWRITE permanently removes omitted products, so confirm the complete source file before using it."
336584
- },
335260
{
335261
"slug": "TIKTOK_ADS_UPLOAD_CATALOG_VIDEOS_BY_FILE_URL",
335262
"name": "Upload Catalog Videos by File URL",
335263
"description": "Upload catalog videos from a file URL."
336589
- },
336590
- {
336591
- "slug": "TIKTOK_ADS_UPLOAD_DMP_CUSTOM_AUDIENCE_FILE",
336592
- "name": "Upload an Audience File",
336593
- "description": "Upload a CSV or TXT customer file after verifying its supplied MD5 signature."
336594
- },
336595
- {
336596
- "slug": "TIKTOK_ADS_UPLOAD_FILE_FINISH",
336597
- "name": "Finish a chunk upload task",
336598
- "description": "Finish a previously started file chunk upload task."
336599
- },
336600
- {
336601
- "slug": "TIKTOK_ADS_UPLOAD_FILE_IMAGE_AD",
336602
- "name": "Upload an image",
336603
- "description": "Upload an advertiser image by local file, URL, or temporary file ID."
336604
- },
336605
- {
336606
- "slug": "TIKTOK_ADS_UPLOAD_FILE_MUSIC",
336607
- "name": "Upload a piece of music",
336608
- "description": "Upload advertiser music or update a Carousel Ads music list."
336609
- },
336610
- {
336611
- "slug": "TIKTOK_ADS_UPLOAD_FILE_START",
336612
- "name": "Start a file chunk upload task",
336613
- "description": "Start a chunked image, video, or music upload task."
336614
- },
336615
- {
336616
- "slug": "TIKTOK_ADS_UPLOAD_FILE_TEMPORARILY",
336617
- "name": "Upload a file",
336618
- "description": "Upload a temporary image, music, video, or playable file by file or URL."
336619
- },
336620
- {
336621
- "slug": "TIKTOK_ADS_UPLOAD_FILE_TRANSFER",
336622
- "name": "Transfer a file chunk",
336623
- "description": "Transfer one verified chunk for a previously started upload task."
336624
- },
336625
- {
336626
- "slug": "TIKTOK_ADS_UPLOAD_FILE_VIDEO_AD",
336627
- "name": "Upload a video",
336628
- "description": "Upload an advertiser video by local file, URL, temporary file ID, or existing video ID."
336629
- },
336630
- {
336631
- "slug": "TIKTOK_ADS_UPLOAD_PLAYABLE",
336632
- "name": "Upload a playable asset",
336633
- "description": "Upload a playable ZIP package or reference a file already in TikTok's file repository. Direct packages must be 5 MB or smaller, contain index.html and config.json at the root, and must not load external network resources."
336634
- },
336635
- {
336636
- "slug": "TIKTOK_ADS_VALIDATE_LANDING_PAGE_URL",
336637
- "name": "Validate a URL",
336638
- "description": "Get TikTok verification results for a URL."
336639
- },
336640
- {
336641
- "slug": "TIKTOK_ADS_VALIDATE_PLAYABLE",
336642
- "name": "Check the status of a playable asset",
336643
- "description": "Check validation status and failure details for one playable asset."
335264
}
335265
],
335266
"triggers": [],
docs/public/openapi-v3.json
+527
-1
@@ -1918,7 +1918,7 @@
1918
"nullable": true
1919
},
1920
"required": false,
1921
- "description": "Number of items per page, max allowed is 50",
1921
+ "description": "Number of items per page, max allowed is 200",
1922
"name": "limit",
1923
"in": "query"
1924
},
@@ -16763,6 +16763,122 @@
16763
"github": "ca_3m4n5o6p7q8r"
16764
}
16765
},
16766
+ "premium_usage": {
16767
+ "anyOf": [
16768
+ {
16769
+ "type": "boolean",
16770
+ "enum": [
16771
+ false
16772
+ ]
16773
+ },
16774
+ {
16775
+ "type": "object",
16776
+ "properties": {
16777
+ "toolkits": {
16778
+ "anyOf": [
16779
+ {
16780
+ "type": "object",
16781
+ "properties": {
16782
+ "enable": {
16783
+ "type": "array",
16784
+ "items": {
16785
+ "type": "string"
16786
+ },
16787
+ "description": "Only these specific toolkits will be enabled",
16788
+ "example": [
16789
+ "gmail",
16790
+ "slack",
16791
+ "github"
16792
+ ]
16793
+ }
16794
+ },
16795
+ "required": [
16796
+ "enable"
16797
+ ],
16798
+ "additionalProperties": false,
16799
+ "description": "Enable only specific toolkits (allowlist)"
16800
+ },
16801
+ {
16802
+ "type": "object",
16803
+ "properties": {
16804
+ "disable": {
16805
+ "type": "array",
16806
+ "items": {
16807
+ "type": "string"
16808
+ },
16809
+ "description": "These specific toolkits will be disabled",
16810
+ "example": [
16811
+ "gmail",
16812
+ "slack"
16813
+ ]
16814
+ }
16815
+ },
16816
+ "required": [
16817
+ "disable"
16818
+ ],
16819
+ "additionalProperties": false,
16820
+ "description": "Disable specific toolkits (denylist)"
16821
+ }
16822
+ ],
16823
+ "description": "Toolkit configuration - specify either enable toolkits (allowlist) or disable toolkits (denylist). Mutually exclusive."
16824
+ },
16825
+ "tools": {
16826
+ "type": "object",
16827
+ "additionalProperties": {
16828
+ "anyOf": [
16829
+ {
16830
+ "type": "object",
16831
+ "properties": {
16832
+ "enable": {
16833
+ "type": "array",
16834
+ "items": {
16835
+ "type": "string"
16836
+ },
16837
+ "description": "Only these specific tools will be available for this toolkit",
16838
+ "example": [
16839
+ "GMAIL_SEND_EMAIL",
16840
+ "GMAIL_FETCH_EMAILS"
16841
+ ]
16842
+ }
16843
+ },
16844
+ "required": [
16845
+ "enable"
16846
+ ],
16847
+ "additionalProperties": false
16848
+ },
16849
+ {
16850
+ "type": "object",
16851
+ "properties": {
16852
+ "disable": {
16853
+ "type": "array",
16854
+ "items": {
16855
+ "type": "string"
16856
+ },
16857
+ "description": "These specific tools will be disabled for this toolkit",
16858
+ "example": [
16859
+ "SLACK_ADD_EMOJI"
16860
+ ]
16861
+ }
16862
+ },
16863
+ "required": [
16864
+ "disable"
16865
+ ],
16866
+ "additionalProperties": false
16867
+ }
16868
+ ]
16869
+ },
16870
+ "description": "Per-toolkit enable or disable lists that restrict premium usage. Toolkits absent from the map have no additional tool restriction. On PATCH, a supplied map replaces all existing tool filters; an empty map clears them, and omission preserves them."
16871
+ },
16872
+ "return_premium_charge": {
16873
+ "type": "boolean",
16874
+ "description": "Return the top-level premium_charge in session tool responses when a charge is available. Defaults to false on create; omission on PATCH preserves the current value. Controls response visibility only; it does not enable or disable premium usage."
16875
+ }
16876
+ },
16877
+ "additionalProperties": false
16878
+ }
16879
+ ],
16880
+ "description": "Controls premium usage, subject to project permission and session toolkit and tool restrictions. False disables premium usage. Omission on create or an empty object enables it with charges hidden. On PATCH, omitted fields are preserved; an object re-enables a disabled setting."
16881
+ },
16882
"manage_connections": {
16883
"type": "object",
16884
"properties": {
@@ -17628,6 +17744,103 @@
17744
},
17745
"description": "Full per-toolkit connected account overrides as arrays. Populated whenever `connected_accounts` is non-empty; carries the complete list when multi-account is enabled."
17746
},
17747
+ "premium_usage": {
17748
+ "anyOf": [
17749
+ {
17750
+ "type": "boolean",
17751
+ "enum": [
17752
+ false
17753
+ ]
17754
+ },
17755
+ {
17756
+ "type": "object",
17757
+ "properties": {
17758
+ "toolkits": {
17759
+ "anyOf": [
17760
+ {
17761
+ "type": "object",
17762
+ "properties": {
17763
+ "enabled": {
17764
+ "type": "array",
17765
+ "items": {
17766
+ "type": "string"
17767
+ }
17768
+ }
17769
+ },
17770
+ "required": [
17771
+ "enabled"
17772
+ ],
17773
+ "additionalProperties": false
17774
+ },
17775
+ {
17776
+ "type": "object",
17777
+ "properties": {
17778
+ "disabled": {
17779
+ "type": "array",
17780
+ "items": {
17781
+ "type": "string"
17782
+ }
17783
+ }
17784
+ },
17785
+ "required": [
17786
+ "disabled"
17787
+ ],
17788
+ "additionalProperties": false
17789
+ }
17790
+ ],
17791
+ "description": "Toolkits eligible for premium usage, as an enabled or disabled list. If absent, no additional toolkit restriction applies."
17792
+ },
17793
+ "tools": {
17794
+ "type": "object",
17795
+ "additionalProperties": {
17796
+ "anyOf": [
17797
+ {
17798
+ "type": "object",
17799
+ "properties": {
17800
+ "enabled": {
17801
+ "type": "array",
17802
+ "items": {
17803
+ "type": "string"
17804
+ }
17805
+ }
17806
+ },
17807
+ "required": [
17808
+ "enabled"
17809
+ ],
17810
+ "additionalProperties": false
17811
+ },
17812
+ {
17813
+ "type": "object",
17814
+ "properties": {
17815
+ "disabled": {
17816
+ "type": "array",
17817
+ "items": {
17818
+ "type": "string"
17819
+ }
17820
+ }
17821
+ },
17822
+ "required": [
17823
+ "disabled"
17824
+ ],
17825
+ "additionalProperties": false
17826
+ }
17827
+ ]
17828
+ },
17829
+ "description": "Per-toolkit enabled or disabled lists that restrict premium usage. Toolkits absent from this map have no additional tool restriction."
17830
+ },
17831
+ "return_premium_charge": {
17832
+ "type": "boolean",
17833
+ "description": "Whether session tool responses return a top-level premium_charge when a charge is available. Defaults to false; controls response visibility only."
17834
+ }
17835
+ },
17836
+ "required": [
17837
+ "return_premium_charge"
17838
+ ],
17839
+ "additionalProperties": false
17840
+ }
17841
+ ],
17842
+ "description": "Premium usage settings. False disables premium usage; an object permits it subject to project permission and session toolkit and tool restrictions."
17843
+ },
17844
"manage_connections": {
17845
"type": "object",
17846
"properties": {
@@ -17840,6 +18053,7 @@
18053
},
18054
"required": [
18055
"user_id",
18056
+ "premium_usage",
18057
"preload"
18058
],
18059
"description": "The session configuration including user, toolkits, and overrides"
@@ -18651,6 +18865,103 @@
18865
},
18866
"description": "Full per-toolkit connected account overrides as arrays. Populated whenever `connected_accounts` is non-empty; carries the complete list when multi-account is enabled."
18867
},
18868
+ "premium_usage": {
18869
+ "anyOf": [
18870
+ {
18871
+ "type": "boolean",
18872
+ "enum": [
18873
+ false
18874
+ ]
18875
+ },
18876
+ {
18877
+ "type": "object",
18878
+ "properties": {
18879
+ "toolkits": {
18880
+ "anyOf": [
18881
+ {
18882
+ "type": "object",
18883
+ "properties": {
18884
+ "enabled": {
18885
+ "type": "array",
18886
+ "items": {
18887
+ "type": "string"
18888
+ }
18889
+ }
18890
+ },
18891
+ "required": [
18892
+ "enabled"
18893
+ ],
18894
+ "additionalProperties": false
18895
+ },
18896
+ {
18897
+ "type": "object",
18898
+ "properties": {
18899
+ "disabled": {
18900
+ "type": "array",
18901
+ "items": {
18902
+ "type": "string"
18903
+ }
18904
+ }
18905
+ },
18906
+ "required": [
18907
+ "disabled"
18908
+ ],
18909
+ "additionalProperties": false
18910
+ }
18911
+ ],
18912
+ "description": "Toolkits eligible for premium usage, as an enabled or disabled list. If absent, no additional toolkit restriction applies."
18913
+ },
18914
+ "tools": {
18915
+ "type": "object",
18916
+ "additionalProperties": {
18917
+ "anyOf": [
18918
+ {
18919
+ "type": "object",
18920
+ "properties": {
18921
+ "enabled": {
18922
+ "type": "array",
18923
+ "items": {
18924
+ "type": "string"
18925
+ }
18926
+ }
18927
+ },
18928
+ "required": [
18929
+ "enabled"
18930
+ ],
18931
+ "additionalProperties": false
18932
+ },
18933
+ {
18934
+ "type": "object",
18935
+ "properties": {
18936
+ "disabled": {
18937
+ "type": "array",
18938
+ "items": {
18939
+ "type": "string"
18940
+ }
18941
+ }
18942
+ },
18943
+ "required": [
18944
+ "disabled"
18945
+ ],
18946
+ "additionalProperties": false
18947
+ }
18948
+ ]
18949
+ },
18950
+ "description": "Per-toolkit enabled or disabled lists that restrict premium usage. Toolkits absent from this map have no additional tool restriction."
18951
+ },
18952
+ "return_premium_charge": {
18953
+ "type": "boolean",
18954
+ "description": "Whether session tool responses return a top-level premium_charge when a charge is available. Defaults to false; controls response visibility only."
18955
+ }
18956
+ },
18957
+ "required": [
18958
+ "return_premium_charge"
18959
+ ],
18960
+ "additionalProperties": false
18961
+ }
18962
+ ],
18963
+ "description": "Premium usage settings. False disables premium usage; an object permits it subject to project permission and session toolkit and tool restrictions."
18964
+ },
18965
"manage_connections": {
18966
"type": "object",
18967
"properties": {
@@ -18863,6 +19174,7 @@
19174
},
19175
"required": [
19176
"user_id",
19177
+ "premium_usage",
19178
"preload"
19179
],
19180
"description": "The session configuration including user, toolkits, and overrides"
@@ -19202,6 +19514,122 @@
19514
"github": "ca_3m4n5o6p7q8r"
19515
}
19516
},
19517
+ "premium_usage": {
19518
+ "anyOf": [
19519
+ {
19520
+ "type": "boolean",
19521
+ "enum": [
19522
+ false
19523
+ ]
19524
+ },
19525
+ {
19526
+ "type": "object",
19527
+ "properties": {
19528
+ "toolkits": {
19529
+ "anyOf": [
19530
+ {
19531
+ "type": "object",
19532
+ "properties": {
19533
+ "enable": {
19534
+ "type": "array",
19535
+ "items": {
19536
+ "type": "string"
19537
+ },
19538
+ "description": "Only these specific toolkits will be enabled",
19539
+ "example": [
19540
+ "gmail",
19541
+ "slack",
19542
+ "github"
19543
+ ]
19544
+ }
19545
+ },
19546
+ "required": [
19547
+ "enable"
19548
+ ],
19549
+ "additionalProperties": false,
19550
+ "description": "Enable only specific toolkits (allowlist)"
19551
+ },
19552
+ {
19553
+ "type": "object",
19554
+ "properties": {
19555
+ "disable": {
19556
+ "type": "array",
19557
+ "items": {
19558
+ "type": "string"
19559
+ },
19560
+ "description": "These specific toolkits will be disabled",
19561
+ "example": [
19562
+ "gmail",
19563
+ "slack"
19564
+ ]
19565
+ }
19566
+ },
19567
+ "required": [
19568
+ "disable"
19569
+ ],
19570
+ "additionalProperties": false,
19571
+ "description": "Disable specific toolkits (denylist)"
19572
+ }
19573
+ ],
19574
+ "description": "Toolkit configuration - specify either enable toolkits (allowlist) or disable toolkits (denylist). Mutually exclusive."
19575
+ },
19576
+ "tools": {
19577
+ "type": "object",
19578
+ "additionalProperties": {
19579
+ "anyOf": [
19580
+ {
19581
+ "type": "object",
19582
+ "properties": {
19583
+ "enable": {
19584
+ "type": "array",
19585
+ "items": {
19586
+ "type": "string"
19587
+ },
19588
+ "description": "Only these specific tools will be available for this toolkit",
19589
+ "example": [
19590
+ "GMAIL_SEND_EMAIL",
19591
+ "GMAIL_FETCH_EMAILS"
19592
+ ]
19593
+ }
19594
+ },
19595
+ "required": [
19596
+ "enable"
19597
+ ],
19598
+ "additionalProperties": false
19599
+ },
19600
+ {
19601
+ "type": "object",
19602
+ "properties": {
19603
+ "disable": {
19604
+ "type": "array",
19605
+ "items": {
19606
+ "type": "string"
19607
+ },
19608
+ "description": "These specific tools will be disabled for this toolkit",
19609
+ "example": [
19610
+ "SLACK_ADD_EMOJI"
19611
+ ]
19612
+ }
19613
+ },
19614
+ "required": [
19615
+ "disable"
19616
+ ],
19617
+ "additionalProperties": false
19618
+ }
19619
+ ]
19620
+ },
19621
+ "description": "Per-toolkit enable or disable lists that restrict premium usage. Toolkits absent from the map have no additional tool restriction. On PATCH, a supplied map replaces all existing tool filters; an empty map clears them, and omission preserves them."
19622
+ },
19623
+ "return_premium_charge": {
19624
+ "type": "boolean",
19625
+ "description": "Return the top-level premium_charge in session tool responses when a charge is available. Defaults to false on create; omission on PATCH preserves the current value. Controls response visibility only; it does not enable or disable premium usage."
19626
+ }
19627
+ },
19628
+ "additionalProperties": false
19629
+ }
19630
+ ],
19631
+ "description": "Controls premium usage, subject to project permission and session toolkit and tool restrictions. False disables premium usage. Omission on create or an empty object enables it with charges hidden. On PATCH, omitted fields are preserved; an object re-enables a disabled setting."
19632
+ },
19633
"manage_connections": {
19634
"type": "object",
19635
"nullable": true,
@@ -19684,6 +20112,103 @@
20112
},
20113
"description": "Full per-toolkit connected account overrides as arrays. Populated whenever `connected_accounts` is non-empty; carries the complete list when multi-account is enabled."
20114
},
20115
+ "premium_usage": {
20116
+ "anyOf": [
20117
+ {
20118
+ "type": "boolean",
20119
+ "enum": [
20120
+ false
20121
+ ]
20122
+ },
20123
+ {
20124
+ "type": "object",
20125
+ "properties": {
20126
+ "toolkits": {
20127
+ "anyOf": [
20128
+ {
20129
+ "type": "object",
20130
+ "properties": {
20131
+ "enabled": {
20132
+ "type": "array",
20133
+ "items": {
20134
+ "type": "string"
20135
+ }
20136
+ }
20137
+ },
20138
+ "required": [
20139
+ "enabled"
20140
+ ],
20141
+ "additionalProperties": false
20142
+ },
20143
+ {
20144
+ "type": "object",
20145
+ "properties": {
20146
+ "disabled": {
20147
+ "type": "array",
20148
+ "items": {
20149
+ "type": "string"
20150
+ }
20151
+ }
20152
+ },
20153
+ "required": [
20154
+ "disabled"
20155
+ ],
20156
+ "additionalProperties": false
20157
+ }
20158
+ ],
20159
+ "description": "Toolkits eligible for premium usage, as an enabled or disabled list. If absent, no additional toolkit restriction applies."
20160
+ },
20161
+ "tools": {
20162
+ "type": "object",
20163
+ "additionalProperties": {
20164
+ "anyOf": [
20165
+ {
20166
+ "type": "object",
20167
+ "properties": {
20168
+ "enabled": {
20169
+ "type": "array",
20170
+ "items": {
20171
+ "type": "string"
20172
+ }
20173
+ }
20174
+ },
20175
+ "required": [
20176
+ "enabled"
20177
+ ],
20178
+ "additionalProperties": false
20179
+ },
20180
+ {
20181
+ "type": "object",
20182
+ "properties": {
20183
+ "disabled": {
20184
+ "type": "array",
20185
+ "items": {
20186
+ "type": "string"
20187
+ }
20188
+ }
20189
+ },
20190
+ "required": [
20191
+ "disabled"
20192
+ ],
20193
+ "additionalProperties": false
20194
+ }
20195
+ ]
20196
+ },
20197
+ "description": "Per-toolkit enabled or disabled lists that restrict premium usage. Toolkits absent from this map have no additional tool restriction."
20198
+ },
20199
+ "return_premium_charge": {
20200
+ "type": "boolean",
20201
+ "description": "Whether session tool responses return a top-level premium_charge when a charge is available. Defaults to false; controls response visibility only."
20202
+ }
20203
+ },
20204
+ "required": [
20205
+ "return_premium_charge"
20206
+ ],
20207
+ "additionalProperties": false
20208
+ }
20209
+ ],
20210
+ "description": "Premium usage settings. False disables premium usage; an object permits it subject to project permission and session toolkit and tool restrictions."
20211
+ },
20212
"manage_connections": {
20213
"type": "object",
20214
"properties": {
@@ -19896,6 +20421,7 @@
20421
},
20422
"required": [
20423
"user_id",
20424
+ "premium_usage",
20425
"preload"
20426
],
20427
"description": "The session configuration including user, toolkits, and overrides"
docs/public/openapi.json
+723
-1
@@ -600,6 +600,103 @@
600
},
601
"description": "Auth config overrides per toolkit"
602
},
603
+ "premium_usage": {
604
+ "anyOf": [
605
+ {
606
+ "type": "boolean",
607
+ "enum": [
608
+ false
609
+ ]
610
+ },
611
+ {
612
+ "type": "object",
613
+ "properties": {
614
+ "toolkits": {
615
+ "anyOf": [
616
+ {
617
+ "type": "object",
618
+ "properties": {
619
+ "enabled": {
620
+ "type": "array",
621
+ "items": {
622
+ "type": "string"
623
+ }
624
+ }
625
+ },
626
+ "required": [
627
+ "enabled"
628
+ ],
629
+ "additionalProperties": false
630
+ },
631
+ {
632
+ "type": "object",
633
+ "properties": {
634
+ "disabled": {
635
+ "type": "array",
636
+ "items": {
637
+ "type": "string"
638
+ }
639
+ }
640
+ },
641
+ "required": [
642
+ "disabled"
643
+ ],
644
+ "additionalProperties": false
645
+ }
646
+ ],
647
+ "description": "Toolkits eligible for premium usage, as an enabled or disabled list. If absent, no additional toolkit restriction applies."
648
+ },
649
+ "tools": {
650
+ "type": "object",
651
+ "additionalProperties": {
652
+ "anyOf": [
653
+ {
654
+ "type": "object",
655
+ "properties": {
656
+ "enabled": {
657
+ "type": "array",
658
+ "items": {
659
+ "type": "string"
660
+ }
661
+ }
662
+ },
663
+ "required": [
664
+ "enabled"
665
+ ],
666
+ "additionalProperties": false
667
+ },
668
+ {
669
+ "type": "object",
670
+ "properties": {
671
+ "disabled": {
672
+ "type": "array",
673
+ "items": {
674
+ "type": "string"
675
+ }
676
+ }
677
+ },
678
+ "required": [
679
+ "disabled"
680
+ ],
681
+ "additionalProperties": false
682
+ }
683
+ ]
684
+ },
685
+ "description": "Per-toolkit enabled or disabled lists that restrict premium usage. Toolkits absent from this map have no additional tool restriction."
686
+ },
687
+ "return_premium_charge": {
688
+ "type": "boolean",
689
+ "description": "Whether session tool responses return a top-level premium_charge when a charge is available. Defaults to false; controls response visibility only."
690
+ }
691
+ },
692
+ "required": [
693
+ "return_premium_charge"
694
+ ],
695
+ "additionalProperties": false
696
+ }
697
+ ],
698
+ "description": "Premium usage settings. False disables premium usage; an object permits it subject to project permission and session toolkit and tool restrictions."
699
+ },
700
"manage_connections": {
701
"type": "object",
702
"properties": {
@@ -854,6 +951,7 @@
951
},
952
"required": [
953
"user_id",
954
+ "premium_usage",
955
"preload",
956
"search",
957
"execute"
@@ -5820,6 +5918,122 @@
5918
},
5919
"description": "The connected accounts to use for the session, as an array of nano-IDs per toolkit. This overrides the default behaviour and pins specific connected accounts when toolkits are executed. Each account must exist (not deleted or disabled) and belong to the same `user_id` as the session. Multi-account sessions can pin multiple; non-multi-account sessions are capped at length 1."
5920
},
5921
+ "premium_usage": {
5922
+ "anyOf": [
5923
+ {
5924
+ "type": "boolean",
5925
+ "enum": [
5926
+ false
5927
+ ]
5928
+ },
5929
+ {
5930
+ "type": "object",
5931
+ "properties": {
5932
+ "toolkits": {
5933
+ "anyOf": [
5934
+ {
5935
+ "type": "object",
5936
+ "properties": {
5937
+ "enable": {
5938
+ "type": "array",
5939
+ "items": {
5940
+ "type": "string"
5941
+ },
5942
+ "description": "Only these specific toolkits will be enabled",
5943
+ "example": [
5944
+ "gmail",
5945
+ "slack",
5946
+ "github"
5947
+ ]
5948
+ }
5949
+ },
5950
+ "required": [
5951
+ "enable"
5952
+ ],
5953
+ "additionalProperties": false,
5954
+ "description": "Enable only specific toolkits (allowlist)"
5955
+ },
5956
+ {
5957
+ "type": "object",
5958
+ "properties": {
5959
+ "disable": {
5960
+ "type": "array",
5961
+ "items": {
5962
+ "type": "string"
5963
+ },
5964
+ "description": "These specific toolkits will be disabled",
5965
+ "example": [
5966
+ "gmail",
5967
+ "slack"
5968
+ ]
5969
+ }
5970
+ },
5971
+ "required": [
5972
+ "disable"
5973
+ ],
5974
+ "additionalProperties": false,
5975
+ "description": "Disable specific toolkits (denylist)"
5976
+ }
5977
+ ],
5978
+ "description": "Toolkit configuration - specify either enable toolkits (allowlist) or disable toolkits (denylist). Mutually exclusive."
5979
+ },
5980
+ "tools": {
5981
+ "type": "object",
5982
+ "additionalProperties": {
5983
+ "anyOf": [
5984
+ {
5985
+ "type": "object",
5986
+ "properties": {
5987
+ "enable": {
5988
+ "type": "array",
5989
+ "items": {
5990
+ "type": "string"
5991
+ },
5992
+ "description": "Only these specific tools will be available for this toolkit",
5993
+ "example": [
5994
+ "GMAIL_SEND_EMAIL",
5995
+ "GMAIL_FETCH_EMAILS"
5996
+ ]
5997
+ }
5998
+ },
5999
+ "required": [
6000
+ "enable"
6001
+ ],
6002
+ "additionalProperties": false
6003
+ },
6004
+ {
6005
+ "type": "object",
6006
+ "properties": {
6007
+ "disable": {
6008
+ "type": "array",
6009
+ "items": {
6010
+ "type": "string"
6011
+ },
6012
+ "description": "These specific tools will be disabled for this toolkit",
6013
+ "example": [
6014
+ "SLACK_ADD_EMOJI"
6015
+ ]
6016
+ }
6017
+ },
6018
+ "required": [
6019
+ "disable"
6020
+ ],
6021
+ "additionalProperties": false
6022
+ }
6023
+ ]
6024
+ },
6025
+ "description": "Per-toolkit enable or disable lists that restrict premium usage. Toolkits absent from the map have no additional tool restriction. On PATCH, a supplied map replaces all existing tool filters; an empty map clears them, and omission preserves them."
6026
+ },
6027
+ "return_premium_charge": {
6028
+ "type": "boolean",
6029
+ "description": "Return the top-level premium_charge in session tool responses when a charge is available. Defaults to false on create; omission on PATCH preserves the current value. Controls response visibility only; it does not enable or disable premium usage."
6030
+ }
6031
+ },
6032
+ "additionalProperties": false
6033
+ }
6034
+ ],
6035
+ "description": "Controls premium usage, subject to project permission and session toolkit and tool restrictions. False disables premium usage. Omission on create or an empty object enables it with charges hidden. On PATCH, omitted fields are preserved; an object re-enables a disabled setting."
6036
+ },
6037
"manage_connections": {
6038
"type": "object",
6039
"properties": {
@@ -6700,6 +6914,103 @@
6914
},
6915
"description": "Auth config overrides per toolkit"
6916
},
6917
+ "premium_usage": {
6918
+ "anyOf": [
6919
+ {
6920
+ "type": "boolean",
6921
+ "enum": [
6922
+ false
6923
+ ]
6924
+ },
6925
+ {
6926
+ "type": "object",
6927
+ "properties": {
6928
+ "toolkits": {
6929
+ "anyOf": [
6930
+ {
6931
+ "type": "object",
6932
+ "properties": {
6933
+ "enabled": {
6934
+ "type": "array",
6935
+ "items": {
6936
+ "type": "string"
6937
+ }
6938
+ }
6939
+ },
6940
+ "required": [
6941
+ "enabled"
6942
+ ],
6943
+ "additionalProperties": false
6944
+ },
6945
+ {
6946
+ "type": "object",
6947
+ "properties": {
6948
+ "disabled": {
6949
+ "type": "array",
6950
+ "items": {
6951
+ "type": "string"
6952
+ }
6953
+ }
6954
+ },
6955
+ "required": [
6956
+ "disabled"
6957
+ ],
6958
+ "additionalProperties": false
6959
+ }
6960
+ ],
6961
+ "description": "Toolkits eligible for premium usage, as an enabled or disabled list. If absent, no additional toolkit restriction applies."
6962
+ },
6963
+ "tools": {
6964
+ "type": "object",
6965
+ "additionalProperties": {
6966
+ "anyOf": [
6967
+ {
6968
+ "type": "object",
6969
+ "properties": {
6970
+ "enabled": {
6971
+ "type": "array",
6972
+ "items": {
6973
+ "type": "string"
6974
+ }
6975
+ }
6976
+ },
6977
+ "required": [
6978
+ "enabled"
6979
+ ],
6980
+ "additionalProperties": false
6981
+ },
6982
+ {
6983
+ "type": "object",
6984
+ "properties": {
6985
+ "disabled": {
6986
+ "type": "array",
6987
+ "items": {
6988
+ "type": "string"
6989
+ }
6990
+ }
6991
+ },
6992
+ "required": [
6993
+ "disabled"
6994
+ ],
6995
+ "additionalProperties": false
6996
+ }
6997
+ ]
6998
+ },
6999
+ "description": "Per-toolkit enabled or disabled lists that restrict premium usage. Toolkits absent from this map have no additional tool restriction."
7000
+ },
7001
+ "return_premium_charge": {
7002
+ "type": "boolean",
7003
+ "description": "Whether session tool responses return a top-level premium_charge when a charge is available. Defaults to false; controls response visibility only."
7004
+ }
7005
+ },
7006
+ "required": [
7007
+ "return_premium_charge"
7008
+ ],
7009
+ "additionalProperties": false
7010
+ }
7011
+ ],
7012
+ "description": "Premium usage settings. False disables premium usage; an object permits it subject to project permission and session toolkit and tool restrictions."
7013
+ },
7014
"manage_connections": {
7015
"type": "object",
7016
"properties": {
@@ -6954,6 +7265,7 @@
7265
},
7266
"required": [
7267
"user_id",
7268
+ "premium_usage",
7269
"preload",
7270
"search",
7271
"execute"
@@ -7357,6 +7669,103 @@
7669
},
7670
"description": "Auth config overrides per toolkit"
7671
},
7672
+ "premium_usage": {
7673
+ "anyOf": [
7674
+ {
7675
+ "type": "boolean",
7676
+ "enum": [
7677
+ false
7678
+ ]
7679
+ },
7680
+ {
7681
+ "type": "object",
7682
+ "properties": {
7683
+ "toolkits": {
7684
+ "anyOf": [
7685
+ {
7686
+ "type": "object",
7687
+ "properties": {
7688
+ "enabled": {
7689
+ "type": "array",
7690
+ "items": {
7691
+ "type": "string"
7692
+ }
7693
+ }
7694
+ },
7695
+ "required": [
7696
+ "enabled"
7697
+ ],
7698
+ "additionalProperties": false
7699
+ },
7700
+ {
7701
+ "type": "object",
7702
+ "properties": {
7703
+ "disabled": {
7704
+ "type": "array",
7705
+ "items": {
7706
+ "type": "string"
7707
+ }
7708
+ }
7709
+ },
7710
+ "required": [
7711
+ "disabled"
7712
+ ],
7713
+ "additionalProperties": false
7714
+ }
7715
+ ],
7716
+ "description": "Toolkits eligible for premium usage, as an enabled or disabled list. If absent, no additional toolkit restriction applies."
7717
+ },
7718
+ "tools": {
7719
+ "type": "object",
7720
+ "additionalProperties": {
7721
+ "anyOf": [
7722
+ {
7723
+ "type": "object",
7724
+ "properties": {
7725
+ "enabled": {
7726
+ "type": "array",
7727
+ "items": {
7728
+ "type": "string"
7729
+ }
7730
+ }
7731
+ },
7732
+ "required": [
7733
+ "enabled"
7734
+ ],
7735
+ "additionalProperties": false
7736
+ },
7737
+ {
7738
+ "type": "object",
7739
+ "properties": {
7740
+ "disabled": {
7741
+ "type": "array",
7742
+ "items": {
7743
+ "type": "string"
7744
+ }
7745
+ }
7746
+ },
7747
+ "required": [
7748
+ "disabled"
7749
+ ],
7750
+ "additionalProperties": false
7751
+ }
7752
+ ]
7753
+ },
7754
+ "description": "Per-toolkit enabled or disabled lists that restrict premium usage. Toolkits absent from this map have no additional tool restriction."
7755
+ },
7756
+ "return_premium_charge": {
7757
+ "type": "boolean",
7758
+ "description": "Whether session tool responses return a top-level premium_charge when a charge is available. Defaults to false; controls response visibility only."
7759
+ }
7760
+ },
7761
+ "required": [
7762
+ "return_premium_charge"
7763
+ ],
7764
+ "additionalProperties": false
7765
+ }
7766
+ ],
7767
+ "description": "Premium usage settings. False disables premium usage; an object permits it subject to project permission and session toolkit and tool restrictions."
7768
+ },
7769
"manage_connections": {
7770
"type": "object",
7771
"properties": {
@@ -7611,6 +8020,7 @@
8020
},
8021
"required": [
8022
"user_id",
8023
+ "premium_usage",
8024
"preload",
8025
"search",
8026
"execute"
@@ -7968,6 +8378,122 @@
8378
},
8379
"description": "The connected accounts to use for the session, as an array of nano-IDs per toolkit. This overrides the default behaviour and pins specific connected accounts when toolkits are executed. Each account must exist (not deleted or disabled) and belong to the same `user_id` as the session. Multi-account sessions can pin multiple; non-multi-account sessions are capped at length 1."
8380
},
8381
+ "premium_usage": {
8382
+ "anyOf": [
8383
+ {
8384
+ "type": "boolean",
8385
+ "enum": [
8386
+ false
8387
+ ]
8388
+ },
8389
+ {
8390
+ "type": "object",
8391
+ "properties": {
8392
+ "toolkits": {
8393
+ "anyOf": [
8394
+ {
8395
+ "type": "object",
8396
+ "properties": {
8397
+ "enable": {
8398
+ "type": "array",
8399
+ "items": {
8400
+ "type": "string"
8401
+ },
8402
+ "description": "Only these specific toolkits will be enabled",
8403
+ "example": [
8404
+ "gmail",
8405
+ "slack",
8406
+ "github"
8407
+ ]
8408
+ }
8409
+ },
8410
+ "required": [
8411
+ "enable"
8412
+ ],
8413
+ "additionalProperties": false,
8414
+ "description": "Enable only specific toolkits (allowlist)"
8415
+ },
8416
+ {
8417
+ "type": "object",
8418
+ "properties": {
8419
+ "disable": {
8420
+ "type": "array",
8421
+ "items": {
8422
+ "type": "string"
8423
+ },
8424
+ "description": "These specific toolkits will be disabled",
8425
+ "example": [
8426
+ "gmail",
8427
+ "slack"
8428
+ ]
8429
+ }
8430
+ },
8431
+ "required": [
8432
+ "disable"
8433
+ ],
8434
+ "additionalProperties": false,
8435
+ "description": "Disable specific toolkits (denylist)"
8436
+ }
8437
+ ],
8438
+ "description": "Toolkit configuration - specify either enable toolkits (allowlist) or disable toolkits (denylist). Mutually exclusive."
8439
+ },
8440
+ "tools": {
8441
+ "type": "object",
8442
+ "additionalProperties": {
8443
+ "anyOf": [
8444
+ {
8445
+ "type": "object",
8446
+ "properties": {
8447
+ "enable": {
8448
+ "type": "array",
8449
+ "items": {
8450
+ "type": "string"
8451
+ },
8452
+ "description": "Only these specific tools will be available for this toolkit",
8453
+ "example": [
8454
+ "GMAIL_SEND_EMAIL",
8455
+ "GMAIL_FETCH_EMAILS"
8456
+ ]
8457
+ }
8458
+ },
8459
+ "required": [
8460
+ "enable"
8461
+ ],
8462
+ "additionalProperties": false
8463
+ },
8464
+ {
8465
+ "type": "object",
8466
+ "properties": {
8467
+ "disable": {
8468
+ "type": "array",
8469
+ "items": {
8470
+ "type": "string"
8471
+ },
8472
+ "description": "These specific tools will be disabled for this toolkit",
8473
+ "example": [
8474
+ "SLACK_ADD_EMOJI"
8475
+ ]
8476
+ }
8477
+ },
8478
+ "required": [
8479
+ "disable"
8480
+ ],
8481
+ "additionalProperties": false
8482
+ }
8483
+ ]
8484
+ },
8485
+ "description": "Per-toolkit enable or disable lists that restrict premium usage. Toolkits absent from the map have no additional tool restriction. On PATCH, a supplied map replaces all existing tool filters; an empty map clears them, and omission preserves them."
8486
+ },
8487
+ "return_premium_charge": {
8488
+ "type": "boolean",
8489
+ "description": "Return the top-level premium_charge in session tool responses when a charge is available. Defaults to false on create; omission on PATCH preserves the current value. Controls response visibility only; it does not enable or disable premium usage."
8490
+ }
8491
+ },
8492
+ "additionalProperties": false
8493
+ }
8494
+ ],
8495
+ "description": "Controls premium usage, subject to project permission and session toolkit and tool restrictions. False disables premium usage. Omission on create or an empty object enables it with charges hidden. On PATCH, omitted fields are preserved; an object re-enables a disabled setting."
8496
+ },
8497
"manage_connections": {
8498
"type": "object",
8499
"nullable": true,
@@ -8460,6 +8986,103 @@
8986
},
8987
"description": "Auth config overrides per toolkit"
8988
},
8989
+ "premium_usage": {
8990
+ "anyOf": [
8991
+ {
8992
+ "type": "boolean",
8993
+ "enum": [
8994
+ false
8995
+ ]
8996
+ },
8997
+ {
8998
+ "type": "object",
8999
+ "properties": {
9000
+ "toolkits": {
9001
+ "anyOf": [
9002
+ {
9003
+ "type": "object",
9004
+ "properties": {
9005
+ "enabled": {
9006
+ "type": "array",
9007
+ "items": {
9008
+ "type": "string"
9009
+ }
9010
+ }
9011
+ },
9012
+ "required": [
9013
+ "enabled"
9014
+ ],
9015
+ "additionalProperties": false
9016
+ },
9017
+ {
9018
+ "type": "object",
9019
+ "properties": {
9020
+ "disabled": {
9021
+ "type": "array",
9022
+ "items": {
9023
+ "type": "string"
9024
+ }
9025
+ }
9026
+ },
9027
+ "required": [
9028
+ "disabled"
9029
+ ],
9030
+ "additionalProperties": false
9031
+ }
9032
+ ],
9033
+ "description": "Toolkits eligible for premium usage, as an enabled or disabled list. If absent, no additional toolkit restriction applies."
9034
+ },
9035
+ "tools": {
9036
+ "type": "object",
9037
+ "additionalProperties": {
9038
+ "anyOf": [
9039
+ {
9040
+ "type": "object",
9041
+ "properties": {
9042
+ "enabled": {
9043
+ "type": "array",
9044
+ "items": {
9045
+ "type": "string"
9046
+ }
9047
+ }
9048
+ },
9049
+ "required": [
9050
+ "enabled"
9051
+ ],
9052
+ "additionalProperties": false
9053
+ },
9054
+ {
9055
+ "type": "object",
9056
+ "properties": {
9057
+ "disabled": {
9058
+ "type": "array",
9059
+ "items": {
9060
+ "type": "string"
9061
+ }
9062
+ }
9063
+ },
9064
+ "required": [
9065
+ "disabled"
9066
+ ],
9067
+ "additionalProperties": false
9068
+ }
9069
+ ]
9070
+ },
9071
+ "description": "Per-toolkit enabled or disabled lists that restrict premium usage. Toolkits absent from this map have no additional tool restriction."
9072
+ },
9073
+ "return_premium_charge": {
9074
+ "type": "boolean",
9075
+ "description": "Whether session tool responses return a top-level premium_charge when a charge is available. Defaults to false; controls response visibility only."
9076
+ }
9077
+ },
9078
+ "required": [
9079
+ "return_premium_charge"
9080
+ ],
9081
+ "additionalProperties": false
9082
+ }
9083
+ ],
9084
+ "description": "Premium usage settings. False disables premium usage; an object permits it subject to project permission and session toolkit and tool restrictions."
9085
+ },
9086
"manage_connections": {
9087
"type": "object",
9088
"properties": {
@@ -8714,6 +9337,7 @@
9337
},
9338
"required": [
9339
"user_id",
9340
+ "premium_usage",
9341
"preload",
9342
"search",
9343
"execute"
@@ -9415,6 +10039,103 @@
10039
},
10040
"description": "Auth config overrides per toolkit"
10041
},
10042
+ "premium_usage": {
10043
+ "anyOf": [
10044
+ {
10045
+ "type": "boolean",
10046
+ "enum": [
10047
+ false
10048
+ ]
10049
+ },
10050
+ {
10051
+ "type": "object",
10052
+ "properties": {
10053
+ "toolkits": {
10054
+ "anyOf": [
10055
+ {
10056
+ "type": "object",
10057
+ "properties": {
10058
+ "enabled": {
10059
+ "type": "array",
10060
+ "items": {
10061
+ "type": "string"
10062
+ }
10063
+ }
10064
+ },
10065
+ "required": [
10066
+ "enabled"
10067
+ ],
10068
+ "additionalProperties": false
10069
+ },
10070
+ {
10071
+ "type": "object",
10072
+ "properties": {
10073
+ "disabled": {
10074
+ "type": "array",
10075
+ "items": {
10076
+ "type": "string"
10077
+ }
10078
+ }
10079
+ },
10080
+ "required": [
10081
+ "disabled"
10082
+ ],
10083
+ "additionalProperties": false
10084
+ }
10085
+ ],
10086
+ "description": "Toolkits eligible for premium usage, as an enabled or disabled list. If absent, no additional toolkit restriction applies."
10087
+ },
10088
+ "tools": {
10089
+ "type": "object",
10090
+ "additionalProperties": {
10091
+ "anyOf": [
10092
+ {
10093
+ "type": "object",
10094
+ "properties": {
10095
+ "enabled": {
10096
+ "type": "array",
10097
+ "items": {
10098
+ "type": "string"
10099
+ }
10100
+ }
10101
+ },
10102
+ "required": [
10103
+ "enabled"
10104
+ ],
10105
+ "additionalProperties": false
10106
+ },
10107
+ {
10108
+ "type": "object",
10109
+ "properties": {
10110
+ "disabled": {
10111
+ "type": "array",
10112
+ "items": {
10113
+ "type": "string"
10114
+ }
10115
+ }
10116
+ },
10117
+ "required": [
10118
+ "disabled"
10119
+ ],
10120
+ "additionalProperties": false
10121
+ }
10122
+ ]
10123
+ },
10124
+ "description": "Per-toolkit enabled or disabled lists that restrict premium usage. Toolkits absent from this map have no additional tool restriction."
10125
+ },
10126
+ "return_premium_charge": {
10127
+ "type": "boolean",
10128
+ "description": "Whether session tool responses return a top-level premium_charge when a charge is available. Defaults to false; controls response visibility only."
10129
+ }
10130
+ },
10131
+ "required": [
10132
+ "return_premium_charge"
10133
+ ],
10134
+ "additionalProperties": false
10135
+ }
10136
+ ],
10137
+ "description": "Premium usage settings. False disables premium usage; an object permits it subject to project permission and session toolkit and tool restrictions."
10138
+ },
10139
"manage_connections": {
10140
"type": "object",
10141
"properties": {
@@ -9669,6 +10390,7 @@
10390
},
10391
"required": [
10392
"user_id",
10393
+ "premium_usage",
10394
"preload",
10395
"search",
10396
"execute"
@@ -13014,7 +13736,7 @@
13736
"nullable": true
13737
},
13738
"required": false,
13017
- "description": "Number of items per page, max allowed is 50",
13739
+ "description": "Number of items per page, max allowed is 200",
13740
"name": "limit",
13741
"in": "query"
13742
},