The Vibe connector lets your AI agent act in each user's Vibe account. Each user signs in to Vibe once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 34 tools.
- Tools
- 34
- What they doRead · write · destructive
- 21 · 9 · 421 read9 write4 destructive
- Users sign in with
- OAuth
- OAuth app
- Your own Vibe app
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Vibe connection
In AgentKit > Connections, create a Vibe connection and copy its redirect URI. The name you give it is the
connection_nameyour code passes. See Configure connections.Register an OAuth app
Vibe connections use your own OAuth app. Register one with Vibe and add the redirect URI you copied.
Then enter the app's Client ID and Client Secret on the Vibe connection.
Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'vibe'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Vibe:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'vibe_get_account_balance',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "vibe"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Vibe:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="vibe_get_account_balance",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user signs in once. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolvibe_get_account_balanceGet the current billing balance of the authenticated Vibe account.Read-onlyGet Account Balance
Get the current billing balance of the authenticated Vibe account. Returns the account id, currency, balance in cents (balance_cents) and when it was last updated. The balance is Vibe's authoritative running total of what is owed, so it is not expected to match a sum of individual billing operations exactly. Use this for the amount owed right now; to browse individual invoices, use vibe_list_invoices. Requires the billing:read OAuth scope.
Inputs
This tool takes no inputs.
vibe_get_advertiserGet one Vibe advertiser by its ID.Read-onlyGet Advertiser
Get one Vibe advertiser by its ID. Returns the advertiser's id, name, url, industry, apps (app_id and os), and created/updated timestamps. Use this when you already have the advertiser ID; to search or browse advertisers, use vibe_list_advertisers. Requires the advertisers:read scope.
Inputs
advertiser_idstringrequired- UUID of the advertiser to retrieve. Get it from vibe_list_advertisers. Example: 8a1c4d2e-6b3f-4a9d-b7e5-2f1c0d9e8a7b.
vibe_get_audienceGet a single persistent Vibe audience by its ID.Read-onlyGet Audience
Get a single persistent Vibe audience by its ID. Returns the audience's id, advertiser id, name, display name, description, external audience key, status (ACTIVE or INACTIVE), and created and updated timestamps. Use this when you already have an audience_id; to find the audiences of an advertiser, use vibe_list_audiences. Requires the audiences:read OAuth scope.
Inputs
audience_idstringrequired- Stable identifier of the audience to retrieve. Required. Take it from the id field returned by vibe_list_audiences. Example: 3f2a9b64-8d1e-4c07-b5a3-6e7d0c1f2a98.
vibe_get_campaignGet one Vibe campaign by its ID.Read-onlyGet Campaign
Get one Vibe campaign by its ID. Returns the campaign's id, advertiser_id, name, goal, status, state, active, attribution_window_in_hours, optimization_goal, start/end dates and budget (derived from its strategies), publication_date, and created/updated timestamps. Use this when you already have the campaign ID; to search or browse campaigns, use vibe_list_campaigns. Requires the campaigns:read scope.
Inputs
campaign_idstringrequired- UUID of the campaign to retrieve. Get it from vibe_list_campaigns or from the id returned when the campaign was created. Example: 5f2b8e1a-3c4d-4e6f-9a7b-1c2d3e4f5a6b.
vibe_get_strategyGet one Vibe strategy by its id.Read-onlyGet Strategy
Get one Vibe strategy by its id. Returns the strategy's campaign_id, name, budget, budget_type, starts_at, ends_at, active flag, review state (AUTHORIZED, BLOCKED or PENDING_REVIEW), targeting object, creative_ids and timestamps. Use this when you already have a strategy id; use vibe_list_strategies to find strategies and vibe_list_strategy_creatives for full creative records (a strategy only carries creative ids). Requires the campaigns:read OAuth scope.
Inputs
strategy_idstringrequired- UUID of the Vibe strategy to retrieve. Get it from vibe_list_strategies, or from the id returned by vibe_create_strategy.
vibe_list_accountsList the Vibe accounts the connected app can access.Read-onlyList Accounts
List the Vibe accounts the connected app can access. Returns a plain array (no pagination) with each account's id, name, currency, timezone, status (ACTIVE, BLOCKED, or ONBOARDING), and created/updated timestamps. Use this to see which accounts the app can act on; to browse the advertisers inside the account, use vibe_list_advertisers. Requires the account:read scope.
Inputs
This tool takes no inputs.
vibe_list_advertisersList the advertisers in the Vibe account, optionally filtered by ID, name, or URL.Read-onlyList Advertisers
List the advertisers in the Vibe account, optionally filtered by ID, name, or URL. Returns a page with data, total, limit, and offset; each advertiser has id, name, url, industry, apps (app_id and os), and created/updated timestamps. Use this to browse or find an advertiser ID; to fetch one advertiser by ID, use vibe_get_advertiser, and to see its campaigns, use vibe_list_campaigns. Requires the advertisers:read scope.
Inputs
idstring- Return only the advertiser with this UUID. Example: 8a1c4d2e-6b3f-4a9d-b7e5-2f1c0d9e8a7b. To fetch a single advertiser by ID, vibe_get_advertiser is more direct.
limitinteger- Maximum number of advertisers to return in one page. Defaults to 20; Vibe's pagination guide sets a maximum of 5000. Combine with offset to page through results.default
20 namestring- Case-insensitive 'contains' filter on the advertiser name. Example: acme.
offsetinteger- Number of advertisers to skip before returning results, for paging. Defaults to 0. For the next page, add the previous limit to the previous offset; stop when offset reaches the total in the response.default
0 urlstring- Case-insensitive 'contains' filter on the advertiser URL. Example: acme.com.
vibe_list_age_rangesList the age ranges that can be targeted in a Vibe strategy.Read-onlyList Age Ranges
List the age ranges that can be targeted in a Vibe strategy. Returns the complete list with no pagination, each with an id (RANGE_18_20, RANGE_21_24, RANGE_25_34, RANGE_35_44, RANGE_45_54, RANGE_55_64 or RANGE_65_MORE) and a display name. Use this to look up age-range IDs for strategy targeting; for gender use vibe_list_genders, and for other demographic segments use vibe_list_demographics. The catalog updates weekly, so cache the result for at least 24 hours. Requires the campaigns:read OAuth scope.
Inputs
This tool takes no inputs.
vibe_list_audiencesList the persistent audiences that belong to one Vibe advertiser, with offset pagination.Read-onlyList Audiences
List the persistent audiences that belong to one Vibe advertiser, with offset pagination. Returns each audience's id, advertiser id, application id, name, external audience key and status (ACTIVE or INACTIVE), plus total, limit and offset. Use this to browse an advertiser's audiences; to fetch one audience's full detail (display name, description, created and updated times), use vibe_get_audience. Get the advertiser_id from vibe_list_advertisers. Requires the audiences:read OAuth scope.
Inputs
advertiser_idstringrequired- Stable identifier of the advertiser whose audiences to list. Required. Use vibe_list_advertisers to find it. Example: 7c1d8e52-3b9a-4f64-a1d2-9e0b5c3f1a77.
limitinteger- Maximum number of audiences to return in one page, as an integer of at least 1. The Vibe pagination guide caps limit at 5000 for list endpoints. Defaults to 20. Use together with offset to page through results; the response reports total, limit and offset.default
20 offsetinteger- Number of audiences to skip before returning results, as an integer of at least 0. Defaults to 0. Increase it by the previous limit to fetch the next page.default
0
vibe_list_campaign_creativesList the creatives attached to one Vibe campaign.Read-onlyList Campaign Creatives
List the creatives attached to one Vibe campaign. Returns a page with data, total, limit, and offset; each creative has id, advertiser_id, name, type (VIDEO or VAST), asset_url, vast_tag_url, approval_status (PROCESSING, PENDING_REVIEW, AUTHORIZED, or BLOCKED), approval_details, and created/updated timestamps. Use this for the creatives of a single campaign; to list creatives across the account, use vibe_list_creatives. Requires the creatives:read scope, not campaigns:read.
Inputs
campaign_idstringrequired- UUID of the campaign to list creatives for. Get it from vibe_list_campaigns or from the id returned when the campaign was created. Example: 5f2b8e1a-3c4d-4e6f-9a7b-1c2d3e4f5a6b.
limitinteger- Maximum number of creatives to return in one page. Defaults to 20; Vibe's pagination guide sets a maximum of 5000. Combine with offset to page through results.default
20 offsetinteger- Number of creatives to skip before returning results, for paging. Defaults to 0. For the next page, add the previous limit to the previous offset; stop when offset reaches the total in the response.default
0
vibe_list_campaignsList the campaigns in the Vibe account, optionally filtered by ID, advertiser, status, or a name search.Read-onlyList Campaigns
List the campaigns in the Vibe account, optionally filtered by ID, advertiser, status, or a name search. Returns a page with data, total, limit, and offset; each campaign has id, advertiser_id, name, goal, status, state, active, attribution_window_in_hours, optimization_goal, start/end dates, budget, publication_date, and created/updated timestamps. Use this to browse or find campaigns; to fetch one campaign by ID, use vibe_get_campaign. Requires the campaigns:read scope.
Inputs
advertiser_idstring- Return only campaigns that belong to this advertiser UUID. Get it from vibe_list_advertisers. Example: 8a1c4d2e-6b3f-4a9d-b7e5-2f1c0d9e8a7b.
idstring- Return only the campaign with this UUID. Example: 5f2b8e1a-3c4d-4e6f-9a7b-1c2d3e4f5a6b. To fetch a single campaign by ID, vibe_get_campaign is more direct.
limitinteger- Maximum number of campaigns to return in one page. Defaults to 20; Vibe's pagination guide sets a maximum of 5000. Combine with offset to page through results.default
20 offsetinteger- Number of campaigns to skip before returning results, for paging. Defaults to 0. For the next page, add the previous limit to the previous offset; stop when offset reaches the total in the response.default
0 searchstring- Case-insensitive 'contains' search on the campaign name; at least 2 characters. Example: spring.
statusarray- Filter by campaign status; pass several values to combine them. Allowed values: DRAFT, UPCOMING_OR_DELIVERING, PAUSED, ARCHIVED, COMPLETED, BLOCKED. These filter values are not the same as the status (DRAFT, PUBLISHED, ARCHIVED, DELETED) and state fields on the returned campaigns. Example: ["DRAFT", "PAUSED"].
vibe_list_channelsList the apps, channels and live-sports inventory that can be targeted in a Vibe strategy, optionally filtered by inventory type, category or name, with offset pagination.Read-onlyList Channels
List the apps, channels and live-sports inventory that can be targeted in a Vibe strategy, optionally filtered by inventory type, category or name, with offset pagination. Returns each channel's id, name, description, type (CHANNEL or LIVE_SPORT), categories, logo URLs, whether it has a landing page, whether it is deprecated, and the advertiser categories allowed to target it, plus total, limit and offset. Use this to look up channel IDs for strategy targeting; for locations use vibe_search_geolocations, for devices use vibe_list_devices, and for interest audiences use vibe_list_interest_segments. The catalog updates weekly, so cache the result for at least 24 hours. Requires the campaigns:read OAuth scope.
Inputs
categorystring- Filter by category name, for example Sports. Matches the category names that appear in each channel's categories list. If omitted, all categories are returned.
deprecatedboolean- Set to true to include deprecated channels in the results. If omitted, deprecated channels are left out (the API default is false).
limitinteger- Maximum number of channels to return in one page, as an integer of at least 1. The Vibe pagination guide caps limit at 5000 for list endpoints. If omitted, the API default applies. Use together with offset to page through results; the response reports total, limit and offset.
offsetinteger- Number of channels to skip before returning results, as an integer of at least 0. If omitted, the API starts at the first item. Increase it by the previous limit to fetch the next page.
searchstring- Case-insensitive search of channels by name, for example hulu. If omitted, no name filter is applied.
typestring- Filter by inventory type. Valid values are APPS_AND_CHANNELS and LIVE_SPORTS. If omitted, both are returned.one of
APPS_AND_CHANNELSLIVE_SPORTS
vibe_list_creativesList the creatives (video files or VAST tags) in the connected Vibe account, optionally filtered by advertiser.Read-onlyList Creatives
List the creatives (video files or VAST tags) in the connected Vibe account, optionally filtered by advertiser. Returns a page of creatives (id, advertiser_id, name, type VIDEO or VAST, asset_url, vast_tag_url, approval_status, approval_details, timestamps) with total, limit and offset. Use this to browse all creatives or find creative ids; use vibe_list_strategy_creatives or vibe_list_campaign_creatives for the creatives attached to a specific strategy or campaign. Requires the creatives:read OAuth scope.
Inputs
advertiser_idstring- UUID of an advertiser; returns only that advertiser's creatives. Get it from vibe_list_advertisers. Leave it out to list creatives across advertisers.
limitinteger- Maximum number of creatives to return in one page, from 1 to 5000. The API default is 20. Combine with offset to page through results, for example limit 50 with offset 100 returns items 101 to 150.default
20 offsetinteger- Number of creatives to skip before returning results, 0 or greater. The API default is 0. Increase it by the limit value to fetch the next page.default
0
vibe_list_demographicsList the demographic segments that can be targeted in a Vibe strategy, grouped by category.Read-onlyList Demographics
List the demographic segments that can be targeted in a Vibe strategy, grouped by category. Returns the complete list with no pagination, each with an id, name and category. Use this to look up demographic segment IDs for strategy targeting; age ranges and genders have their own tools, vibe_list_age_ranges and vibe_list_genders, and interest audiences are in vibe_list_interest_segments. The catalog updates weekly, so cache the result for at least 24 hours. Requires the campaigns:read OAuth scope.
Inputs
This tool takes no inputs.
vibe_list_devicesList the device types that can be targeted in a Vibe strategy.Read-onlyList Devices
List the device types that can be targeted in a Vibe strategy. Returns the complete list with no pagination, each with an id (TV, TABLET or MOBILE) and a display name. Use this to look up device IDs for strategy targeting; for channels and apps use vibe_list_channels, and for locations use vibe_search_geolocations. The catalog updates weekly, so cache the result for at least 24 hours. Requires the campaigns:read OAuth scope.
Inputs
This tool takes no inputs.
vibe_list_gendersList the genders that can be targeted in a Vibe strategy.Read-onlyList Genders
List the genders that can be targeted in a Vibe strategy. Returns the complete list with no pagination, each with an id (MALE or FEMALE) and a display name. Use this to look up gender IDs for strategy targeting; for age use vibe_list_age_ranges, and for other demographic segments use vibe_list_demographics. The catalog updates weekly, so cache the result for at least 24 hours. Requires the campaigns:read OAuth scope.
Inputs
This tool takes no inputs.
vibe_list_interest_segmentsList the audience interest segments that can be targeted in a Vibe strategy, optionally filtered by name, with offset pagination.Read-onlyList Interest Segments
List the audience interest segments that can be targeted in a Vibe strategy, optionally filtered by name, with offset pagination. Returns each segment's id, name, parent and size, plus total, limit and offset. Use this to look up interest segment IDs for strategy targeting; for age, gender and other demographic segments use vibe_list_age_ranges, vibe_list_genders and vibe_list_demographics. The catalog updates weekly, so cache the result for at least 24 hours. Requires the campaigns:read OAuth scope.
Inputs
limitinteger- Maximum number of interest segments to return in one page, as an integer of at least 1. The Vibe pagination guide caps limit at 5000 for list endpoints. If omitted, the API default applies. Use together with offset to page through results; the response reports total, limit and offset.
offsetinteger- Number of interest segments to skip before returning results, as an integer of at least 0. If omitted, the API starts at the first item. Increase it by the previous limit to fetch the next page.
searchstring- Case-insensitive search of interest segments by name, for example travel. If omitted, no name filter is applied.
vibe_list_invoicesList the invoices of the authenticated Vibe account, optionally filtered by status, with offset pagination.Read-onlyList Invoices
List the invoices of the authenticated Vibe account, optionally filtered by status, with offset pagination. Returns each invoice's id, status (open, failed, paid or void), currency, amount and amount paid in cents, payment retry count, and created and paid timestamps, plus total, limit and offset. Use this to browse billing history; for the amount currently owed, use vibe_get_account_balance. Requires the billing:read OAuth scope.
Inputs
limitinteger- Maximum number of invoices to return in one page, as an integer of at least 1. Maximum 100. Defaults to 20. Use together with offset to page through results; the response reports total, limit and offset.default
20 offsetinteger- Number of invoices to skip before returning results, as an integer of at least 0. If omitted, the API starts at the first item. Increase it by the previous limit to fetch the next page.
statusstring- Only return invoices with this status. Valid values are open, failed, paid and void. If omitted, invoices of every status are returned.one of
openfailedpaidvoid
vibe_list_strategiesList the strategies in the connected Vibe account, optionally filtered by campaign, advertiser, active flag, or start and end date-time.Read-onlyList Strategies
List the strategies in the connected Vibe account, optionally filtered by campaign, advertiser, active flag, or start and end date-time. Returns a page of strategies (id, campaign_id, name, budget, budget_type, starts_at, ends_at, active, review state, targeting, creative_ids, timestamps) with total, limit and offset. Use this to browse strategies; use vibe_get_strategy for one strategy by id, vibe_list_strategy_creatives for the creative records attached to a strategy, or vibe_list_campaigns for campaigns. Requires the campaigns:read OAuth scope.
Inputs
activeboolean- Filter by delivery state: true returns only active strategies and false returns only inactive ones. Leave it out to return both.
advertiser_idstring- UUID of an advertiser; returns only strategies for that advertiser. Get it from vibe_list_advertisers.
campaign_idstring- UUID of a campaign; returns only strategies in that campaign. Get it from vibe_list_campaigns.
ends_atstring- Filter by strategy end date-time, as an ISO 8601 date-time such as 2026-12-01T00:00:00Z. The Vibe reference does not say whether this matches exactly or as a bound.
limitinteger- Maximum number of strategies to return in one page, from 1 to 5000. The API default is 20. Combine with offset to page through results, for example limit 50 with offset 100 returns items 101 to 150.default
20 offsetinteger- Number of strategies to skip before returning results, 0 or greater. The API default is 0. Increase it by the limit value to fetch the next page.default
0 starts_atstring- Filter by strategy start date-time, as an ISO 8601 date-time such as 2026-11-01T00:00:00Z. The Vibe reference does not say whether this matches exactly or as a bound.
vibe_list_strategy_creativesList the creatives attached to one Vibe strategy.Read-onlyList Strategy Creatives
List the creatives attached to one Vibe strategy. Returns a page of creatives (id, advertiser_id, name, type VIDEO or VAST, asset_url, vast_tag_url, approval_status, approval_details, timestamps) with total, limit and offset. Use this for the creatives of a single strategy; use vibe_list_creatives for all creatives (optionally by advertiser), vibe_list_campaign_creatives for a campaign's creatives, or vibe_get_strategy for just the creative ids. Requires the creatives:read OAuth scope and a strategy id from vibe_list_strategies.
Inputs
strategy_idstringrequired- UUID of the Vibe strategy to list creatives for. Get it from vibe_list_strategies, or from the id returned by vibe_create_strategy.
limitinteger- Maximum number of creatives to return in one page, from 1 to 5000. The API default is 20. Combine with offset to page through results, for example limit 50 with offset 100 returns items 101 to 150.default
20 offsetinteger- Number of creatives to skip before returning results, 0 or greater. The API default is 0. Increase it by the limit value to fetch the next page.default
0
vibe_search_geolocationsSearch or browse the geographic locations that can be targeted in a Vibe strategy: regions, metros, cities, ZIP codes, counties and congressional districts.Read-onlySearch Geolocations
Search or browse the geographic locations that can be targeted in a Vibe strategy: regions, metros, cities, ZIP codes, counties and congressional districts. Returns each location's id, label, reach and type, plus total, limit and offset. Use this to look up location IDs for strategy targeting. At least one of type or search is required: set type to browse every location of that type with pagination, or set search (minimum 2 characters) to match labels across all types, in which case offset is ignored. The catalog updates weekly, so cache the result for at least 24 hours. Requires the campaigns:read OAuth scope.
Inputs
deprecatedboolean- Set to true to include deprecated locations. This only applies to REGION and CITY locations. Defaults to false.default
false limitinteger- Maximum number of locations to return in one page, as an integer of at least 1. Maximum 100. Defaults to 20. Use together with offset to page through results; the response reports total, limit and offset.default
20 offsetinteger- Number of locations to skip before returning results, as an integer of at least 0. Defaults to 0. Ignored when searching without a type. Increase it by the previous limit to fetch the next page.default
0 searchstring- Case-insensitive search on the location label, minimum 2 characters, for example austin. Required when type is not provided. When type is also set, the search is restricted to that type; without type, results span all location types and offset is ignored.
typestring- Location type to browse. Valid values are REGION, METRO, CITY, ZIPCODE, COUNTY and CONGRESSIONAL_DISTRICT. At least one of type or search must be provided. When type is set, search is optional and, if omitted, every location of that type is returned page by page.one of
REGIONMETROCITYZIPCODECOUNTYCONGRESSIONAL_DISTRICT
vibe_campaign_actionPause or reactivate a published Vibe campaign.WritePerform Campaign Action
Pause or reactivate a published Vibe campaign. Returns the updated campaign. PAUSE stops delivery and ACTIVATE resumes it. PAUSE is rejected once the campaign has passed its end date, and invalid state transitions return 422. Use this to pause or reactivate a campaign. To publish a draft campaign, use vibe_publish_campaign, which needs the campaigns:publish scope. This tool requires the campaigns:write scope.
Inputs
actionstringrequired- Lifecycle action to perform: PAUSE stops delivery of a published campaign and ACTIVATE resumes it.one of
PAUSEACTIVATE campaign_idstringrequired- UUID of the campaign to act on. Get it from vibe_list_campaigns or from the id returned when the campaign was created. Example: 5f2b8e1a-3c4d-4e6f-9a7b-1c2d3e4f5a6b.
vibe_create_campaignCreate a Vibe campaign in DRAFT status for an advertiser, with a goal, an optimization goal, and target countries.WriteCreate Campaign
Create a Vibe campaign in DRAFT status for an advertiser, with a goal, an optimization goal, and target countries. Returns the created campaign with its id, status, state, and settings. Nothing is delivered or spent until the campaign is published, and strategies (budget, schedule, targeting) are added separately. Use this to start a new campaign; to copy an existing one, use vibe_duplicate_campaign, and to go live, use vibe_publish_campaign. Requires the campaigns:write scope.
Inputs
advertiser_idstringrequired- UUID of the advertiser the campaign belongs to. Get it from vibe_list_advertisers. Example: 8a1c4d2e-6b3f-4a9d-b7e5-2f1c0d9e8a7b.
countriesarrayrequired- ISO 3166-1 alpha-3 country codes the campaign targets. Vibe requires the exact set USA, so pass ["USA"].
goalstringrequired- Campaign goal. One of AWARENESS, INSTALL, TRAFFIC, RETARGETING, SALES, LEADS, or ABM.one of
AWARENESSINSTALLTRAFFICRETARGETINGSALESLEADSABM namestringrequired- Campaign name, required, 10 to 100 characters. Example: Spring CTV Awareness 2026.
optimization_goalobjectrequired- Optimization goal for the campaign, as an object with a type and a target value. The type is one of COST_PER_SESSION, COST_PER_LEAD, COST_PER_CALL, COST_PER_PURCHASE, ROAS, CPM, COST_PER_INSTALL, COST_PER_UNIQUE_HOUSEHOLD, or COST_PER_UNIQUE_COMPANY. The value is the target in USD, at least 1, with at most 2 decimal places. Both are required. Example: {"type": "COST_PER_SESSION", "value": 2.5}.
activeboolean- Whether the campaign is active. Defaults to true. A new campaign is created in DRAFT status and does not deliver until it is published.default
true attribution_windowstring- Attribution window for conversions. One of TWELVE_HOURS, ONE_DAY, FORTY_EIGHT_HOURS, SEVENTY_TWO_HOURS, SEVEN_DAYS, or THIRTY_DAYS. If omitted the API applies its own default.one of
TWELVE_HOURSONE_DAYFORTY_EIGHT_HOURSSEVENTY_TWO_HOURSSEVEN_DAYSTHIRTY_DAYS
vibe_create_strategyCreate a strategy under a Vibe campaign with a budget, schedule, optional targeting and optional creatives.WriteCreate Strategy
Create a strategy under a Vibe campaign with a budget, schedule, optional targeting and optional creatives. Returns the created strategy (id, campaign_id, name, budget, budget_type, starts_at, ends_at, active, review state, targeting, creative_ids, timestamps). Use this to add a new strategy; use vibe_duplicate_strategy to copy an existing one, or vibe_update_strategy to change one that already exists. Requires the campaigns:write OAuth scope and an existing campaign id, for example from vibe_list_campaigns or vibe_create_campaign.
Inputs
budgetintegerrequired- Budget in USD as a whole number, 1 or greater, for example 100. Whether it is a daily or overall cap depends on budget_type.
budget_typestringrequired- Budget type, either DAILY or GLOBAL.one of
DAILYGLOBAL campaign_idstringrequired- UUID of the campaign that will contain the new strategy. Get it from vibe_list_campaigns or vibe_create_campaign.
namestringrequired- Name of the strategy, 3 to 100 characters, for example Primetime US Households.
starts_atstringrequired- Start date and time of the strategy as an ISO 8601 date-time, for example 2026-11-01T00:00:00Z.
activeboolean- Whether the strategy is active. Vibe's default is true, so leave it out for an active strategy.default
true creative_idsarray- UUIDs of the creatives to attach to the strategy, for example from vibe_list_creatives.
ends_atstring- End date and time of the strategy as an ISO 8601 date-time, for example 2026-12-01T00:00:00Z. Optional; leave it out for no end date.
targetingobject- Targeting settings for the strategy as an object; include only the groups you want to set. Location targeting (geo) takes include and exclude lists of location ids for regions, cities, metro codes and zip codes, for example ids returned by vibe_search_geolocations. Inventory takes a type (APPS_AND_CHANNELS or LIVE_SPORTS) plus include and exclude lists of channel ids, for example from vibe_list_channels. The age_ranges list accepts RANGE_18_20, RANGE_21_24, RANGE_25_34, RANGE_35_44, RANGE_45_54, RANGE_55_64 and RANGE_65_MORE; genders accepts MALE and FEMALE; devices accepts TV, TABLET and MOBILE. Interests is a list of interest ids, for example from vibe_list_interest_segments. Audiences are set under an upload entry with include and exclude lists of audience UUIDs, for example from vibe_list_audiences. Dayparting takes a preset (CUSTOM, ANY_TIME_ANY_DAY, PRIMETIME, AFTER_WORK, WORK_HOURS, SLEEPING_TIME, WEEKEND or WORK_DAYS); with CUSTOM, add custom_ranges as start and end pairs in minutes from midnight Monday (0 to 10079). Example: {"geo": {"regions": {"include": ["USA/NY"]}}, "devices": ["TV"], "age_ranges": ["RANGE_25_34"], "dayparting": {"preset": "PRIMETIME"}}.
vibe_duplicate_campaignDuplicate a Vibe campaign, optionally overriding its name, goal, attribution window, optimization goal, active flag, strategies, or creatives.WriteDuplicate Campaign
Duplicate a Vibe campaign, optionally overriding its name, goal, attribution window, optimization goal, active flag, strategies, or creatives. Returns only the id of the new campaign; call vibe_get_campaign with it to read the full campaign. Use this to copy a campaign as a starting point; to create one from scratch, use vibe_create_campaign. Requires the campaigns:write scope.
Inputs
campaign_idstringrequired- UUID of the campaign to duplicate. Get it from vibe_list_campaigns or from the id returned when the campaign was created. Example: 5f2b8e1a-3c4d-4e6f-9a7b-1c2d3e4f5a6b.
activeboolean- Whether the duplicated campaign is active. Leave unset to use the API default.
attribution_windowstring- Attribution window for conversions. One of TWELVE_HOURS, ONE_DAY, FORTY_EIGHT_HOURS, SEVENTY_TWO_HOURS, SEVEN_DAYS, or THIRTY_DAYS. If omitted the API applies its own default.one of
TWELVE_HOURSONE_DAYFORTY_EIGHT_HOURSSEVENTY_TWO_HOURSSEVEN_DAYSTHIRTY_DAYS creativesarray- Optional list of creatives for the duplicated campaign. Each entry has the creative's UUID (id) and a name of 1 to 150 characters. Example: [{"id": "5f2b8e1a-3c4d-4e6f-9a7b-1c2d3e4f5a6b", "name": "Spring 30s spot"}].
goalstring- Campaign goal. One of AWARENESS, INSTALL, TRAFFIC, RETARGETING, SALES, LEADS, or ABM.one of
AWARENESSINSTALLTRAFFICRETARGETINGSALESLEADSABM namestring- Campaign name, 10 to 100 characters. Example: Spring CTV Awareness 2026.
optimization_goalobject- New optimization goal for the campaign, as an object with a type and a target value. The type is one of COST_PER_SESSION, COST_PER_LEAD, COST_PER_CALL, COST_PER_PURCHASE, ROAS, CPM, COST_PER_INSTALL, COST_PER_UNIQUE_HOUSEHOLD, or COST_PER_UNIQUE_COMPANY. The value is the target in USD, at least 1, with at most 2 decimal places. If you include this object both fields are required; leave it out to keep the current goal. Example: {"type": "COST_PER_SESSION", "value": 2.5}.
strategiesarray- Optional overrides for the strategies of the duplicated campaign, as a list of strategy objects. Each entry can carry the UUID of the source campaign's strategy it refers to plus new values for its name (3 to 100 characters), active flag, budget in USD (whole number, at least 1), budget_type (DAILY or GLOBAL), starts_at and ends_at date-times, targeting, and creative_ids. Targeting can set geo, inventory, age_ranges, genders, devices, interests, audiences, and dayparting. Example: [{"id": "5f2b8e1a-3c4d-4e6f-9a7b-1c2d3e4f5a6b", "name": "Spring Primetime", "budget": 500, "budget_type": "GLOBAL", "starts_at": "2026-11-01T00:00:00Z", "ends_at": "2026-11-30T23:59:59Z"}].
vibe_duplicate_strategyDuplicate an existing Vibe strategy, optionally overriding fields on the new copy or placing the copy in a different campaign.WriteDuplicate Strategy
Duplicate an existing Vibe strategy, optionally overriding fields on the new copy or placing the copy in a different campaign. Returns the new strategy (id, campaign_id, name, budget, budget_type, starts_at, ends_at, active, review state, targeting, creative_ids, timestamps). Use this to clone a strategy as a starting point; use vibe_create_strategy to build one from scratch and vibe_update_strategy to edit one in place. Requires the campaigns:write OAuth scope and the id of the strategy to copy, from vibe_list_strategies.
Inputs
strategy_idstringrequired- UUID of the Vibe strategy to duplicate. Get it from vibe_list_strategies, or from the id returned by vibe_create_strategy.
activeboolean- Override the active flag on the copy: true or false. Leave it out to use Vibe's default for the copy.
budgetinteger- Budget in USD as a whole number, 1 or greater, for example 100. Whether it is a daily or overall cap depends on budget_type.
budget_typestring- Budget type, either DAILY or GLOBAL.one of
DAILYGLOBAL campaign_idstring- UUID of a different campaign to place the copy in. Leave it out to duplicate within the strategy's current campaign. Get it from vibe_list_campaigns.
creative_idsarray- UUIDs of the creatives to attach to the strategy, for example from vibe_list_creatives. Leave it out to use Vibe's default for the copy.
ends_atstring- End date and time for the copy as an ISO 8601 date-time, for example 2026-12-01T00:00:00Z. Leave it out to use Vibe's default for the copy.
namestring- Name of the strategy, 3 to 100 characters, for example Primetime US Households.
starts_atstring- Start date and time of the strategy as an ISO 8601 date-time, for example 2026-11-01T00:00:00Z.
targetingobject- Targeting settings for the strategy as an object; include only the groups you want to set. Location targeting (geo) takes include and exclude lists of location ids for regions, cities, metro codes and zip codes, for example ids returned by vibe_search_geolocations. Inventory takes a type (APPS_AND_CHANNELS or LIVE_SPORTS) plus include and exclude lists of channel ids, for example from vibe_list_channels. The age_ranges list accepts RANGE_18_20, RANGE_21_24, RANGE_25_34, RANGE_35_44, RANGE_45_54, RANGE_55_64 and RANGE_65_MORE; genders accepts MALE and FEMALE; devices accepts TV, TABLET and MOBILE. Interests is a list of interest ids, for example from vibe_list_interest_segments. Audiences are set under an upload entry with include and exclude lists of audience UUIDs, for example from vibe_list_audiences. Dayparting takes a preset (CUSTOM, ANY_TIME_ANY_DAY, PRIMETIME, AFTER_WORK, WORK_HOURS, SLEEPING_TIME, WEEKEND or WORK_DAYS); with CUSTOM, add custom_ranges as start and end pairs in minutes from midnight Monday (0 to 10079). Example: {"geo": {"regions": {"include": ["USA/NY"]}}, "devices": ["TV"], "age_ranges": ["RANGE_25_34"], "dayparting": {"preset": "PRIMETIME"}}.
vibe_replace_strategy_creativesReplace the full set of creatives attached to a Vibe strategy with the creative ids you provide, in one atomic call.WriteReplace Strategy Creatives
Replace the full set of creatives attached to a Vibe strategy with the creative ids you provide, in one atomic call. Returns the strategy's resulting creatives (id, advertiser_id, name, type, asset_url, vast_tag_url, approval_status, approval_details, timestamps) with total, limit and offset. Use this to swap or reset a strategy's creatives; use vibe_update_strategy to change other strategy fields and vibe_list_strategy_creatives to read the current attachments first. Every creative must belong to the strategy's advertiser or Vibe rejects the request. Requires the campaigns:write OAuth scope, a strategy id from vibe_list_strategies and creative ids from vibe_list_creatives.
- Idempotent
Inputs
creative_idsarrayrequired- Full list of creative UUIDs to attach, up to 5000. Replaces any current attachments, so include every creative you want to keep. Get ids from vibe_list_creatives.
strategy_idstringrequired- UUID of the Vibe strategy to replace the creatives of. Get it from vibe_list_strategies, or from the id returned by vibe_create_strategy.
vibe_strategy_actionPerform a lifecycle action on a Vibe strategy: PAUSE or ACTIVATE its delivery.WriteStrategy Action
Perform a lifecycle action on a Vibe strategy: PAUSE or ACTIVATE its delivery. Returns the updated strategy (id, campaign_id, name, budget, budget_type, starts_at, ends_at, active, review state, targeting, creative_ids, timestamps). Use this to toggle delivery for one strategy; publishing the parent campaign does not change a strategy's active state. To edit budget, schedule or targeting use vibe_update_strategy. Requires the campaigns:write OAuth scope and a strategy id from vibe_list_strategies.
Inputs
actionstringrequired- Lifecycle action to perform on the strategy: PAUSE or ACTIVATE.one of
PAUSEACTIVATE strategy_idstringrequired- UUID of the Vibe strategy to pause or activate. Get it from vibe_list_strategies, or from the id returned by vibe_create_strategy.
vibe_update_campaignUpdate a Vibe campaign's name, goal, attribution window, optimization goal, or active flag; send only the fields to change.WriteUpdate Campaign
Update a Vibe campaign's name, goal, attribution window, optimization goal, or active flag; send only the fields to change. Returns the updated campaign. While the campaign is DRAFT you can change name, goal, attribution_window, and optimization_goal; after it is published only active can change, so create a new campaign for anything else. Use this to edit settings; for lifecycle transitions (PUBLISH, PAUSE, ACTIVATE) use vibe_campaign_action. Requires the campaigns:write scope.
- Idempotent
Inputs
campaign_idstringrequired- UUID of the campaign to update. Get it from vibe_list_campaigns or from the id returned when the campaign was created. Example: 5f2b8e1a-3c4d-4e6f-9a7b-1c2d3e4f5a6b.
activeboolean- Set to true or false to switch the campaign's active flag. This is the only field that can still be changed after the campaign is published. Leave unset to keep the current value.
attribution_windowstring- New attribution window. One of TWELVE_HOURS, ONE_DAY, FORTY_EIGHT_HOURS, SEVENTY_TWO_HOURS, SEVEN_DAYS, or THIRTY_DAYS. Only changeable while the campaign is DRAFT. Leave unset to keep the current value.one of
TWELVE_HOURSONE_DAYFORTY_EIGHT_HOURSSEVENTY_TWO_HOURSSEVEN_DAYSTHIRTY_DAYS goalstring- Campaign goal. One of AWARENESS, INSTALL, TRAFFIC, RETARGETING, SALES, LEADS, or ABM. Only changeable while the campaign is DRAFT. Leave unset to keep the current goal.one of
AWARENESSINSTALLTRAFFICRETARGETINGSALESLEADSABM namestring- Campaign name, 10 to 100 characters. Example: Spring CTV Awareness 2026. Only changeable while the campaign is DRAFT. Leave unset to keep the current name.
optimization_goalobject- New optimization goal for the campaign, as an object with a type and a target value. The type is one of COST_PER_SESSION, COST_PER_LEAD, COST_PER_CALL, COST_PER_PURCHASE, ROAS, CPM, COST_PER_INSTALL, COST_PER_UNIQUE_HOUSEHOLD, or COST_PER_UNIQUE_COMPANY. The value is the target in USD, at least 1, with at most 2 decimal places. If you include this object both fields are required; leave it out to keep the current goal. Example: {"type": "COST_PER_SESSION", "value": 2.5}.
vibe_update_strategyUpdate an existing Vibe strategy: rename it or change its budget, schedule, active flag, targeting or attached creatives.WriteUpdate Strategy
Update an existing Vibe strategy: rename it or change its budget, schedule, active flag, targeting or attached creatives. Send only the fields you want to change. Returns the updated strategy (id, campaign_id, name, budget, budget_type, starts_at, ends_at, active, review state, targeting, creative_ids, timestamps). Use this for field edits; use vibe_strategy_action to PAUSE or ACTIVATE delivery, and vibe_replace_strategy_creatives to swap the full set of attached creatives in one call. Requires the campaigns:write OAuth scope and a strategy id from vibe_list_strategies.
- Idempotent
Inputs
strategy_idstringrequired- UUID of the Vibe strategy to update. Get it from vibe_list_strategies, or from the id returned by vibe_create_strategy.
activeboolean- Set the strategy's active flag: true or false. Leave it out to keep the current value. To toggle delivery you can also use vibe_strategy_action.
budgetinteger- Budget in USD as a whole number, 1 or greater, for example 100. Whether it is a daily or overall cap depends on budget_type.
budget_typestring- Budget type, either DAILY or GLOBAL.one of
DAILYGLOBAL creative_idsarray- UUIDs of the creatives to attach to the strategy, for example from vibe_list_creatives. Leave it out to keep the current creatives. To swap the full set in one call, vibe_replace_strategy_creatives is the dedicated tool.
ends_atstring- End date and time of the strategy as an ISO 8601 date-time, for example 2026-12-01T00:00:00Z. Leave it out to keep the current value; this tool cannot clear an existing end date.
namestring- Name of the strategy, 3 to 100 characters, for example Primetime US Households.
starts_atstring- Start date and time of the strategy as an ISO 8601 date-time, for example 2026-11-01T00:00:00Z. Leave it out to keep the current value.
targetingobject- Targeting settings for the strategy as an object; include only the groups you want to set. Location targeting (geo) takes include and exclude lists of location ids for regions, cities, metro codes and zip codes, for example ids returned by vibe_search_geolocations. Inventory takes a type (APPS_AND_CHANNELS or LIVE_SPORTS) plus include and exclude lists of channel ids, for example from vibe_list_channels. The age_ranges list accepts RANGE_18_20, RANGE_21_24, RANGE_25_34, RANGE_35_44, RANGE_45_54, RANGE_55_64 and RANGE_65_MORE; genders accepts MALE and FEMALE; devices accepts TV, TABLET and MOBILE. Interests is a list of interest ids, for example from vibe_list_interest_segments. Audiences are set under an upload entry with include and exclude lists of audience UUIDs, for example from vibe_list_audiences. Dayparting takes a preset (CUSTOM, ANY_TIME_ANY_DAY, PRIMETIME, AFTER_WORK, WORK_HOURS, SLEEPING_TIME, WEEKEND or WORK_DAYS); with CUSTOM, add custom_ranges as start and end pairs in minutes from midnight Monday (0 to 10079). Example: {"geo": {"regions": {"include": ["USA/NY"]}}, "devices": ["TV"], "age_ranges": ["RANGE_25_34"], "dayparting": {"preset": "PRIMETIME"}}. The Vibe reference does not say whether a targeting object you send is merged into or replaces the current one, so send the complete targeting you want. Leave it out to keep the current targeting.
vibe_delete_campaignDelete a Vibe campaign that is still in DRAFT.DestructiveDelete Campaign
Delete a Vibe campaign that is still in DRAFT. Returns no content on success (HTTP 204). Only DRAFT campaigns can be deleted; a campaign that has been published can no longer be deleted, and the API answers 422. Use this to discard an unpublished campaign; to stop a published campaign delivering, use vibe_campaign_action with PAUSE. Requires the campaigns:write scope.
- Idempotent
Inputs
campaign_idstringrequired- UUID of the campaign to delete. Get it from vibe_list_campaigns or from the id returned when the campaign was created. Example: 5f2b8e1a-3c4d-4e6f-9a7b-1c2d3e4f5a6b.
vibe_delete_creativeDelete a Vibe creative by id.DestructiveDelete Creative
Delete a Vibe creative by id. A creative that is used in a published campaign cannot be deleted; Vibe rejects the request. Returns no content on success (HTTP 204). Use this to remove an unused creative; to stop a strategy from using a creative without deleting it, use vibe_replace_strategy_creatives instead. Requires the creatives:write OAuth scope and a creative id from vibe_list_creatives.
- Idempotent
Inputs
creative_idstringrequired- UUID of the Vibe creative to delete. Get it from vibe_list_creatives, vibe_list_strategy_creatives or vibe_list_campaign_creatives.
vibe_delete_strategyDelete a Vibe strategy by id.DestructiveDelete Strategy
Delete a Vibe strategy by id. A strategy can only be deleted while its parent campaign is still in DRAFT status; otherwise Vibe rejects the request. Returns no content on success (HTTP 204). Use this to remove a strategy from a draft campaign; to stop delivery on a live campaign, use vibe_strategy_action with PAUSE instead. Requires the campaigns:write OAuth scope and a strategy id from vibe_list_strategies.
- Idempotent
Inputs
strategy_idstringrequired- UUID of the Vibe strategy to delete. Get it from vibe_list_strategies, or from the id returned by vibe_create_strategy.
vibe_publish_campaignPublish a DRAFT Vibe campaign so it starts delivering and spending budget.DestructivePublish Campaign
Publish a DRAFT Vibe campaign so it starts delivering and spending budget. Returns the published campaign. Publishing is irreversible: afterwards the campaign can no longer be deleted and only its active flag can be changed, though PAUSE can stop delivery. Invalid state transitions return 422. Use this to take a draft live; to pause or reactivate a published campaign, use vibe_campaign_action. Requires the campaigns:publish scope, which is separate from campaigns:write.
Inputs
campaign_idstringrequired- UUID of the campaign to publish. Get it from vibe_list_campaigns or from the id returned when the campaign was created. Example: 5f2b8e1a-3c4d-4e6f-9a7b-1c2d3e4f5a6b.
No tools match.