---
canonical_url: "https://docs.composio.dev/toolkits/admakeai"
markdown_url: "https://docs.composio.dev/toolkits/admakeai.md"
product: "platform"
version: null
last_updated: null
---

# AdMakeAI

AdMakeAI's full REST API covers account and project management, brand and competitor research, image, copy, ad-set and video generation, uploads, and connected Meta campaign and analytics workflows. Video, commercial-use, and Meta operations require a paid AdMakeAI plan; Meta operations also require a Facebook/Meta account connected inside AdMakeAI.

- **Category:** artificial intelligence
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 60
- **Triggers:** 0
- **Slug:** `ADMAKEAI`
- **Version:** 00000000_00

## Tools

### Add Competitors

**Slug:** `ADMAKEAI_ADD_COMPETITORS`

Persist competitors on a project and, by default, start asynchronous ad scraping for them. The connector exposes no delete or cleanup operation for the created competitor records or scrape effects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project that will persist the competitor records. |
| `scrape_ads` | boolean | No | Whether to start asynchronous ad scraping for the added competitors. |
| `competitors` | array | Yes | One or more competitors to add permanently to the project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Ad Set

**Slug:** `ADMAKEAI_CREATE_AD_SET`

Create and persist an ad-set configuration from a project, shared creative brief, format, quality, aspect ratio, references, and optional copy guidance. This write is free, but the saved quality determines future batch-generation cost: 2 credits per image for low, 8 for high, or 20 for ultra. AdMakeAI documents no ad-set deletion endpoint, so this resource cannot be cleaned up through the API. Obtain confirmation before creating it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Human-readable name for the ad set. |
| `ad_type` | string ("product_showcase" | "promotional" | "testimonial" | "lifestyle" | "comparison" | "announcement") | Yes | Ad format used for every variation in the set. |
| `quality` | string ("low" | "high" | "ultra") | No | Quality saved on the ad set. Creating the set is free, but later batch generation costs 2 credits per image for low, 8 for high, or 20 for ultra. |
| `project_id` | string | Yes | Project ID whose brand context the ad set uses. |
| `aspect_ratio` | string ("1:1" | "4:5" | "9:16" | "16:9") | No | Output aspect ratio saved for generated variations. |
| `ad_copy_instructions` | string | No | Optional copy guidance, up to 1000 characters. |
| `general_instructions` | string | Yes | Shared creative brief applied to every variation in the ad set. |
| `additional_image_urls` | array | No | Up to three reference image URLs shared across variations. |
| `ad_copy_messaging_style` | string ("auto" | "clickbait" | "professional" | "controversial" | "oneliners" | "ugc" | "directResponse" | "storytelling") | No | Messaging style saved for copy associated with generated variations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create First Project

**Slug:** `ADMAKEAI_CREATE_FIRST_PROJECT`

Create the connected account's first brand project by analyzing a user-supplied website URL. Call List Projects first and use this action only when it returns no projects. The operation takes about 10-15 seconds, persists the project and generated brand brief, and cannot be cleaned up through the API because AdMakeAI documents no project deletion endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `website_url` | string | Yes | The brand website URL supplied by the user. Never infer or guess it. This action analyzes the site and permanently creates the account's first project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Meta Draft Campaign

**Slug:** `ADMAKEAI_CREATE_META_DRAFT_CAMPAIGN`

