# Plai Api Docs

## Docs

- [Authentication Overview](https://plai-a079b342.mintlify.app/api-reference/endpoint/auth/auth_overview.md): Learn how to connect your ads accounts (Facebook, Linkedin, etc.) to our platform for quick and secure access. This page covers supported providers and the simple steps to link your account.
- [Ad Account Connection](https://plai-a079b342.mintlify.app/api-reference/endpoint/auth/create_advert.md): This endpoint generates a link that allows users to seamlessly connect their Ad accounts for the purpose of creating advertisements.
- [Create User Profile](https://plai-a079b342.mintlify.app/api-reference/endpoint/auth/create_user.md): This endpoint allows the creation of a new user profile on our platform. By providing the necessary user information, you can onboard new users into the system, enabling them to access and utilize platform features and services.
- [Connected Accounts](https://plai-a079b342.mintlify.app/api-reference/endpoint/auth/get_connected_accounts.md): This endpoint allows you to retrieve a list of ads accounts (e.g., Facebook, Instagram, etc.) that are connected to a user's profile on our platform. By specifying the user's unique ID, you can access information about the ads accounts they have linked, enabling you to manage or interact with these…
- [Get User Profile](https://plai-a079b342.mintlify.app/api-reference/endpoint/auth/get_profile.md): This endpoint retrieves the current user's profile using their email address.
- [Campaign Optimization API Overview](https://plai-a079b342.mintlify.app/api-reference/endpoint/campaign_optimization/campaign_optimization_overview.md): Our Campaign Optimization APIs help you reduce costs and improve ad performance by automatically optimizing your audience and creative assets. With intelligent adjustments based on real-time data, we ensure your campaigns consistently drive better results.
- [Deregister Campaign](https://plai-a079b342.mintlify.app/api-reference/endpoint/campaign_optimization/deregister_campaign.md): Use this endpoint when a user decides to stop campaign optimization through the 'Optimize For Me' service. Once deregistered, the system will no longer perform audience or creative optimizations for that campaign.This allows users full control over which campaigns are being optimized and ensures fle…
- [Get Campaign Optimization History](https://plai-a079b342.mintlify.app/api-reference/endpoint/campaign_optimization/get_campaign_optimization_history.md): This endpoint retrieves the full optimization history of a campaign. It includes detailed logs of changes made during both audience and creative optimizations — such as which segments were paused, what assets were updated, and when these changes occurred.
- [Register Campaign](https://plai-a079b342.mintlify.app/api-reference/endpoint/campaign_optimization/register_campaign.md): This endpoint registers a campaign for continuous optimization. Once registered, our system monitors and adjusts both audience and creative segments based on their performance.
- [Check Image Asset Eligibility](https://plai-a079b342.mintlify.app/api-reference/endpoint/google/check_image_asset_eligibility.md): This endpoint checks whether a Google Ads account is eligible to use image assets in search ads. Use this to verify account capabilities before proceeding with campaign setup.
- [Check Lead Form Acceptance](https://plai-a079b342.mintlify.app/api-reference/endpoint/google/check_lead_form_acceptance.md): This endpoint checks whether the user has accepted the Google Ads lead form terms. It helps determine if the user is eligible to create and use lead forms in campaigns. Use this before attempting to generate or assign lead form assets.
- [Create Lead Form](https://plai-a079b342.mintlify.app/api-reference/endpoint/google/create_lead_form.md): This endpoint creates a new lead form asset for a Google Ads campaign. A lead form allows you to collect user information directly within your ad using customizable fields, headlines, call-to-action text, and a privacy policy link.
- [Create Location Group](https://plai-a079b342.mintlify.app/api-reference/endpoint/google/create_location_group.md): This endpoint creates a location group in the user's Google Ads account by grouping multiple business locations together.
- [Create Search Campaign](https://plai-a079b342.mintlify.app/api-reference/endpoint/google/create_search_campaign.md): This endpoint generates a new Google Search campaign based on the selected objective. You can choose between driving website traffic or generating conversions such as sign-ups, purchases, or lead submissions. The campaign setup includes all necessary details like targeting locations, ad creatives, d…
- [Generate Keyword Ideas](https://plai-a079b342.mintlify.app/api-reference/endpoint/google/generate_keyword_ideas.md): This endpoint generates keyword ideas related to a given input keyword. It helps users discover relevant search terms along with useful insights such as search volume, cost-per-click (CPC), and monthly trends. Ideal for planning and optimizing Google Ads campaigns based on real search behavior.
- [Get Conversion Event](https://plai-a079b342.mintlify.app/api-reference/endpoint/google/get_conversion_event.md): This endpoint retrieves the available conversion events linked to a Google Ads account. Use it to fetch and display valid options when setting up a campaign with a conversion-based objective.
- [Get Google Ads Result](https://plai-a079b342.mintlify.app/api-reference/endpoint/google/get_google_ads_result.md): This endpoint retrieves performance metrics and detailed reporting data for a specific Google Ads campaign. Users can fetch insights such as clicks, impressions, conversions, cost, and more within a selected date range. It helps evaluate how well a campaign is performing across various key metrics.
- [Get Lead Forms](https://plai-a079b342.mintlify.app/api-reference/endpoint/google/get_lead_forms.md): This endpoint retrieves all lead form assets linked to the user's Google Ads account. It returns essential details like the lead form name and asset ID, which can be used when setting up or managing lead generation campaigns. Use this to view and select from your existing lead forms.
- [Get Location Asset](https://plai-a079b342.mintlify.app/api-reference/endpoint/google/get_location_asset.md): This endpoint retrieves the location assets linked to the user's Google Ads account. These assets include details such as the location name, ID, and place ID, which are used to show business locations on Google Maps or in location-based ad extensions. Use this to fetch and manage your connected busi…
- [Get Location Id](https://plai-a079b342.mintlify.app/api-reference/endpoint/google/get_location_id.md): This endpoint retrieves the locationId and related details for a given location name. It helps users search for geographic locations (e.g., cities or regions) and fetch the corresponding identifiers required for targeting in Google Ads campaigns.
- [Google Ads API Overview](https://plai-a079b342.mintlify.app/api-reference/endpoint/google/google_overview.md): Our Google Ads API allows you to programmatically manage your Google Search campaigns. You can create and update campaigns, handle lead forms, and access various utilities to optimize your advertising efforts.
- [Update Campaign Status](https://plai-a079b342.mintlify.app/api-reference/endpoint/google/update_campaign_status.md): This endpoint allows you to change the current status of an existing Google Search campaign. Depending on your needs, you can enable, pause, or remove the campaign by updating its status using the provided campaign ID.
- [Create Contact List Audience](https://plai-a079b342.mintlify.app/api-reference/endpoint/linkedin/create_csv_audience.md): This endpoint allows you to create a custom audience by uploading a CSV file. The uploaded data is processed and matched against platform records to build a targeted audience for advertising purposes.
- [Get Audiences List](https://plai-a079b342.mintlify.app/api-reference/endpoint/linkedin/get_audiences_list.md): This endpoint is used to get the list of audiences.
- [Link CSV Audience](https://plai-a079b342.mintlify.app/api-reference/endpoint/linkedin/link_csv_audience.md): This endpoint is used to link a CSV audience to a LinkedIn.
- [Linkedin Audience Overview](https://plai-a079b342.mintlify.app/api-reference/endpoint/linkedin/linkedin_overview.md)
- [Dynamic Ad](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/campaign/awareness_dynamic.md): This endpoint is used to create a campaign for awareness dynamic ads. Awareness ads are designed to increase recognition of your brand, product, or service by showing your ads to people most likely to remember them.
- [Non Dynamic Ad](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/campaign/awareness_standard.md): This endpoint is used to create a campaign for awareness non dynamic ads. Awareness ads are designed to increase recognition of your brand, product, or service by showing your ads to people most likely to remember them.
- [Boost Post](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/campaign/boost_post.md): This page is used to create a boost post campaign. Boost post ads are used to promote an existing post on your Facebook or Instagram page to reach a larger audience and increase engagement like likes, comments, shares, or views.
- [Dynamic Ad](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/campaign/conversion_dynamic.md): This endpoint is used to create a campaign for conversion dynamic ads. Conversion ads are designed to drive users to take specific actions, such as completing a purchase, downloading an app, or signing up for a service.
- [Non Dynamic Ad](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/campaign/conversion_standard.md): This endpoint is used to create a campaign for conversion non dynamic ads. Conversion ads are designed to drive users to take specific actions, such as completing a purchase, downloading an app, or signing up for a service.
- [Engagement Ad](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/campaign/engagement.md): This page is used to create a engagement goal campaign. Engagement ads are designed to get more interactions on your content, such as likes, comments, shares, event responses, or post saves on Meta platforms.
- [Dynamic Ad](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/campaign/leads_dynamic.md): This endpoint is used to create a campaign for leads dynamic ads. Lead generation ads are ad campaigns designed to collect contact information (like name, email, phone number) directly from users on Meta platforms without needing them to leave the app.
- [Non Dynamic Ad](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/campaign/leads_standard.md): This endpoint is used to create a campaign for leads non dynamic ads. Lead generation ads are ad campaigns designed to collect contact information (like name, email, phone number) directly from users on Meta platforms without needing them to leave the app.
- [Call Ads](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/campaign/phone_call.md): This page is used to create a phone call goal campaign. Phone call ads are designed to encourage users to tap and call your business directly from the ad, making it easy to generate phone inquiries or leads.
- [Dynamic Ad](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/campaign/sales_dynamic.md): This endpoint is used to create a campaign for sales dynamic ads. Sales ads are designed to drive purchases or conversions, showing your ads to people most likely to buy your product or service.
- [Non Dynamic Ad](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/campaign/sales_standard.md): This endpoint is used to create a campaign for sales non dynamic ads. Sales ads are designed to drive purchases or conversions, showing your ads to people most likely to buy your product or service.
- [Dynamic Ad](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/campaign/traffic_dynamic.md): This endpoint is used to create a campaign for traffic dynamic ads. Traffic ads are designed to drive users to a specific destination like a website.
- [Non Dynamic Ad](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/campaign/traffic_standard.md): This endpoint is used to create a campaign for traffic non dynamic ads. Traffic ads are designed to drive users to a specific destination like a website.
- [Campaign Overview](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/campaign_overview.md): Overview of the campaign endpoints and how to create a campaign.
- [Check LeadForm TOS](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/check_leadform_tos.md): This endpoint checks whether the user has accepted the Terms of Service for their connected facebook page. It is used to verify compliance before allowing actions such as advertising or lead form creation.
- [Create Contact List Audience](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/create_fb_csv_audience.md): This endpoint allows you to create a custom audience by uploading a CSV file containing user data (such as emails, phone numbers, or other identifiers). The uploaded data is processed and matched against platform records to build a targeted audience for advertising purposes.
- [Create Leadform](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/create_leadform.md): This endpoint is used to create a leadform.
- [Create Leadform Audience](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/create_leadform_audience.md): This endpoint allows you to create a custom audience based on users who have interacted with your Facebook Lead Forms. It helps advertisers retarget users who have shown interest by submitting a lead form or engaging with lead ads.
- [Create Lookalike Audience](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/create_lookalike_audience.md): This endpoint allows you to create a Lookalike Audience based on an existing custom audience. A Lookalike Audience helps you reach new people who are similar to your existing customers, improving the chances of ad engagement and conversion.
- [Create Page Audience](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/create_page_audience.md): This endpoint allows you to create a custom audience based on user interactions with a specific Facebook Page. It enables advertisers to target people who have engaged with the page through actions such as likes, comments, shares, or visits.
- [Get Ad Account Media](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/get_ad_account_media.md): This endpoint is used to fetch media assets (both images and videos) associated with a user's Facebook Ad Account. It provides access to the creative library that can be used in ad campaigns, allowing users to browse and select previously uploaded media for their advertisements.
- [Get Campaign Insights](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/get_campaign_insights.md): This endpoint is used to fetch campaign insights for a specific campaign.
- [Get Campaigns List](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/get_campaigns_list.md): This endpoint is used to fetch list of all campaigns.
- [Get Custom Audiences](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/get_custom_audiences.md): This endpoint allows you to get custom audiences.
- [Get Custom Conversions](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/get_custom_conversions.md): Get custom conversions for a campaign
- [Get Facebook Page Media](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/get_fb_page_media.md): This endpoint is used to fetch media assets (both images and videos) associated with a user's Facebook Page. It provides access to the creative library that can be used in ad campaigns, allowing users to browse and select previously uploaded media for their advertisements.
- [Get Instagram Page Media](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/get_ig_page_media.md): This endpoint is used to fetch media assets (both images and videos) associated with a user's Instagram Page. It provides access to the creative library that can be used in ad campaigns, allowing users to browse and select previously uploaded media for their advertisements.
- [Get Lead Forms](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/get_leadforms.md): This endpoint allows you to get list of all leadforms.
- [Get Page Posts](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/get_page_posts.md): This endpoint is used to get page posts from facebook and instagram. You can use this posts to create boost post ads.
- [Get Pixels List](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/get_pixels_list.md): This endpoint is used to get meta pixels list.
- [Get Targeting Locales](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/get_targeting_locales.md): This endpoint is used to get targeting locales or languages.
- [Get Device Targeting](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/get_targeting_systems_lookup.md): This endpoint is used to get device targeting lookup, like os and devices names.
- [Get Video Info](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/get_video_info.md): This endpoint is used to get video info like dimensions, thumbnail, source url, etc.
- [Meta Api Overview](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/meta_overview.md): This page gives you api endpoints to manage your Meta (Facebook and Instagram) ads. You can create campaigns, build and view audiences, use lead forms, and handle media. It helps make your ad setup, management, and reporting faster and easier.
- [Search Targeting Interests](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/search_targeting_interests.md): This endpoint allows you to search for advertising target interests based on specific criteria. It helps in identifying relevant interest groups to improve the accuracy and effectiveness of ad targeting.
- [Search Targeting Locations](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/search_targeting_locations.md): This endpoint allows you to search for advertising target Locations based on search query. It helps in identifying relevant locations to improve the accuracy and effectiveness of ad targeting.
- [Update Campaign Budget](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/update_campaign_budget.md): This endpoint allows you to update the daily budget of a campaign.
- [Update Campaign Status](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/update_campaign_status.md): This endpoint is used to update campaign status.
- [Upload Video](https://plai-a079b342.mintlify.app/api-reference/endpoint/meta/upload_video.md): This endpoint is used to upload your video to your ad account and get video id.
- [Plai Ads API](https://plai-a079b342.mintlify.app/introduction.md): Plai Ads API Introduction
- [Quick Start Guide](https://plai-a079b342.mintlify.app/quickstart.md): Start building your own ads platform, using Plai ads apis