Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hyperfx.ai/llms.txt

Use this file to discover all available pages before exploring further.

Auth type: OAuth
For connection guidance and permission management, see: App Integrations.

Connect Meta Marketing API

  1. Go to Settings → Apps in Hyper
  2. Select Meta Marketing API → Connect New
  3. Complete OAuth, select Business/Ad Accounts, and grant requested scopes

Common capabilities

  • Read campaign and ad performance
  • Draft new audiences and creative concepts

Use in Chat

Enable Meta Marketing API and request insights or creative drafts.

Use in Agents

Add to toolkits; require approval for write/publish actions.

Use in Flows

Automate reporting and creative testing.

Troubleshooting

  • Missing ad account: ensure Business Manager access and correct selection
  • Token expired: reauthorize the connection

Available Actions

Hyper agents can run the following actions for this integration. Each action can be individually set to Enabled, Requires Approval, or Disabled in your agent’s toolkit settings. Actions can be set to one of three control states:
StateBehavior
EnabledAgent runs the action automatically
Requires ApprovalAgent pauses and waits for your confirmation before proceeding
DisabledAction is blocked and cannot be used
Configure these in the agent’s toolkit settings or in workspace defaults.
ActionDescription
Ad InsightsGet comprehensive performance insights for any Meta advertising object in a single call
Build Placement SpecBuild a placement targeting snippet (publisher_platforms + *_positions) so that
Create AdCreate a new ad in a Facebook ad set with proper creative validation
Create Ad CreativeCreate a new ad creative for Facebook/Instagram ads
Create Ad LegacyCreate a new ad in a Facebook ad set (legacy individual parameters)
Create Ad SetCreate a Facebook ad set using a unified interface for both Advantage+ and Manual modes
Create Ad Set LegacyCreate a new ad set in a Facebook campaign (legacy individual parameters)
Create Advantage Plus Ad SetCreate an Advantage+ ad set with AI-powered audience expansion
Create CampaignCreate a new campaign in a Facebook Ad Account
Create From BlueprintCreate a full campaign (campaign + ad sets + ads) from a validated blueprint
Create Manual Ad SetCreate a manual ad set with custom targeting and placements
Delete AdDelete a Facebook ad
Delete Ad CreativeDelete a Facebook ad creative
Delete Ad ImageDelete single or multiple uploaded images from a Facebook ad account
Delete Ad SetDelete a Facebook ad set
Delete Ad VideoDelete single or multiple uploaded videos from a Facebook ad account
Delete CampaignDelete a Facebook campaign
Get Account InfoGet detailed information for a single Facebook ad account
Get Ad CreativeGet details of a specific Facebook ad creative
Get Ad DetailsGet detailed fields for a single ad by ad ID
Get Ad ImageGet a single ad image by image hash from an ad account
Get Ad PixelGet a single Meta (Facebook) Pixel by pixel ID
Get Ad PreviewsGenerate previews for Facebook ad creatives across multiple ad formats in a single call
Get Ad SetsGet ad sets for a specific Facebook campaign
Get AdsGet ads for a specific Facebook ad set
Get Adset DetailsGet detailed fields for a single ad set by ad set ID
Get Campaign DetailsGet detailed fields for a single campaign by campaign ID
Get Health Check
Get InsightsGet performance metrics for a Facebook ad object (account, campaign, ad set, or ad)
Get Meta AccountsGet all Facebook Pages (Meta accounts) accessible with the current access token with response filtering support
List Ad AccountsList all Facebook Ad Accounts and associated Pages accessible with the current access token
List Ad CreativesList ad creatives for a Facebook ad account with pagination support
List Ad ImagesList uploaded images for a Facebook ad account with response filtering support
List Ad PixelsList Meta (Facebook) Pixels for a given Ad Account
List Ad VideosList uploaded videos for a Facebook ad account with response filtering support
List Custom AudiencesList custom audiences on an ad account (subtype CUSTOM/WEBSITE/APP/etc.)
List Dataset ConversionsList conversion events configured on an offline dataset
List Instagram AccountsList Instagram accounts connected to a Facebook ad account
List Lead FormsList lead generation forms for a Facebook Page
List Lookalike AudiencesList lookalike audiences (subtype LOOKALIKE) for an ad account
List Owned PagesList Facebook pages owned by the business associated with an ad account with response filtering support
List Tracking AssetsList Meta pixels and offline datasets available on an ad account
Preview BlueprintPreview and validate a full campaign blueprint BEFORE creating anything on Meta
Replace Ad MediaReplace the media on an existing ad by creating a compliant replacement creative
Run Health CheckRun a health check on all Meta ad accounts, verifying ad account access, page publishing, Instagram linking, pixel data, and catalog capabilities
Search CampaignsSearch for campaigns in a Facebook Ad Account with response filtering support
Search PagesSearch for Facebook Pages by name or keywords
Targeting SearchUnified Targeting Search for Meta Marketing API (/search)
Update AdUpdate an existing Facebook ad
Update Ad CreativeUpdate an existing Facebook ad creative
Update Ad SetUpdate an existing Facebook ad set
Update CampaignUpdate an existing Facebook campaign with new settings
Upload Ad ImageUpload single or multiple images for use in Facebook ad creatives from file IDs or URLs
Upload Ad VideoUpload single or multiple videos for use in Facebook ad creatives from file IDs or URLs
Upload Conversion EventsUpload conversion events to Meta Conversions API for server-side event tracking
Upload Offline EventsUpload offline conversion events to Meta Conversions API