Create real Meta campaign, ad-set, and ad objects from explicit campaign data, copy, and externally hosted image or video URLs. All objects land paused. Obtain explicit user confirmation immediately before calling. Nothing launches or spends until the user acts in Meta Ads Manager. Requires a paid AdMakeAI plan and a Facebook/Meta account connected inside AdMakeAI.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ad_sets` | array | Yes | One to 50 real paused Meta ad sets and their ads to create only after explicit user confirmation. |
| `page_id` | string | No | Optional Facebook page ID. |
| `campaign` | object | Yes | Real paused Meta campaign to create only after explicit user confirmation immediately before this call. |
| `ad_account_id` | string | Yes | Meta ad-account ID where the confirmed paused objects will be created. |
| `connection_id` | string | Yes | AdMakeAI Facebook connection ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Design An Ad

**Slug:** `ADMAKEAI_DESIGN_AD`

Queue a persistent finished-ad render. AdMakeAI rewrites the creative brief using the project's brand context and adds a headline, subline, CTA, and logo when available; use Render Image From Exact Prompt when those additions are unwanted. This operation spends credits, but the official API does not publish the amount. Results persist and the connector exposes no delete operation. Obtain confirmation before calling, then poll with Get Image Generation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `prompt` | string | Yes | Creative brief that AdMakeAI rewrites into the image prompt. |
| `ad_type` | string ("product_showcase" | "promotional" | "testimonial" | "lifestyle" | "comparison" | "announcement") | No | Finished-ad format. |
| `quality` | string ("low" | "high" | "ultra") | No | Render tier: low (Fast), high (Sharp), or ultra (Max). |
| `ad_set_id` | string | No | Ad-set ID to associate with the generation. |
| `project_id` | string | Yes | Project ID whose brand brief and logo guide the finished ad. |
| `aspect_ratio` | string ("1:1" | "4:5" | "9:16" | "16:9") | No | Output image aspect ratio. |
| `input_image_id` | string | No | Previously uploaded image ID to use as input. |
| `reference_ad_id` | string | No | Existing generated-ad ID to remix. |
| `reference_image_urls` | array | No | Up to four reference image URLs. |
| `reference_inspiration_id` | string | No | Saved-inspiration ID to remix. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Ad Image

**Slug:** `ADMAKEAI_EDIT_AD_IMAGE`

Queue a persistent image-to-image edit from a generated-ad ID or direct image URL. This operation spends credits, but the official API does not publish the amount. Results persist and the connector exposes no delete operation. Obtain confirmation before calling, then poll with Get Image Generation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `quality` | string ("low" | "high" | "ultra") | No | Render quality tier. |
| `project_id` | string | No | Optional project ID for the edit. |
| `aspect_ratio` | string ("1:1" | "4:5" | "9:16" | "16:9") | No | Optional output aspect ratio. |
| `source_ad_id` | string | No | ID of one of the account's generated ads to edit. |
| `source_image_url` | string | No | Direct URL of an image to edit. |
| `edit_instructions` | string | Yes | Instructions describing the requested image changes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Ad Copy

**Slug:** `ADMAKEAI_GENERATE_AD_COPY`

Generate 1-5 Facebook or Instagram copy variations for a completed ad image, including the provider's headline, primary text, description, call to action, hook angle, and identifiers. AdMakeAI's official API does not publish the credit cost for this operation. The generated output is persistent, and AdMakeAI documents no ad-copy deletion endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `image_url` | string | Yes | Direct URL of the completed ad image to write copy for. |
| `project_id` | string | No | Project ID whose brand brief should guide the copy. |
| `messaging_style` | string ("auto" | "clickbait" | "professional" | "controversial" | "oneliners" | "ugc" | "directResponse" | "storytelling") | No | Tone and persuasion style for the generated copy. |
| `variation_count` | number | No | Number of copy variations to return (1-5). |
| `additional_instructions` | string | No | Extra copy constraints or guidance, up to 1000 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Ad Set Batch

**Slug:** `ADMAKEAI_GENERATE_AD_SET_BATCH`

Queue 1, 2, 4, 6, 8, or 15 image variations from an existing ad set. The operation spends count x 2 credits at low quality, count x 8 at high, or count x 20 at ultra, and returns the queued generation data. Each variation is a persistent generation record; AdMakeAI documents no API endpoint for deleting those records. Poll each returned generation ID with Get Image Generation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | string ("1" | "2" | "4" | "6" | "8" | "15") | No | String-valued variation count, defaulting to 4. Total credits by count in low/high/ultra order are: 1 = 2/8/20, 2 = 4/16/40, 4 = 8/32/80, 6 = 12/48/120, 8 = 16/64/160, and 15 = 30/120/300. |
| `quality` | string ("low" | "high" | "ultra") | No | Optional quality override. Low costs 2 credits per variation, high costs 8, and ultra costs 20; omit it to use the ad set's saved quality. |
| `ad_set_id` | string | Yes | Ad-set ID returned by Create Ad Set. |
| `specific_instructions` | string | No | Additional creative direction applied to this batch of variations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Render Image From Exact Prompt

**Slug:** `ADMAKEAI_GENERATE_IMAGE`

Queue a persistent image render from the prompt exactly as written, without a creative-director rewrite, brand brief, added copy, CTA, or logo. Use Design Ad instead for a finished brand-directed ad. This operation spends credits; the official API does not publish the amount. Results persist and the connector exposes no delete operation. Obtain confirmation before calling, then poll the returned generation ID with Get Image Generation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `prompt` | string | Yes | Verbatim image prompt. AdMakeAI does not rewrite it or add brand copy. |
| `quality` | string ("low" | "high" | "ultra") | No | Render tier: low (Fast), high (Sharp), or ultra (Max). |
| `project_id` | string | Yes | Project ID used only to scope credits; its brand brief is not used. |
| `aspect_ratio` | string ("1:1" | "4:5" | "9:16" | "16:9") | No | Output image aspect ratio. |
| `input_image_id` | string | No | Previously uploaded image ID for image-to-image generation. |
| `reference_image_urls` | array | No | Up to four direct image URLs that guide the render. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Profile

**Slug:** `ADMAKEAI_GET_ACCOUNT_PROFILE`

Get the connected AdMakeAI user's profile, plan, and current credit balance.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Competitor Ad

**Slug:** `ADMAKEAI_GET_AD_DETAILS`

Get one scraped competitor ad in full, including provider-returned creative URLs, ad text, headline, run dates, and platform placements.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project that owns the scraped ad. |
| `scraped_ad_id` | string | Yes | Scraped competitor-ad ID to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Ad Set

**Slug:** `ADMAKEAI_GET_AD_SET`

Get one ad set by ID, including its shared creative instructions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ad_set_id` | string | Yes | Ad-set ID to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Advertiser's Live Ads

