Create a key in the app under Settings > API keys. Keys carry one of three
access levels and can have a monthly credit budget; see
Authentication and
API keys and permissions.
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"LocalAds API","description":"Make ad campaigns, Amazon listing images, product photoshoots, ChatGPT ads and videos through the LocalAds API.","colors":{"primary":"#C83500","light":"#EF4000","dark":"#C83500"},"logo":{"light":"https://mintcdn.com/localads/4lxm0PJA_qlnUYYe/logo/light.svg?fit=max\u0026auto=format\u0026n=4lxm0PJA_qlnUYYe\u0026q=85\u0026s=8b638d356cd5fcf45755723da5d13301","dark":"https://mintcdn.com/localads/4lxm0PJA_qlnUYYe/logo/dark.svg?fit=max\u0026auto=format\u0026n=4lxm0PJA_qlnUYYe\u0026q=85\u0026s=5e9ddcf0bee75e40ef8ae5b9a54c8a2c","href":"https://makelocalads.com"},"favicon":"https://mintcdn.com/localads/4lxm0PJA_qlnUYYe/favicon.svg?fit=max\u0026auto=format\u0026n=4lxm0PJA_qlnUYYe\u0026q=85\u0026s=dc044d56b63ad09ffc71d8707fe44c34","api":{"playground":{"display":"interactive","proxy":true},"examples":{"defaults":"required","languages":["curl","javascript","python"],"prefill":true,"autogenerate":true}},"appearance":{"default":"dark","strict":false},"background":{"color":{"light":"#FFFFFF","dark":"#000000"}},"navbar":{"links":[{"href":"mailto:hq@makelocalads.com","label":"Support"}],"primary":{"type":"button","label":"Get API key","href":"https://makelocalads.com/app/settings/api-keys"}},"footer":{"socials":{"website":"https://makelocalads.com"}},"seo":{"metatags":{"og:image":"/images/og.png","twitter:card":"summary_large_image"}},"fonts":{"family":"Geist"},"styling":{"eyebrows":"section","codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":false},"contextual":{"options":["copy","view","chatgpt","claude","mcp","cursor"],"display":"header"},"metadata":{"timestamp":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"localads","hasAudioNarration":false,"actualSubdomain":"localads","customDomains":["docs.makelocalads.com"],"gitSource":{"type":"github","owner":"makelocalads","repo":"localads","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af6d81d3c10415413a7b299","clientVersion":"0.0.4124","searchFilterCounts":[{"language":"default","tag":"API reference","count":55},{"language":"default","tag":"Documentation","count":40},{"language":"default","tag":"Set up","count":20},{"language":"default","tag":"Photoshoots","count":14},{"language":"default","tag":"Listing images","count":12},{"language":"default","tag":"ChatGPT ads","count":11},{"language":"default","tag":"Ad campaigns","count":10},{"language":"default","tag":"Core concepts","count":8},{"language":"default","tag":"Videos","count":7},{"language":"default","tag":"Get started","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"custom.css","content":"#navigation-items div.mt-6:nth-of-type(n+3):not(:last-of-type):has(>.sidebar-group-header){padding-top:1rem;border-top:1px solid rgba(0, 0, 0, 0.08)}html.dark #navigation-items div.mt-6:nth-of-type(n+3):not(:last-of-type):has(>.sidebar-group-header){border-top-color:rgba(255, 255, 255, 0.08)}html.dark .card{background:#0a0a0a;border-color:#1f1f1f}.card{border-radius:0.75rem}.card:hover{border-color:rgba(239, 64, 0, 0.4)}html.dark .card:hover{border-color:rgba(239, 64, 0, 0.4)}.card svg{color:#ef4000}main a.link{text-decoration-line:underline;text-decoration-color:#ef4000;text-decoration-thickness:1px;text-underline-offset:3px}#featurebase-messenger-launcher-frame-wrapper{scale:0.8;transform-origin:bottom right}"}],"page":{"pagePath":"api-reference/overview","slug":"/api-reference/overview","pageMetadata":{"title":"API reference","description":"Every LocalAds API endpoint, with schemas, examples and a live playground.","href":"/api-reference/overview"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Every LocalAds API endpoint, with schemas, examples and a live playground.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{Card,CardGroup,CodeBlock,Heading}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The reference lists every endpoint with its request schema, response schema,\nexamples in cURL, JavaScript and Python, and a live playground.`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Quickstart`,icon:`rocket`,href:`/quickstart`,children:_jsx(_components.p,{children:`From key to finished photos in five steps.`})}),_jsx(Card,{title:`Jobs and lifecycle`,icon:`refresh-cw`,href:`/concepts/jobs-and-lifecycle`,children:_jsx(_components.p,{children:`How asynchronous resources move to completed.`})})]}),`\n`,_jsx(Heading,{level:`2`,id:`base-url`,children:`Base URL`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light github-dark`,style:{backgroundColor:`#fff`,\"--shiki-dark-bg\":`#24292e`,color:`#24292e`,\"--shiki-dark\":`#e1e4e8`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://makelocalads.com/api/v1`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsx(_components.p,{children:`Every request carries an API key in the Authorization header:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light github-dark`,style:{backgroundColor:`#fff`,\"--shiki-dark-bg\":`#24292e`,color:`#24292e`,\"--shiki-dark\":`#e1e4e8`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#B392F0`},children:`curl`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:` https://makelocalads.com/api/v1/account`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#79B8FF`},children:` --header`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#E1E4E8`},children:`$LOCALADS_API_KEY`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#9ECBFF`},children:`\"`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Create a key in the app under Settings > API keys. Keys carry one of three\naccess levels and can have a monthly credit budget; see\n`,_jsx(_components.a,{href:`/authentication`,children:`Authentication`}),` and\n`,_jsx(_components.a,{href:`/concepts/keys-and-permissions`,children:`API keys and permissions`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(_components.p,{children:[`Errors return `,_jsx(_components.a,{href:`https://www.rfc-editor.org/rfc/rfc9457`,children:`RFC 9457 problem details`}),`:\nread `,_jsx(_components.code,{children:`code`}),` for program logic and `,_jsx(_components.code,{children:`request_id`}),` for support. See\n`,_jsx(_components.a,{href:`/concepts/errors`,children:`Errors and retries`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"title":"API reference","description":"Every LocalAds API endpoint, with schemas, examples and a live playground.","href":"/api-reference/overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Base URL","slug":"base-url","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[]},{"title":"Errors","slug":"errors","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/localads/00345757588676a9/featurebase.js"],"subdomain":"localads","siteName":"LocalAds API","title":"API reference - LocalAds API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-30T03:19:27.042Z","gitLastModified":"2026-09-30T03:19:09.000Z","originalFileLocation":"api-reference/overview.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Every LocalAds API endpoint, with schemas, examples and a live playground.\">\u003cmeta data-mint-head name=\"application-name\" content=\"LocalAds API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/localads/eIbWMN3y0Pn_nCFh/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/localads/eIbWMN3y0Pn_nCFh/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/localads/eIbWMN3y0Pn_nCFh/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/localads/eIbWMN3y0Pn_nCFh/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/localads/eIbWMN3y0Pn_nCFh/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/localads/eIbWMN3y0Pn_nCFh/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/localads/eIbWMN3y0Pn_nCFh/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/localads/eIbWMN3y0Pn_nCFh/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/localads/eIbWMN3y0Pn_nCFh/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API reference - LocalAds API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Every LocalAds API endpoint, with schemas, examples and a live playground.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"LocalAds API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.makelocalads.com/api-reference/overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://localads.mintlify.site/images/og.png\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"API reference - LocalAds API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Every LocalAds API endpoint, with schemas, examples and a live playground.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://localads.mintlify.site/images/og.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/localads/eIbWMN3y0Pn_nCFh/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"LocalAds API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#C83500\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.makelocalads.com/api-reference/overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.makelocalads.com/#organization\",\"name\":\"LocalAds API\",\"url\":\"https://docs.makelocalads.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/localads/4lxm0PJA_qlnUYYe/logo/light.svg?fit=max\u0026auto=format\u0026n=4lxm0PJA_qlnUYYe\u0026q=85\u0026s=8b638d356cd5fcf45755723da5d13301\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.makelocalads.com#website\",\"name\":\"LocalAds API\",\"url\":\"https://docs.makelocalads.com\",\"publisher\":{\"@id\":\"https://docs.makelocalads.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.makelocalads.com/api-reference/overview#webpage\",\"url\":\"https://docs.makelocalads.com/api-reference/overview\",\"name\":\"API reference\",\"description\":\"Every LocalAds API endpoint, with schemas, examples and a live playground.\",\"dateModified\":\"2026-09-30T03:19:09.000Z\",\"isPartOf\":{\"@id\":\"https://docs.makelocalads.com#website\"}},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.makelocalads.com/api-reference/overview#article\",\"headline\":\"API reference\",\"name\":\"API reference\",\"description\":\"Every LocalAds API endpoint, with schemas, examples and a live playground.\",\"url\":\"https://docs.makelocalads.com/api-reference/overview\",\"mainEntityOfPage\":{\"@id\":\"https://docs.makelocalads.com/api-reference/overview#webpage\"},\"image\":\"https://docs.makelocalads.com/images/og.png\",\"dateModified\":\"2026-09-30T03:19:09.000Z\",\"publisher\":{\"@id\":\"https://docs.makelocalads.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.makelocalads.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"LocalAds API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"LocalAds API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/overview.md","siteName":"LocalAds API","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":""}]},{"tab":"API reference","icon":"square-terminal","pages":[{"title":"API reference","href":"/api-reference/overview"},{"group":"Account","pages":[{"title":"Retrieve the account","description":"Returns the organization, plan, available credits, limits, and the calling key's monthly credit budget. Every valid key may call it, so an agent can check it can afford a request before making it.","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /account","href":"/reference/account/retrieve-the-account"},{"title":"Retrieve credit pricing","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /pricing","href":"/reference/account/retrieve-credit-pricing"}]},{"group":"Set up","pages":[{"title":"Create a brand","deprecated":null,"version":null,"openapi":"/api/openapi.yaml post /brands","href":"/reference/set-up/create-a-brand"},{"title":"List brands","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /brands","href":"/reference/set-up/list-brands"},{"title":"Retrieve a brand","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /brands/{brand_id}","href":"/reference/set-up/retrieve-a-brand"},{"title":"Update a brand","deprecated":null,"version":null,"openapi":"/api/openapi.yaml patch /brands/{brand_id}","href":"/reference/set-up/update-a-brand"},{"title":"Delete a brand","deprecated":null,"version":null,"openapi":"/api/openapi.yaml delete /brands/{brand_id}","href":"/reference/set-up/delete-a-brand"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"/api/openapi.yaml post /products","href":"/reference/set-up/create-a-product"},{"title":"List products","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /products","href":"/reference/set-up/list-products"},{"title":"Retrieve a product","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /products/{product_id}","href":"/reference/set-up/retrieve-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/api/openapi.yaml patch /products/{product_id}","href":"/reference/set-up/update-a-product"},{"title":"Delete a product","deprecated":null,"version":null,"openapi":"/api/openapi.yaml delete /products/{product_id}","href":"/reference/set-up/delete-a-product"},{"title":"List product audiences","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /products/{product_id}/audiences","href":"/reference/set-up/list-product-audiences"},{"title":"Add an audience","deprecated":null,"version":null,"openapi":"/api/openapi.yaml post /products/{product_id}/audiences","href":"/reference/set-up/add-an-audience"},{"title":"Generate more audiences","deprecated":null,"version":null,"openapi":"/api/openapi.yaml post /products/{product_id}/audiences/recommendations","href":"/reference/set-up/generate-more-audiences"},{"title":"Edit an audience","deprecated":null,"version":null,"openapi":"/api/openapi.yaml patch /products/{product_id}/audiences/{audience_id}","href":"/reference/set-up/edit-an-audience"},{"title":"Archive an audience","deprecated":null,"version":null,"openapi":"/api/openapi.yaml delete /products/{product_id}/audiences/{audience_id}","href":"/reference/set-up/archive-an-audience"},{"title":"Upload an image","deprecated":null,"version":null,"openapi":"/api/openapi.yaml post /uploads/images","href":"/reference/set-up/upload-an-image"}]},{"group":"Ad campaigns","pages":[{"title":"Create an ad campaign","deprecated":null,"version":null,"openapi":"/api/openapi.yaml post /campaigns","href":"/reference/ad-campaigns/create-an-ad-campaign"},{"title":"List ad campaigns","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /campaigns","href":"/reference/ad-campaigns/list-ad-campaigns"},{"title":"Retrieve an ad campaign","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /campaigns/{campaign_id}","href":"/reference/ad-campaigns/retrieve-an-ad-campaign"},{"title":"Add creatives to a campaign","deprecated":null,"version":null,"openapi":"/api/openapi.yaml post /campaigns/{campaign_id}/creatives","href":"/reference/ad-campaigns/add-creatives-to-a-campaign"},{"title":"List campaign recipes","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /campaign-blueprints","href":"/reference/ad-campaigns/list-campaign-recipes"},{"title":"Suggest angles for a recipe","deprecated":null,"version":null,"openapi":"/api/openapi.yaml post /campaign-angles","href":"/reference/ad-campaigns/suggest-angles-for-a-recipe"}]},{"group":"Listing images","pages":[{"title":"List Amazon marketplaces","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /amazon-marketplaces","href":"/reference/listing-images/list-amazon-marketplaces"},{"title":"Write listing image ideas","deprecated":null,"version":null,"openapi":"/api/openapi.yaml post /amazon-listing-ideas","href":"/reference/listing-images/write-listing-image-ideas"},{"title":"List listing image ideas","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /amazon-listing-ideas","href":"/reference/listing-images/list-listing-image-ideas"},{"title":"Retrieve a listing image idea","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /amazon-listing-ideas/{idea_id}","href":"/reference/listing-images/retrieve-a-listing-image-idea"},{"title":"Edit an idea's direction","deprecated":null,"version":null,"openapi":"/api/openapi.yaml patch /amazon-listing-ideas/{idea_id}","href":"/reference/listing-images/edit-an-ideas-direction"},{"title":"Render one listing image","deprecated":null,"version":null,"openapi":"/api/openapi.yaml post /amazon-listing-ideas/{idea_id}/image","href":"/reference/listing-images/render-one-listing-image"},{"title":"Render listing images","deprecated":null,"version":null,"openapi":"/api/openapi.yaml post /amazon-listing-images","href":"/reference/listing-images/render-listing-images"}]},{"group":"Photoshoots","pages":[{"title":"Create a photoshoot","deprecated":null,"version":null,"openapi":"/api/openapi.yaml post /photoshoots","href":"/reference/photoshoots/create-a-photoshoot"},{"title":"List photoshoots","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /photoshoots","href":"/reference/photoshoots/list-photoshoots"},{"title":"Retrieve a photoshoot","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /photoshoots/{photoshoot_id}","href":"/reference/photoshoots/retrieve-a-photoshoot"},{"title":"Create a photoshoot template","deprecated":null,"version":null,"openapi":"/api/openapi.yaml post /templates","href":"/reference/photoshoots/create-a-photoshoot-template"},{"title":"List photoshoot templates","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /templates","href":"/reference/photoshoots/list-photoshoot-templates"},{"title":"Retrieve a photoshoot template","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /templates/{template_id}","href":"/reference/photoshoots/retrieve-a-photoshoot-template"},{"title":"Create a moodboard","deprecated":null,"version":null,"openapi":"/api/openapi.yaml post /moodboards","href":"/reference/photoshoots/create-a-moodboard"},{"title":"List moodboards","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /moodboards","href":"/reference/photoshoots/list-moodboards"},{"title":"Retrieve a moodboard","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /moodboards/{moodboard_id}","href":"/reference/photoshoots/retrieve-a-moodboard"}]},{"group":"ChatGPT ads","pages":[{"title":"Create a ChatGPT ad group","deprecated":null,"version":null,"openapi":"/api/openapi.yaml post /chatgpt-ad-groups","href":"/reference/chatgpt-ads/create-a-chatgpt-ad-group"},{"title":"List ChatGPT ad groups","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /chatgpt-ad-groups","href":"/reference/chatgpt-ads/list-chatgpt-ad-groups"},{"title":"Retrieve a ChatGPT ad group","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /chatgpt-ad-groups/{ad_group_id}","href":"/reference/chatgpt-ads/retrieve-a-chatgpt-ad-group"},{"title":"Rename a ChatGPT ad group","deprecated":null,"version":null,"openapi":"/api/openapi.yaml patch /chatgpt-ad-groups/{ad_group_id}","href":"/reference/chatgpt-ads/rename-a-chatgpt-ad-group"},{"title":"Generate more ads in a group","deprecated":null,"version":null,"openapi":"/api/openapi.yaml post /chatgpt-ad-groups/{ad_group_id}/ads","href":"/reference/chatgpt-ads/generate-more-ads-in-a-group"},{"title":"Rewrite a group's targeting","deprecated":null,"version":null,"openapi":"/api/openapi.yaml post /chatgpt-ad-groups/{ad_group_id}/targeting","href":"/reference/chatgpt-ads/rewrite-a-groups-targeting"},{"title":"Rewrite one ad's copy","deprecated":null,"version":null,"openapi":"/api/openapi.yaml post /chatgpt-ads/{ad_id}/copy","href":"/reference/chatgpt-ads/rewrite-one-ads-copy"}]},{"group":"Videos","pages":[{"title":"List video recipes","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /video-recipes","href":"/reference/ugc-videos/list-video-recipes"},{"title":"Create a video","deprecated":null,"version":null,"openapi":"/api/openapi.yaml post /videos","href":"/reference/ugc-videos/create-a-video"},{"title":"List videos","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /videos","href":"/reference/ugc-videos/list-videos"},{"title":"Retrieve a video","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /videos/{video_id}","href":"/reference/ugc-videos/retrieve-a-video"}]},{"group":"Creatives","pages":[{"title":"List creatives","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /creatives","href":"/reference/creatives/list-creatives"},{"title":"Retrieve a creative","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /creatives/{creative_id}","href":"/reference/creatives/retrieve-a-creative"},{"title":"List product creatives","deprecated":null,"version":null,"openapi":"/api/openapi.yaml get /products/{product_id}/creatives","href":"/reference/creatives/list-product-creatives"}]}]}]},"basePath":"","title":"API reference - LocalAds API","buildId":"dpl_8hoxaqFTU7hTr6A2fUraxAyjuiZo","deploymentId":"dpl_8hoxaqFTU7hTr6A2fUraxAyjuiZo","dynamics":[],"chunks":[]}