**Slug:** `ADMAKEAI_GET_COMPANY_ADS`

Get a Facebook page's currently running Meta Ad Library ads by page ID. This works for any advertiser, not only saved competitors.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Provider continuation cursor; omit it for the first page. |
| `country` | string | No | Meta Ad Library country filter or ALL. |
| `page_id` | string | Yes | Facebook advertiser page ID returned by Find Advertiser Page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Preview Competitor Ads

**Slug:** `ADMAKEAI_GET_COMPETITOR_PREVIEW`

Preview the ads already scraped for one persisted competitor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `competitor_id` | string | Yes | Competitor ID whose already-scraped ads should be previewed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Credit Balance

**Slug:** `ADMAKEAI_GET_CREDIT_BALANCE`

Get the connected AdMakeAI user's current credit balance.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Image Generation

**Slug:** `ADMAKEAI_GET_IMAGE_GENERATION`

Get one image generation's status, prompt, and result URLs by ID; call repeatedly until status is COMPLETED or a terminal failure is returned.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `generation_id` | string | Yes | Generation ID returned by Generate Image or Generate Ad Set Batch. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Ad Account Overview

**Slug:** `ADMAKEAI_GET_META_ACCOUNT_OVERVIEW`

Read total Meta ad-account spend, impressions, clicks, CTR, CPC, conversions, and ROAS for a date range, optionally with previous-period comparison. Requires a paid AdMakeAI plan and a Facebook/Meta account connected inside AdMakeAI.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to_date` | string | No | Optional end date in YYYY-MM-DD format. |
| `from_date` | string | No | Optional start date in YYYY-MM-DD format. |
| `date_preset` | string ("last_7_days" | "last_14_days" | "last_30_days" | "last_90_days" | "this_month" | "last_month") | No | Optional documented reporting-period preset. |
| `ad_account_id` | string | No | Optional Meta ad-account ID. |
| `connection_id` | string | Yes | AdMakeAI Facebook connection ID. |
| `compare_to_previous` | boolean | No | Whether to include comparison with the previous period. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Meta Ad

**Slug:** `ADMAKEAI_GET_META_AD`

Read one Meta ad's metadata and creative without changing it. Requires a paid AdMakeAI plan and a Facebook/Meta account connected inside AdMakeAI.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ad_id` | string | Yes | Meta ad ID to read. |
| `connection_id` | string | Yes | AdMakeAI Facebook connection ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Ad Daily Analytics

**Slug:** `ADMAKEAI_GET_META_AD_ANALYTICS`

Read day-by-day spend, CTR, CPC, conversions, and other preserved analytics for one Meta ad. Requires a paid AdMakeAI plan and a Facebook/Meta account connected inside AdMakeAI.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ad_id` | string | Yes | Meta ad ID whose daily analytics should be read. |
| `to_date` | string | No | Optional end date in YYYY-MM-DD format. |
| `from_date` | string | No | Optional start date in YYYY-MM-DD format. |
| `breakdowns` | array | No | Optional provider breakdown names; the OpenAPI does not constrain their values. |
| `connection_id` | string | Yes | AdMakeAI Facebook connection ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Ad Comments

**Slug:** `ADMAKEAI_GET_META_AD_COMMENTS`

Read one page of public comments on the Facebook or Instagram post behind a Meta ad. Pass only a continuation cursor actually returned by the provider. Requires a paid AdMakeAI plan and a Facebook/Meta account connected inside AdMakeAI.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ad_id` | string | Yes | Meta ad ID whose public comments should be read. |
| `limit` | integer | No | Optional page size from 1 through 100. |
| `cursor` | string | No | Opaque continuation cursor returned by the provider. |
| `placement` | string ("facebook" | "instagram") | No | Optional Facebook or Instagram placement filter. |
| `connection_id` | string | Yes | AdMakeAI Facebook connection ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Draft

**Slug:** `ADMAKEAI_GET_META_CAMPAIGN_DRAFT`

Read a saved agent-created Facebook campaign draft before pushing it. This read requires a paid AdMakeAI plan and a Facebook/Meta account connected inside AdMakeAI; those are provider-side prerequisites.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `draft_id` | string | Yes | Saved agent-created campaign draft ID to inspect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Structure

**Slug:** `ADMAKEAI_GET_META_CAMPAIGN_TREE`

Read the Meta campaign, ad-set, and ad hierarchy for an ad account. Advance page only when the preserved provider payload indicates more results. Requires a paid AdMakeAI plan and a Facebook/Meta account connected inside AdMakeAI.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Optional one-based result page. |
| `sort` | string ("newest" | "oldest" | "spend_desc" | "spend_asc") | No | Optional result ordering. |
| `limit` | integer | No | Optional page size from 1 through 100. |
| `status` | string ("active" | "paused" | "pending_review" | "rejected" | "completed" | "cancelled" | "error") | No | Optional documented Meta delivery-status filter. |
| `to_date` | string | No | Optional end date in YYYY-MM-DD format. |
| `from_date` | string | No | Optional start date in YYYY-MM-DD format. |
| `ad_account_id` | string | No | Optional Meta ad-account ID. |
| `connection_id` | string | Yes | AdMakeAI Facebook connection ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Performance Timeline

**Slug:** `ADMAKEAI_GET_META_PERFORMANCE_TIMELINE`

Read time-series performance metrics for a Meta ad account. Requires a paid AdMakeAI plan and a Facebook/Meta account connected inside AdMakeAI.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to_date` | string | No | Optional end date in YYYY-MM-DD format. |
| `from_date` | string | No | Optional start date in YYYY-MM-DD format. |
| `ad_account_id` | string | No | Optional Meta ad-account ID. |
| `connection_id` | string | Yes | AdMakeAI Facebook connection ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Meta upload

**Slug:** `ADMAKEAI_GET_META_UPLOAD`

Get one uploaded ad's current upload state and Meta IDs. Requires a paid AdMakeAI plan and a Facebook/Meta account connected inside AdMakeAI; these are provider-side prerequisites, not additional credentials.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uploadedAdId` | string | Yes | AdMakeAI uploaded-ad ID to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project Brief

**Slug:** `ADMAKEAI_GET_PROJECT`

Get one project with its complete brand brief, competitors, research jobs, and scraped-ad counts before generating brand-matched creative.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID returned by List Projects. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Research Status

**Slug:** `ADMAKEAI_GET_RESEARCH_STATUS`

Poll a project's research pipeline stage, running asynchronous scrape jobs, competitor count, and saved-ad count.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID whose research pipeline should be polled. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Video Generation Status

**Slug:** `ADMAKEAI_GET_VIDEO_GENERATION_STATUS`

Poll one persistent video generation until status is COMPLETED or a terminal failure, returning its untyped status and output data. The underlying video requires an active paid AdMakeAI subscription and cost 5/15/50 credits at low/medium/high quality when queued. This read spends no credits and creates nothing; AdMakeAI exposes no video-generation delete operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `generation_id` | string | Yes | Video-generation ID returned by Create UGC Video Ad. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Ad Copy Styles

**Slug:** `ADMAKEAI_LIST_AD_COPY_STYLES`

List the messaging styles accepted by Generate Ad Copy, including professional, UGC, direct-response, and storytelling styles.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Ads

**Slug:** `ADMAKEAI_LIST_ADS`

List the account's persistent ad generations newest first, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | Maximum ads in this page. |
| `cursor` | string | No | Continuation cursor returned by the provider; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Ads In Ad Set

**Slug:** `ADMAKEAI_LIST_AD_SET_GENERATIONS`

Return one page of image generations belonging to an ad set, optionally filtered by like or download state. Advance page only when the preserved provider payload indicates more results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | number | No | One-based results page to return. |
| `filter` | string ("all" | "liked" | "downloaded" | "not_downloaded") | No | Filter generations by like or download state. |
| `per_page` | number | No | Number of generations per page, from 1 to 100. |
| `ad_set_id` | string | Yes | Ad-set ID whose generated ads should be listed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Ad Sets

**Slug:** `ADMAKEAI_LIST_AD_SETS`

Return one page of the connected account's ad sets. Advance the one-based page value only when the preserved provider payload indicates more results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | number | No | One-based results page to return. |
| `per_page` | number | No | Number of ad sets to return per page, from 1 through 50. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Facebook connections

**Slug:** `ADMAKEAI_LIST_FACEBOOK_CONNECTIONS`

List connected Facebook ad accounts and Pages with cached identity details. Requires a paid AdMakeAI plan and a Facebook/Meta account connected inside AdMakeAI; these are provider-side prerequisites, not additional credentials.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Ad Performance

**Slug:** `ADMAKEAI_LIST_META_AD_PERFORMANCE`

Read Meta ads, optionally under a campaign, with performance metrics. Advance page only when the preserved provider payload indicates more results. Requires a paid AdMakeAI plan and a Facebook/Meta account connected inside AdMakeAI.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Optional one-based page. |
| `sort` | string ("newest" | "oldest" | "spend_desc" | "spend_asc") | No | Optional result ordering. |
| `limit` | integer | No | Optional page size from 1 through 100. |
| `status` | string ("active" | "paused" | "pending_review" | "rejected" | "completed" | "cancelled" | "error") | No | Optional documented delivery-status filter. |
| `campaign_id` | string | No | Optional Meta campaign ID filter. |
| `ad_account_id` | string | No | Optional Meta ad-account ID. |
| `connection_id` | string | Yes | AdMakeAI Facebook connection ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List campaign ad sets

**Slug:** `ADMAKEAI_LIST_META_AD_SETS`

List Meta ad sets under a campaign. Requires a paid AdMakeAI plan and a Facebook/Meta account connected inside AdMakeAI; these are provider-side prerequisites, not additional credentials.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `refresh` | boolean | No | Whether to refresh ad sets from Meta instead of using cache. |
| `adAccountId` | string | Yes | Connected Meta ad-account ID. |
| `fbCampaignId` | string | Yes | Meta campaign ID whose ad sets to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Campaign Performance

**Slug:** `ADMAKEAI_LIST_META_CAMPAIGN_PERFORMANCE`

Read Meta campaigns with rolled-up performance metrics. Advance page only when the preserved provider payload indicates more results. Requires a paid AdMakeAI plan and a Facebook/Meta account connected inside AdMakeAI.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Optional one-based page. |
| `sort` | string ("newest" | "oldest" | "spend_desc" | "spend_asc") | No | Optional result ordering. |
| `limit` | integer | No | Optional page size from 1 through 100. |
| `status` | string ("active" | "paused" | "pending_review" | "rejected" | "completed" | "cancelled" | "error") | No | Optional documented delivery-status filter. |
| `to_date` | string | No | Optional end date in YYYY-MM-DD format. |
| `from_date` | string | No | Optional start date in YYYY-MM-DD format. |
| `ad_account_id` | string | No | Optional Meta ad-account ID. |
| `connection_id` | string | Yes | AdMakeAI Facebook connection ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List ad account campaigns

**Slug:** `ADMAKEAI_LIST_META_CAMPAIGNS`

List Meta campaigns for a connected ad account, refreshing from Meta when requested. Requires a paid AdMakeAI plan and a Facebook/Meta account connected inside AdMakeAI; these are provider-side prerequisites, not additional credentials.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `refresh` | boolean | No | Whether to refresh campaigns from Meta instead of using cache. |
| `adAccountId` | string | Yes | Connected Meta ad-account ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Meta uploads

**Slug:** `ADMAKEAI_LIST_META_UPLOADS`

List previously uploaded Meta ads, optionally filtered by account, generation, state, or search text. Pass a provider-returned cursor to continue. Requires a paid AdMakeAI plan and a Facebook/Meta account connected inside AdMakeAI; these are provider-side prerequisites, not additional credentials.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum uploads to return. |
| `cursor` | string | No | Provider continuation cursor. |
| `search` | string | No | Upload search text. |
| `adAccountId` | string | No | Meta ad-account filter. |
| `uploadState` | string ("QUEUED" | "PREFLIGHT_FAILED" | "READINESS_FAILED" | "IMAGE_UPLOADING" | "IMAGE_UPLOAD_FAILED" | "CREATIVE_CREATING" | "CREATIVE_FAILED" | "AD_CREATING" | "AD_CREATE_FAILED" | "UPLOADED_PAUSED" | "META_REJECTED" | "USER_DELETED") | No | Upload-state filter. |
| `adGenerationId` | string | No | AdMakeAI generation filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Pending Ads

**Slug:** `ADMAKEAI_LIST_PENDING_ADS`

List the account's currently pending persistent ad generations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ad_set_id` | string | No | Optional ad-set ID used to filter pending generations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Pending Videos

**Slug:** `ADMAKEAI_LIST_PENDING_VIDEO_GENERATIONS`

List currently rendering persistent video generations, optionally by video set. Video resources require an active paid AdMakeAI subscription and cost 5/15/50 credits per low/medium/high video when queued; this read spends no credits. AdMakeAI exposes no video-generation delete operation. Poll each ID with Get Video Generation Status until COMPLETED or a terminal failure.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `video_set_id` | string | No | Optional video-set ID used to narrow pending videos. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Project Assets

**Slug:** `ADMAKEAI_LIST_PROJECT_ASSETS`

List a project's stored product photos and logos with their IDs and URLs for use as image-generation references.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID whose stored brand assets should be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Projects

**Slug:** `ADMAKEAI_LIST_PROJECTS`

List the user's brand projects. Call this before generation to obtain a project ID; if no projects exist, ask for the brand website before creating one.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | Maximum projects to return in this page (1-50). |
| `cursor` | string | No | Provider continuation cursor; omit it for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Recent Ads

**Slug:** `ADMAKEAI_LIST_RECENT_ADS`

Get up to 20 of the account's most recent persistent ad generations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | Maximum recent ads to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reusable Meta Creatives

**Slug:** `ADMAKEAI_LIST_REUSABLE_META_CREATIVES`

Resolve previously uploaded Meta ads into reusable creative assets for a campaign draft. This read requires a paid AdMakeAI plan and a Facebook/Meta account connected inside AdMakeAI; those are provider-side prerequisites.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ad_account_id` | string | Yes | Meta ad-account ID owned by the connection. |
| `connection_id` | string | Yes | AdMakeAI Facebook connection ID. |
| `zernio_ad_ids` | array | No | Up to 100 AdMakeAI ad IDs to resolve; every ID must be non-empty. |
| `platform_ad_ids` | array | No | Up to 100 Meta platform ad IDs to resolve; every ID must be non-empty. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Saved Inspirations

**Slug:** `ADMAKEAI_LIST_SAVED_INSPIRATIONS`

List competitor ads saved as inspiration, optionally for one project, with limit and offset pagination. Advance offset by the returned page length.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | Maximum inspirations to return (1-50). |
| `offset` | number | No | Zero-based result offset; advance it by the returned page length. |
| `project_id` | string | No | Optional project ID filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Browse Competitor Ads

**Slug:** `ADMAKEAI_LIST_SCRAPED_ADS`

Browse competitor ads scraped into a project with media, keyword, relevance, sorting, limit, and offset controls. Advance offset by the returned page length.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | Maximum ads to return (1-100). |
| `offset` | number | No | Zero-based result offset; advance it by the returned page length. |
| `search` | string | No | Optional provider search expression. |
| `sort_by` | string ("relevance" | "newest" | "oldest" | "longest_running" | "popularity" | "recently_added") | No | Ordering for this page of scraped ads. |
| `media_type` | string ("IMAGE" | "VIDEO" | "CAROUSEL" | "ALL") | No | Optional creative media-type filter. |
| `project_id` | string | Yes | Project whose scraped competitor ads should be browsed. |
| `search_term` | string | No | Optional keyword search term. |
| `competitor_id` | string | No | Optional competitor ID filter. |
| `show_irrelevant` | boolean | No | Whether to include ads marked irrelevant. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Uploaded Images

**Slug:** `ADMAKEAI_LIST_UPLOADED_IMAGES`

List one page of the connected user's persistent uploaded source images, newest first. Pass the provider's returned nextCursor as cursor to continue.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | Maximum uploaded images to return on this page (1-100). |
| `cursor` | string | No | Provider cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Video Ads

**Slug:** `ADMAKEAI_LIST_VIDEO_GENERATIONS`

Return one page of completed persistent UGC video ads. Video resources require an active paid AdMakeAI subscription and cost 5/15/50 credits per low/medium/high video when queued; this list read spends no credits. AdMakeAI exposes no video-generation delete operation. Use Get Video Generation Status to poll a known generation, and advance page only when the payload indicates more.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | number | No | One-based results page to return. |
| `filter` | string ("all" | "liked" | "downloaded") | No | Filter completed videos by like or download state. |
| `per_page` | number | No | Number of videos per page, from 1 through 50. |
| `project_id` | string | No | Optional project ID used to narrow completed videos. |
| `video_set_id` | string | No | Optional video-set ID used to narrow completed videos. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Push Campaign Draft to Meta

**Slug:** `ADMAKEAI_PUSH_META_CAMPAIGN_DRAFT`

Push a saved campaign draft to Meta, creating real campaign, ad-set, and ad objects in paused state. Obtain explicit user confirmation immediately before calling. Nothing launches or spends until the user acts in Meta Ads Manager. Requires a paid AdMakeAI plan and a Facebook/Meta account connected inside AdMakeAI; those are provider-side prerequisites.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `draft_id` | string | Yes | Saved draft ID to push. Supply it only after the user explicitly confirms creating the described real, paused Meta campaign objects immediately before this call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload ad to Meta

**Slug:** `ADMAKEAI_REQUEST_META_UPLOAD`

Create a real Meta ad from an AdMakeAI creative. The created Meta objects land paused, but this irreversible external write costs 3 AdMakeAI credits. Obtain the user's explicit confirmation immediately before every call. Nothing launches or spends on Meta until the user acts in Meta Ads Manager. Requires a paid AdMakeAI plan and a Facebook/Meta account connected inside AdMakeAI; these are provider-side prerequisites, not additional credentials. Run the non-creating Meta upload preflight first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `adCopy` | object | Yes | Copy for the Meta ad. |
| `targetPageId` | string | Yes | Target Meta Page ID. |
| `targetAdSetId` | string | Yes | Target Meta ad-set ID. |
| `adGenerationId` | string | Yes | AdMakeAI generation ID to upload. |
| `destinationUrl` | string | Yes | Destination URL for the Meta ad. |
| `templateOverrides` | object | No | Optional Meta campaign, ad-set, creative, and account overrides. |
| `targetInstagramActorId` | string | No | Optional target Instagram actor ID. |
| `confirmedReadinessDismissals` | array | No | Readiness warning identifiers the user explicitly dismissed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check ad before Meta upload

**Slug:** `ADMAKEAI_RUN_META_UPLOAD_PREFLIGHT`

Perform non-creating validation of an ad creative, copy, destination, and target ad set. This preflight does not upload or create a Meta ad. Requires a paid AdMakeAI plan and a Facebook/Meta account connected inside AdMakeAI; these are provider-side prerequisites, not additional credentials.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `adCopy` | object | Yes | Copy to validate for the Meta ad. |
| `targetAdSetId` | string | Yes | Target Meta ad-set ID. |
| `adGenerationId` | string | Yes | AdMakeAI generation ID to validate. |
| `destinationUrl` | string | Yes | Destination URL to validate for the Meta ad. |
| `declareAsAiGenerated` | boolean | No | Whether the ad should be declared as AI-generated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Save Ad as Inspiration

**Slug:** `ADMAKEAI_SAVE_INSPIRATION`

Persist a scraped competitor ad as project inspiration for later remixing. The connector exposes no delete or cleanup operation for the saved inspiration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `action` | string ("COPY_DESIGN" | "TAKE_INSPIRATION" | "AI_GENERATE") | No | Intended use for the saved ad. |
| `project_id` | string | Yes | Project that will persist the inspiration. |
| `user_notes` | string | No | Optional notes to store with the inspiration. |
| `scraped_ad_id` | string | Yes | Scraped competitor-ad ID to save. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Refresh Competitor Ads

**Slug:** `ADMAKEAI_SCRAPE_COMPETITOR`

Start an asynchronous re-scrape of one competitor's live Facebook ads into the project, then poll Get Research Status. Scraped results persist, and the connector exposes no delete or cleanup operation for the job or its effects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `competitor_id` | string | Yes | Persisted competitor ID whose Facebook ads should be refreshed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Ads

**Slug:** `ADMAKEAI_SEARCH_ADS`

Search and page through the connected account's generated-ad history by prompt and favorite/download state, newest matches first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | Maximum ads to return in this page (1-60). |
| `query` | string | No | Prompt text to search; use an empty string to browse all generated ads. |
| `cursor` | number | No | Numeric result offset returned by the provider; use 0 for the first page. |
| `filter` | string ("all" | "liked" | "downloaded" | "not_downloaded") | No | Limit results by favorite or download state. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Find Advertiser Page

**Slug:** `ADMAKEAI_SEARCH_COMPANIES`

Resolve a brand name to Facebook advertiser pages with page IDs, names, categories, and provider-returned follower counts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Brand name to resolve to Facebook advertiser pages. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create UGC Video Ad

**Slug:** `ADMAKEAI_START_VIDEO_GENERATION`

Queue 1-10 persistent UGC-style video-ad jobs. An active paid AdMakeAI subscription is required. Each video costs 5 credits at low quality, 15 at medium, or 50 at high. AdMakeAI exposes no video-generation delete operation. Obtain confirmation before spending credits, then poll each returned ID with Get Video Generation Status until COMPLETED or a terminal failure.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `engine` | string ("hosted" | "minimax") | No | Optional model family; omit for AdMakeAI's hosted default. |
| `quality` | string ("low" | "medium" | "high") | No | Video quality: low costs 5 credits, medium 15, and high 50 per video. |
| `project_id` | string | Yes | Project ID whose brand context should guide the videos. |
| `video_count` | number | No | Number of videos to generate, from 1 through 10. |
| `user_instructions` | string | No | Optional creative instructions for script and render. |
| `starting_frame_url` | string | No | Optional direct URL of a starting video frame. |
| `reference_image_url` | string | No | Optional direct reference-image URL. |
| `generate_starting_frame` | boolean | No | Whether AdMakeAI should generate the starting frame. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Suggest Ad Set Directions

**Slug:** `ADMAKEAI_SUGGEST_AD_SET_DIRECTIONS`

Create distinct model-generated creative angles for an ad set to use as per-variation instructions. This produces persistent provider output, and AdMakeAI documents no API deletion operation; obtain confirmation first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `exclude` | array | No | Up to 12 prior directions to exclude, each at most 600 characters. |
| `ad_set_id` | string | Yes | Ad-set ID for which to suggest creative directions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Toggle Ad Favorite

**Slug:** `ADMAKEAI_TOGGLE_AD_FAVORITE`

Star or unstar one persistent ad generation. This changes provider state, though it does not spend generation credits. Obtain confirmation before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Generated-ad ID to star or unstar. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Ad Set

**Slug:** `ADMAKEAI_UPDATE_AD_SET`

Persist changes to an ad set before generating another batch. Future image generation costs 2 credits per image for low quality, 8 for high, or 20 for ultra. AdMakeAI documents no ad-set deletion endpoint, so obtain confirmation before changing the resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Replacement ad-set name. |
| `ad_type` | string ("product_showcase" | "promotional" | "testimonial" | "lifestyle" | "comparison" | "announcement") | No | Replacement ad format. |
| `quality` | string ("low" | "high" | "ultra") | No | Replacement quality used by future batch generations. |
| `ad_set_id` | string | Yes | Ad-set ID to update. |
| `aspect_ratio` | string ("1:1" | "4:5" | "9:16" | "16:9") | No | Replacement output aspect ratio. |
| `ad_copy_instructions` | string | No | Replacement copy guidance; explicitly pass null to clear it. |
| `general_instructions` | string | No | Replacement shared creative brief. |
| `additional_image_urls` | array | No | Replacement list of up to three reference image URLs. |
| `ad_copy_messaging_style` | string ("auto" | "clickbait" | "professional" | "controversial" | "oneliners" | "ugc" | "directResponse" | "storytelling") | No | Replacement copy messaging style. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Project Brief

**Slug:** `ADMAKEAI_UPDATE_PROJECT_BRIEF`

Update a project's persistent brand brief, including its product summary, target audience, value proposition, industry, and keywords. The changes affect later generations, and AdMakeAI documents no project deletion endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `industry` | string | No | Updated industry, from 1 to 200 characters. |
| `keywords` | array | No | Up to 15 non-empty brand keywords. |
| `project_id` | string | Yes | Project ID whose brand brief should be updated. |
| `product_summary` | string | No | Updated product summary, from 1 to 4000 characters. |
| `target_audience` | string | No | Updated target audience, up to 2000 characters. |
| `value_proposition` | string | No | Updated value proposition, up to 2000 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Image

**Slug:** `ADMAKEAI_UPLOAD_IMAGE`

Upload a base64-encoded JPEG, PNG, or WebP image to persistent AdMakeAI storage and return its image ID and public URL. AdMakeAI documents no uploaded-image deletion endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filename` | string | No | Optional image filename, from 1 to 255 characters. |
| `image_hash` | string | No | Optional provider-compatible image hash. |
| `base64_data` | string | Yes | Non-empty base64-encoded JPEG, PNG, or WebP image data. |
| `content_type` | string | No | Optional image media type, such as image/jpeg, image/png, or image/webp. |
| `turnstile_token` | string | No | Optional provider-issued Turnstile token. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
