'limit' sets the number of results to return in each page.
pagination[offset]
integer
'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result.
filter[title]
string
filter by title
Response
OK
id
integer
Unique identifier for the object
type
enum<string>
The type of ad, either custom or vast. Ads of type custom must have title, url and media fields. Ads of type vast must have title and vast_url fields.
Available options:
custom,
vast
enabled
boolean
Whether the ad will play in the BeyondWords player
placement
enum<string>
Whether the ad should play before/during/after the audio content. Possible values are pre-roll, mid-roll, or post-roll
Available options:
pre-roll,
mid-roll,
post-roll
vast_url
string<uri> | null
A VAST-compliant URL that contains the ads to be played
Maximum string length: 2048
title
string | null
The title of the ad
click_through_url
string<uri> | null
The click-through URL of the custom ad to show in the player
Maximum string length: 2048
image_url
string<uri> | null
The image URL to show in the player while the ad is playing
Maximum string length: 2048
media_url
string<uri> | null
The URL of the media file of the custom ad to play in the player
Maximum string length: 2048
audio_url
string<uri> | null
The URL of the audio file of the custom ad to play in the player
Maximum string length: 2048
video_url
string<uri> | null
The URL of the video file of the custom ad to play in the player
Maximum string length: 2048
media
object[]
The transcoded media of the custom ad to play in the player This is read-only and generated automatically from the media_url.
Show child attributes
audio
object[]
The transcoded media of the custom ad to play in the player This is read-only and generated automatically from the media_url.
Show child attributes
video
object[]
The array of video files.
Show child attributes
theme
enum<string> | null
The color theme to use for the ad when it is playing. Possible values are auto, dark, light. The auto theme is based on the user's light/dark mode system preference.
Available options:
auto,
dark,
light
dark_theme
object | null
The dark theme colors
Show child attributes
light_theme
object | null
The light theme colors
Show child attributes
video_theme
object | null
The video theme colors
Show child attributes
time_range
object | null
The time range for when the ad should play in the player
Show child attributes
created
string
Time at which the object was created (ISO 8601)
updated
string
Time at which the object was updated (ISO 8601)
Was this page helpful?
⌘I
List ads
curl --request GET \ --url https://api.beyondwords.io/v1/projects/{project_id}/ads \ --header 'X-Api-Key: <api-key>'
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Docs and guides","colors":{"primary":"#943AFC","light":"#943AFC","dark":"#943AFC"},"logo":{"light":"https://mintcdn.com/beyondwords/-xTOVbYlCFtcbESd/assets/images/beyondwords/logo-mono-light.svg?fit=max\u0026auto=format\u0026n=-xTOVbYlCFtcbESd\u0026q=85\u0026s=f7ef97de700b0d66a30f62003ea5e846","dark":"https://mintcdn.com/beyondwords/-xTOVbYlCFtcbESd/assets/images/beyondwords/logo-mono-dark.svg?fit=max\u0026auto=format\u0026n=-xTOVbYlCFtcbESd\u0026q=85\u0026s=029293973c9fcd45d9051658232abb68","href":"https://beyondwords.io"},"favicon":"https://mintcdn.com/beyondwords/LPNO5XJIxY-ynytX/favicon.svg?fit=max\u0026auto=format\u0026n=LPNO5XJIxY-ynytX\u0026q=85\u0026s=27326b9aa36c9b9d02daa183f90a22d9","api":{"openapi":"https://api.beyondwords.io/swagger/v1/swagger.yaml","mdx":{"server":"https://api.beyondwords.io"}},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Email support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dash.beyondwords.io"}},"footer":{"socials":{"x":"https://x.com/BeyondWords_io","linkedin":"https://www.linkedin.com/company/beyondwordsio"}},"contextual":{"options":["copy","view","chatgpt","claude","mcp"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"beyondwords","hasAudioNarration":false,"actualSubdomain":"beyondwords","customDomains":["docs.beyondwords.io"],"gitSource":{"type":"github","owner":"beyondwords-io","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6afc118d799281c7b114aa6e","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API reference","count":111},{"language":"default","tag":"Components","count":96},{"language":"default","tag":"Documentation","count":60},{"language":"default","tag":"Distribution","count":36},{"language":"default","tag":"Integrations","count":29},{"language":"default","tag":"React","count":29},{"language":"default","tag":"HTML","count":28},{"language":"default","tag":"Voices","count":25},{"language":"default","tag":"Content","count":21},{"language":"default","tag":"Player","count":18}]},"assistantConfig":{},"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":"site-roles","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":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"assets/css/styles.css","content":"#navigation-items>ul li:nth-child(3){display:none}#navigation-items li#\\/docs-and-guides\\/changelog{display:none}#content-side-layout{max-height:80vh}img.icon{margin:0}"}]}
{"page":{"pagePath":"api-reference/ads/list","slug":"/api-reference/ads/list","pageMetadata":{"title":"List ads","openapi":"get /projects/{project_id}/ads","description":"Lists ads configured for a project.","href":"/api-reference/ads/list"},"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: \"Lists ads configured for a project.\"\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List ads","openapi":"get /projects/{project_id}/ads","description":"Lists ads configured for a project.","href":"/api-reference/ads/list"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/beyondwords/723443eabf3ede01/assets/js/script.js","/_mintlify/custom/beyondwords/0936094f27631aa2/assets/js/components-web-components.js"],"openApiReferenceData":{"operation":{"summary":"List ads","tags":["Ads"],"description":"Lists ads configured for a project.","operationId":"adverts#index","parameters":["1c987be4-cc5e-4004-ad10-385af537eded","1e8cb6e6-6f1b-48c5-85b5-a79371b8525c","01b5585f-ae31-4219-96a6-71b4f2e6b6ab"],"security":["1f85d5b2-592a-46c4-8780-e9ff3e5a40d9"],"responses":{"200":"3346fb97-1cfa-44e4-bb6a-713faa4bdad4","401":"f9a38faa-9873-42e6-af32-f3f45f2a2486"},"method":"get","type":"path","servers":["5783a90f-4950-42a2-a170-552af1f6d9aa"],"path":"/projects/{project_id}/ads","baseUrlOptions":["https://api.beyondwords.io/v1"],"title":"List ads","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"1c987be4-cc5e-4004-ad10-385af537eded":{"name":"pagination[limit]","in":"query","required":false,"description":"'limit' sets the number of results to return in each page.","schema":{"type":"integer","isRequired":false,"description":"'limit' sets the number of results to return in each page.","uniqueKey":"","typeLabel":"integer"}},"1e8cb6e6-6f1b-48c5-85b5-a79371b8525c":{"name":"pagination[offset]","in":"query","required":false,"description":"'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result.","schema":{"type":"integer","isRequired":false,"description":"'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result.","uniqueKey":"","typeLabel":"integer"}},"01b5585f-ae31-4219-96a6-71b4f2e6b6ab":{"name":"filter[title]","in":"query","required":false,"description":"filter by title","schema":{"type":"string","isRequired":false,"description":"filter by title","uniqueKey":"","typeLabel":"string"}},"2c6cbd8e-a622-464f-bb5f-cc6cbef57b81":{"name":"project_id","in":"path","description":"The numeric ID of your project","required":true,"schema":{"type":"string","isRequired":true,"description":"The numeric ID of your project","uniqueKey":"","typeLabel":"string"}}},"responses":{"3346fb97-1cfa-44e4-bb6a-713faa4bdad4":{"description":"OK","content":{"application/json":{"examples":{"example":{"title":"example","summary":"Sample list of ads response","value":[{"id":1,"type":"custom","enabled":true,"placement":"pre-roll","vast_url":null,"title":"My first ad","click_through_url":"https://example.com","image_url":"https://example.com/image.png","media_url":"https://example.com/advert.mp3","media":[{"id":123,"content_type":"audio/mpeg","url":"https://example.com/transcoded.mp3","duration":15000},{"id":124,"content_type":"application/vnd.apple.mpegurl","url":"https://example.com/transcoded.m3u8","duration":15000}],"theme":null,"dark_theme":null,"light_theme":null,"video_theme":null,"time_range":{"start":"2023-12-01 00:00:00 UTC","end":"2023-12-31 23:59:59 UTC"},"created":"2023-01-01 00:00:00 UTC","updated":"2023-01-01 00:00:05 UTC"},{"id":2,"type":"vast","enabled":true,"placement":"pre-roll","vast_url":"https://example.com/vast.xml","title":"My second ad","click_through_url":null,"media_url":null,"media":[],"theme":"auto","dark_theme":null,"light_theme":null,"video_theme":null,"time_range":null,"created":"2023-01-01 00:00:00 UTC","updated":"2023-01-01 00:00:05 UTC"}]}},"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the object","uniqueKey":"items.[INDEX].id","typeLabel":"integer"},"type":{"type":"string","enum":["custom","vast"],"description":"The type of ad, either `custom` or `vast`. Ads of type `custom` must have `title`, `url` and `media` fields. Ads of type `vast` must have `title` and `vast_url` fields.","uniqueKey":"items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"Whether the ad will play in the BeyondWords player","uniqueKey":"items.[INDEX].enabled","typeLabel":"boolean"},"placement":{"type":"string","enum":["pre-roll","mid-roll","post-roll"],"description":"Whether the ad should play before/during/after the audio content. Possible values are `pre-roll`, `mid-roll`, or `post-roll`","uniqueKey":"items.[INDEX].placement","typeLabel":"enum\u003cstring>"},"vast_url":{"oneOf":[{"type":"string","description":"A VAST-compliant URL that contains the ads to be played","format":"uri","maxLength":2048,"uniqueKey":"items.[INDEX].vast_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","description":"A VAST-compliant URL that contains the ads to be played","format":"uri","maxLength":2048,"uniqueKey":"items.[INDEX].vast_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].vast_url","typeLabel":"string\u003curi> | null"},"title":{"oneOf":[{"type":"string","description":"The title of the ad","uniqueKey":"items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","description":"The title of the ad","uniqueKey":"items.[INDEX].title.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].title","typeLabel":"string | null"},"click_through_url":{"oneOf":[{"type":"string","description":"The click-through URL of the `custom` ad to show in the player","format":"uri","maxLength":2048,"uniqueKey":"items.[INDEX].click_through_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","description":"The click-through URL of the `custom` ad to show in the player","format":"uri","maxLength":2048,"uniqueKey":"items.[INDEX].click_through_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].click_through_url","typeLabel":"string\u003curi> | null"},"image_url":{"oneOf":[{"type":"string","description":"The image URL to show in the player while the ad is playing","format":"uri","maxLength":2048,"uniqueKey":"items.[INDEX].image_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","description":"The image URL to show in the player while the ad is playing","format":"uri","maxLength":2048,"uniqueKey":"items.[INDEX].image_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].image_url","typeLabel":"string\u003curi> | null"},"media_url":{"oneOf":[{"type":"string","description":"The URL of the media file of the `custom` ad to play in the player","format":"uri","maxLength":2048,"uniqueKey":"items.[INDEX].media_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","description":"The URL of the media file of the `custom` ad to play in the player","format":"uri","maxLength":2048,"uniqueKey":"items.[INDEX].media_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].media_url","typeLabel":"string\u003curi> | null"},"audio_url":{"oneOf":[{"type":"string","description":"The URL of the audio file of the `custom` ad to play in the player","format":"uri","maxLength":2048,"uniqueKey":"items.[INDEX].audio_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","description":"The URL of the audio file of the `custom` ad to play in the player","format":"uri","maxLength":2048,"uniqueKey":"items.[INDEX].audio_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].audio_url","typeLabel":"string\u003curi> | null"},"video_url":{"oneOf":[{"type":"string","description":"The URL of the video file of the `custom` ad to play in the player","format":"uri","maxLength":2048,"uniqueKey":"items.[INDEX].video_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","description":"The URL of the video file of the `custom` ad to play in the player","format":"uri","maxLength":2048,"uniqueKey":"items.[INDEX].video_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].video_url","typeLabel":"string\u003curi> | null"},"media":{"type":"array","description":"The transcoded media of the `custom` ad to play in the player This is read-only and generated automatically from the media_url.","items":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the object (automatically set)","uniqueKey":"items.[INDEX].media.items.[INDEX].id","typeLabel":"integer"},"content_type":{"type":"string","description":"The content type of the media (automatically set)","uniqueKey":"items.[INDEX].media.items.[INDEX].content_type","typeLabel":"string"},"url":{"type":"string","description":"The URL of the media file","uniqueKey":"items.[INDEX].media.items.[INDEX].url","typeLabel":"string"},"duration":{"type":"integer","description":"The duration of the media in milliseconds (automatically set)","uniqueKey":"items.[INDEX].media.items.[INDEX].duration","typeLabel":"integer"},"base64_file":{"oneOf":[{"type":"string","description":"The content of the media file encoded as base64. Only present for .m3u8 metadata files","uniqueKey":"items.[INDEX].media.items.[INDEX].base64_file.oneOf.0","typeLabel":"string"},{"type":"null","description":"The content of the media file encoded as base64. Only present for .m3u8 metadata files","uniqueKey":"items.[INDEX].media.items.[INDEX].base64_file.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].media.items.[INDEX].base64_file","typeLabel":"string | null"}},"uniqueKey":"items.[INDEX].media.items.[INDEX]","typeLabel":"object"},"uniqueKey":"items.[INDEX].media","typeLabel":"object[]"},"audio":{"type":"array","description":"The transcoded media of the `custom` ad to play in the player This is read-only and generated automatically from the media_url.","items":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the object (automatically set)","uniqueKey":"items.[INDEX].audio.items.[INDEX].id","typeLabel":"integer"},"content_type":{"type":"string","description":"The content type of the media (automatically set)","uniqueKey":"items.[INDEX].audio.items.[INDEX].content_type","typeLabel":"string"},"url":{"type":"string","description":"The URL of the media file","uniqueKey":"items.[INDEX].audio.items.[INDEX].url","typeLabel":"string"},"duration":{"type":"integer","description":"The duration of the media in milliseconds (automatically set)","uniqueKey":"items.[INDEX].audio.items.[INDEX].duration","typeLabel":"integer"},"base64_file":{"oneOf":[{"type":"string","description":"The content of the media file encoded as base64. Only present for .m3u8 metadata files","uniqueKey":"items.[INDEX].audio.items.[INDEX].base64_file.oneOf.0","typeLabel":"string"},{"type":"null","description":"The content of the media file encoded as base64. Only present for .m3u8 metadata files","uniqueKey":"items.[INDEX].audio.items.[INDEX].base64_file.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].audio.items.[INDEX].base64_file","typeLabel":"string | null"}},"uniqueKey":"items.[INDEX].audio.items.[INDEX]","typeLabel":"object"},"uniqueKey":"items.[INDEX].audio","typeLabel":"object[]"},"video":{"type":"array","description":"The array of video files.","items":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the object (automatically set)","uniqueKey":"items.[INDEX].video.items.[INDEX].id","typeLabel":"integer"},"content_type":{"type":"string","description":"The content type of the media (automatically set)","uniqueKey":"items.[INDEX].video.items.[INDEX].content_type","typeLabel":"string"},"url":{"type":"string","description":"The URL of the media file","uniqueKey":"items.[INDEX].video.items.[INDEX].url","typeLabel":"string"},"duration":{"type":"integer","description":"The duration of the media in milliseconds (automatically set)","uniqueKey":"items.[INDEX].video.items.[INDEX].duration","typeLabel":"integer"},"base64_file":{"oneOf":[{"type":"string","description":"The content of the media file encoded as base64. Only present for .m3u8 metadata files","uniqueKey":"items.[INDEX].video.items.[INDEX].base64_file.oneOf.0","typeLabel":"string"},{"type":"null","description":"The content of the media file encoded as base64. Only present for .m3u8 metadata files","uniqueKey":"items.[INDEX].video.items.[INDEX].base64_file.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].video.items.[INDEX].base64_file","typeLabel":"string | null"}},"uniqueKey":"items.[INDEX].video.items.[INDEX]","typeLabel":"object"},"uniqueKey":"items.[INDEX].video","typeLabel":"object[]"},"theme":{"oneOf":[{"type":"string","enum":["auto","dark","light"],"description":"The color theme to use for the ad when it is playing. Possible values are `auto`, `dark`, `light`. The `auto` theme is based on the user's light/dark mode system preference.","uniqueKey":"items.[INDEX].theme.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["auto","dark","light"],"description":"The color theme to use for the ad when it is playing. Possible values are `auto`, `dark`, `light`. The `auto` theme is based on the user's light/dark mode system preference.","uniqueKey":"items.[INDEX].theme.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].theme","typeLabel":"enum\u003cstring> | null"},"dark_theme":{"oneOf":[{"type":"object","description":"The dark theme colors","properties":{"background_color":{"type":"string","description":"The player surface color","uniqueKey":"items.[INDEX].dark_theme.oneOf.0.background_color","typeLabel":"string"},"text_color":{"type":"string","description":"The primary text color","uniqueKey":"items.[INDEX].dark_theme.oneOf.0.text_color","typeLabel":"string"},"secondary_text_color":{"type":"string","description":"The secondary text, metadata, caption, placeholder, and disabled-copy color","uniqueKey":"items.[INDEX].dark_theme.oneOf.0.secondary_text_color","typeLabel":"string"},"icon_color":{"type":"string","description":"The transport and utility control color","uniqueKey":"items.[INDEX].dark_theme.oneOf.0.icon_color","typeLabel":"string"},"subtle_color":{"type":"string","description":"The progress-track, divider, skeleton, citation-border, and quiet-border color","uniqueKey":"items.[INDEX].dark_theme.oneOf.0.subtle_color","typeLabel":"string"},"link_color":{"type":"string","description":"The link, call-to-action, citation, and underline color","uniqueKey":"items.[INDEX].dark_theme.oneOf.0.link_color","typeLabel":"string"},"highlight_color":{"type":"string","description":"The section highlight color","uniqueKey":"items.[INDEX].dark_theme.oneOf.0.highlight_color","typeLabel":"string"},"word_highlight_color":{"type":"string","description":"The current-word highlight color","uniqueKey":"items.[INDEX].dark_theme.oneOf.0.word_highlight_color","typeLabel":"string"},"agent_color":{"type":"string","description":"The agent color or CSS background gradient","uniqueKey":"items.[INDEX].dark_theme.oneOf.0.agent_color","typeLabel":"string"},"accent_color":{"type":"string","description":"The user-message background color","uniqueKey":"items.[INDEX].dark_theme.oneOf.0.accent_color","typeLabel":"string"},"accent_text_color":{"type":"string","description":"The user-message text color","uniqueKey":"items.[INDEX].dark_theme.oneOf.0.accent_text_color","typeLabel":"string"}},"uniqueKey":"items.[INDEX].dark_theme.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"items.[INDEX].dark_theme.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].dark_theme","typeLabel":"object | null"},"light_theme":{"oneOf":[{"type":"object","description":"The light theme colors","properties":{"background_color":{"type":"string","description":"The player surface color","uniqueKey":"items.[INDEX].light_theme.oneOf.0.background_color","typeLabel":"string"},"text_color":{"type":"string","description":"The primary text color","uniqueKey":"items.[INDEX].light_theme.oneOf.0.text_color","typeLabel":"string"},"secondary_text_color":{"type":"string","description":"The secondary text, metadata, caption, placeholder, and disabled-copy color","uniqueKey":"items.[INDEX].light_theme.oneOf.0.secondary_text_color","typeLabel":"string"},"icon_color":{"type":"string","description":"The transport and utility control color","uniqueKey":"items.[INDEX].light_theme.oneOf.0.icon_color","typeLabel":"string"},"subtle_color":{"type":"string","description":"The progress-track, divider, skeleton, citation-border, and quiet-border color","uniqueKey":"items.[INDEX].light_theme.oneOf.0.subtle_color","typeLabel":"string"},"link_color":{"type":"string","description":"The link, call-to-action, citation, and underline color","uniqueKey":"items.[INDEX].light_theme.oneOf.0.link_color","typeLabel":"string"},"highlight_color":{"type":"string","description":"The section highlight color","uniqueKey":"items.[INDEX].light_theme.oneOf.0.highlight_color","typeLabel":"string"},"word_highlight_color":{"type":"string","description":"The current-word highlight color","uniqueKey":"items.[INDEX].light_theme.oneOf.0.word_highlight_color","typeLabel":"string"},"agent_color":{"type":"string","description":"The agent color or CSS background gradient","uniqueKey":"items.[INDEX].light_theme.oneOf.0.agent_color","typeLabel":"string"},"accent_color":{"type":"string","description":"The user-message background color","uniqueKey":"items.[INDEX].light_theme.oneOf.0.accent_color","typeLabel":"string"},"accent_text_color":{"type":"string","description":"The user-message text color","uniqueKey":"items.[INDEX].light_theme.oneOf.0.accent_text_color","typeLabel":"string"}},"uniqueKey":"items.[INDEX].light_theme.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"items.[INDEX].light_theme.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].light_theme","typeLabel":"object | null"},"video_theme":{"oneOf":[{"type":"object","description":"The video theme colors","properties":{"background_color":{"type":"string","description":"The video surface color","uniqueKey":"items.[INDEX].video_theme.oneOf.0.background_color","typeLabel":"string"},"text_color":{"type":"string","description":"The video text color","uniqueKey":"items.[INDEX].video_theme.oneOf.0.text_color","typeLabel":"string"},"icon_color":{"type":"string","description":"The video control icon color","uniqueKey":"items.[INDEX].video_theme.oneOf.0.icon_color","typeLabel":"string"},"subtle_color":{"type":"string","description":"The video subtle control color","uniqueKey":"items.[INDEX].video_theme.oneOf.0.subtle_color","typeLabel":"string"}},"uniqueKey":"items.[INDEX].video_theme.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"items.[INDEX].video_theme.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].video_theme","typeLabel":"object | null"},"time_range":{"oneOf":[{"type":"object","description":"The time range for when the ad should play in the player","properties":{"start":{"oneOf":[{"type":"string","description":"The start time of when the ad should play","uniqueKey":"items.[INDEX].time_range.oneOf.0.start.oneOf.0","typeLabel":"string"},{"type":"null","description":"The start time of when the ad should play","uniqueKey":"items.[INDEX].time_range.oneOf.0.start.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].time_range.oneOf.0.start","typeLabel":"string | null"},"end":{"oneOf":[{"type":"string","description":"The end time of when the ad should play","uniqueKey":"items.[INDEX].time_range.oneOf.0.end.oneOf.0","typeLabel":"string"},{"type":"null","description":"The end time of when the ad should play","uniqueKey":"items.[INDEX].time_range.oneOf.0.end.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].time_range.oneOf.0.end","typeLabel":"string | null"}},"uniqueKey":"items.[INDEX].time_range.oneOf.0","typeLabel":"object"},{"type":"null","description":"The time range for when the ad should play in the player","properties":{"start":{"oneOf":[{"type":"string","description":"The start time of when the ad should play"},{"type":"null","description":"The start time of when the ad should play"}]},"end":{"oneOf":[{"type":"string","description":"The end time of when the ad should play"},{"type":"null","description":"The end time of when the ad should play"}]}},"uniqueKey":"items.[INDEX].time_range.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].time_range","typeLabel":"object | null"},"created":{"type":"string","description":"Time at which the object was created (ISO 8601)","uniqueKey":"items.[INDEX].created","typeLabel":"string"},"updated":{"type":"string","description":"Time at which the object was updated (ISO 8601)","uniqueKey":"items.[INDEX].updated","typeLabel":"string"}},"uniqueKey":"items.[INDEX]","typeLabel":"object"},"uniqueKey":"","typeLabel":"object[]"},"exampleType":"examples"}},"headers":{"X-Pagination-Limit":{"description":"The requested number of results to be returned for this request.\n The actual number of results returned may be lower.","schema":{"type":"integer"},"required":false},"X-Pagination-OffSet":{"description":"The position of the first result in the response (before pagination was applied).","schema":{"type":"integer"},"required":false},"X-Pagination-Total-Count":{"description":"The total number of results returned for this query (before pagination was applied).","schema":{"type":"integer"},"required":false}},"exampleType":"examples"},"f9a38faa-9873-42e6-af32-f3f45f2a2486":{"description":"Invalid authentication token","content":{"application/json":{"examples":{"example":{"title":"example","summary":"Unauthorized error","value":{"code":401,"message":"Unauthorized"}}},"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Error code","uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","description":"Error message","uniqueKey":"message","typeLabel":"string"},"errors":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"location":{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].location","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"location":{"type":"string"},"message":{"type":"string"}}},"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"object[] | null"}},"uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"1f85d5b2-592a-46c4-8780-e9ff3e5a40d9":{"apiKey":{"type":"apiKey","name":"X-Api-Key","in":"header","scopes":[],"schemeName":"apiKey"}}},"servers":{"5783a90f-4950-42a2-a170-552af1f6d9aa":{"url":"https://api.beyondwords.io/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"X-Api-Key","in":"header","scopes":[],"schemeName":"apiKey"},"schema":{"title":"X-Api-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"X-Api-Key"}],"title":"apiKey"}]},"originalFileLocation":"https://api.beyondwords.io/swagger/v1/swagger.yaml"},"subdomain":"beyondwords","siteName":"Docs and guides","title":"List ads - Docs and guides","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-11T10:10:11.290Z","originalFileLocation":"api-reference/ads/list.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=\"system\"}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=\"Lists ads configured for a project.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Docs and guides\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/beyondwords/XS-CwsB9cNWQe75s/_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/beyondwords/XS-CwsB9cNWQe75s/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/beyondwords/XS-CwsB9cNWQe75s/_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/beyondwords/XS-CwsB9cNWQe75s/_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/beyondwords/XS-CwsB9cNWQe75s/_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/beyondwords/XS-CwsB9cNWQe75s/_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/beyondwords/XS-CwsB9cNWQe75s/_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/beyondwords/XS-CwsB9cNWQe75s/_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/beyondwords/XS-CwsB9cNWQe75s/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List ads - Docs and guides\">\u003cmeta data-mint-head property=\"og:description\" content=\"Lists ads configured for a project.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Docs and guides\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.beyondwords.io/api-reference/ads/list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://beyondwords.mintlify.site/_mintlify/api/og/v2?division=Ads\u0026amp;title=List+ads\u0026amp;description=Lists+ads+configured+for+a+project.\u0026amp;theme=0945647b76bc78bc264b5039\u0026amp;signature=85dbc13333d7b620607cf80bead6be3199c60f47100cd08b6e28ac3a614177ed\">\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=\"List ads - Docs and guides\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Lists ads configured for a project.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://beyondwords.mintlify.site/_mintlify/api/og/v2?division=Ads\u0026amp;title=List+ads\u0026amp;description=Lists+ads+configured+for+a+project.\u0026amp;theme=0945647b76bc78bc264b5039\u0026amp;signature=85dbc13333d7b620607cf80bead6be3199c60f47100cd08b6e28ac3a614177ed\">\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/beyondwords/XS-CwsB9cNWQe75s/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Docs and guides\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#943AFC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.beyondwords.io/api-reference/ads/list\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/ads/list.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.beyondwords.io/#organization\",\"name\":\"Docs and guides\",\"url\":\"https://docs.beyondwords.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/beyondwords/-xTOVbYlCFtcbESd/assets/images/beyondwords/logo-mono-light.svg?fit=max\u0026auto=format\u0026n=-xTOVbYlCFtcbESd\u0026q=85\u0026s=f7ef97de700b0d66a30f62003ea5e846\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.beyondwords.io#website\",\"name\":\"Docs and guides\",\"url\":\"https://docs.beyondwords.io\",\"publisher\":{\"@id\":\"https://docs.beyondwords.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.beyondwords.io/api-reference/ads/list#webpage\",\"url\":\"https://docs.beyondwords.io/api-reference/ads/list\",\"name\":\"List ads\",\"description\":\"Lists ads configured for a project.\",\"dateModified\":\"2026-06-11T10:10:11.290Z\",\"isPartOf\":{\"@id\":\"https://docs.beyondwords.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.beyondwords.io/api-reference/ads/list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.beyondwords.io/api-reference/ads/list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Docs and guides\",\"item\":\"https://docs.beyondwords.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List ads\",\"item\":\"https://docs.beyondwords.io/api-reference/ads/list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.beyondwords.io/api-reference/ads/list#apireference\",\"headline\":\"List ads\",\"name\":\"List ads\",\"description\":\"Lists ads configured for a project.\",\"url\":\"https://docs.beyondwords.io/api-reference/ads/list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.beyondwords.io/api-reference/ads/list#webpage\"},\"dateModified\":\"2026-06-11T10:10:11.290Z\",\"publisher\":{\"@id\":\"https://docs.beyondwords.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.beyondwords.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Docs and guides\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Docs and guides\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/ads/list.md","siteName":"Docs and guides","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/docs-and-guides/get-started/introduction"}]},{"anchor":"API reference","icon":"rectangle-terminal","groups":[{"group":"Getting started","pages":[{"title":"Overview","href":"/api-reference/overview"}]},{"group":"Content","pages":[{"group":"Items","pages":[{"group":"Developer guide","pages":[{"title":"Generating content","sidebarTitle":"Overview","href":"/api-reference/content/introduction"},{"title":"Content object","sidebarTitle":"Content object","href":"/api-reference/content/overview"},{"title":"Processing types","sidebarTitle":"Processing types","href":"/api-reference/content/processing-types"},{"title":"Replace audio","sidebarTitle":"Replace audio","href":"/api-reference/content/replace-audio"},{"title":"Syndication","sidebarTitle":"Syndication","href":"/api-reference/content/syndicated"}]},{"title":"Create and generate content","sidebarTitle":"Create content","openapi":"post /projects/{project_id}/content","href":"/api-reference/content/create"},{"title":"Get content","openapi":"get /projects/{project_id}/content/{id}","href":"/api-reference/content/show"},{"title":"Update content","openapi":"put /projects/{project_id}/content/{id}","href":"/api-reference/content/update"},{"title":"Delete content","openapi":"delete /projects/{project_id}/content/{id}","href":"/api-reference/content/delete"},{"title":"Regenerate content","sidebarTitle":"Regenerate","openapi":"post /projects/{project_id}/content/{id}/regenerate","href":"/api-reference/content/regenerate"},{"title":"Summarize content","openapi":"post /projects/{project_id}/content/{id}/summarize","href":"/api-reference/content/summarize"},{"title":"Upload file","openapi":"post /upload","href":"/api-reference/content/upload"},{"title":"List content","openapi":"get /projects/{project_id}/content","href":"/api-reference/content/list"}]}]},{"group":"Extraction","pages":[{"group":"Filters","pages":[{"title":"Content filters overview","sidebarTitle":"Overview","href":"/api-reference/content-filters/overview"},{"title":"List content filters","openapi":"get /html_filters","href":"/api-reference/content-filters/list"},{"title":"Create content filter","openapi":"post /html_filters","href":"/api-reference/content-filters/create"},{"title":"Get content filter","openapi":"get /html_filters/{id}","href":"/api-reference/content-filters/show"},{"title":"Update content filter","openapi":"put /html_filters/{id}","href":"/api-reference/content-filters/update"},{"title":"Delete content filter","openapi":"delete /html_filters/{id}","href":"/api-reference/content-filters/delete"}]},{"group":"Extraction settings","pages":[{"title":"Get content extraction settings","openapi":"get /projects/{project_id}/content_extraction_settings","href":"/api-reference/content-extraction-settings/show"},{"title":"Update content extraction settings","openapi":"put /projects/{project_id}/content_extraction_settings","href":"/api-reference/content-extraction-settings/update"}]}]},{"group":"Pronunciation settings","pages":[{"title":"List pronunciation rules","openapi":"get /rules","href":"/api-reference/rules/list"},{"title":"Create pronunciation rule","openapi":"post /rules","href":"/api-reference/rules/create"},{"title":"Get pronunciation rule","openapi":"get /rules/{id}","href":"/api-reference/rules/show"},{"title":"Update pronunciation rule","openapi":"put /rules/{id}","href":"/api-reference/rules/update"},{"title":"Delete pronunciation rule","openapi":"delete /rules/{id}","href":"/api-reference/rules/delete"}]},{"group":"Summary settings","pages":[{"title":"Get project summary settings","openapi":"get /projects/{project_id}/summarization_settings","href":"/api-reference/summarization-settings/show"},{"title":"Update project summary settings","openapi":"put /projects/{project_id}/summarization_settings","href":"/api-reference/summarization-settings/update"},{"group":"Summary templates","pages":[{"title":"List summary templates","openapi":"get /summarization_settings_templates","href":"/api-reference/summarization-settings-templates/list"},{"title":"Create summary template","openapi":"post /summarization_settings_templates","href":"/api-reference/summarization-settings-templates/create"},{"title":"Get summary template","openapi":"get /summarization_settings_templates/{slug}","href":"/api-reference/summarization-settings-templates/show"},{"title":"Update summary template","openapi":"put /summarization_settings_templates/{slug}","href":"/api-reference/summarization-settings-templates/update"},{"title":"Delete summary template","openapi":"delete /summarization_settings_templates/{slug}","href":"/api-reference/summarization-settings-templates/delete"}]}]},{"group":"Video settings","pages":[{"title":"Get video settings","openapi":"get /projects/{project_id}/video_settings","href":"/api-reference/video-settings/show"},{"title":"Update video settings","openapi":"put /projects/{project_id}/video_settings","href":"/api-reference/video-settings/update"},{"group":"Video templates","pages":[{"title":"List video settings templates","openapi":"get /video_settings_templates","href":"/api-reference/video-settings-templates/list"},{"title":"Create video settings template","openapi":"post /video_settings_templates","href":"/api-reference/video-settings-templates/create"},{"title":"Get video settings template","openapi":"get /video_settings_templates/{slug}","href":"/api-reference/video-settings-templates/show"},{"title":"Update video settings template","openapi":"put /video_settings_templates/{slug}","href":"/api-reference/video-settings-templates/update"},{"title":"Delete video settings template","openapi":"delete /video_settings_templates/{slug}","href":"/api-reference/video-settings-templates/delete"},{"title":"Preview video settings template","openapi":"post /video_settings_templates/preview","href":"/api-reference/video-settings-templates/preview"}]}]},{"group":"Background music settings","pages":[{"title":"List background tracks","openapi":"get /background_tracks","href":"/api-reference/background-tracks/list"},{"title":"Create background tracks","openapi":"post /background_tracks","href":"/api-reference/background-tracks/create"},{"title":"Get background track","openapi":"get /background_tracks/{id}","href":"/api-reference/background-tracks/show"},{"title":"Update background track","openapi":"put /background_tracks/{id}","href":"/api-reference/background-tracks/update"},{"title":"Delete background track","openapi":"delete /background_tracks/{id}","href":"/api-reference/background-tracks/delete"}]},{"group":"Voices","pages":[{"group":"Voices","pages":[{"title":"List voices","openapi":"get /organization/voices","href":"/api-reference/voices/list"},{"title":"Get voice","openapi":"get /organization/voices/{id}","href":"/api-reference/voices/show"},{"title":"Update voice","openapi":"put /organization/voices/{id}","href":"/api-reference/voices/update"},{"title":"Delete voice","openapi":"delete /organization/voices/{id}","href":"/api-reference/voices/delete"}]},{"group":"Voice generation","pages":[{"title":"Design voice previews","openapi":"post /organization/voices/design_previews","href":"/api-reference/voices/design-previews"},{"title":"Finalize voice design","openapi":"post /organization/voices/finalize_design","href":"/api-reference/voices/finalize-design"}]},{"group":"Speakers","pages":[{"title":"List speakers","openapi":"get /speakers","href":"/api-reference/speakers/list"},{"title":"Create speaker","openapi":"post /speakers","href":"/api-reference/speakers/create"},{"title":"Get speaker","openapi":"get /speakers/{id}","href":"/api-reference/speakers/show"},{"title":"Update speaker","openapi":"put /speakers/{id}","href":"/api-reference/speakers/update"},{"title":"Delete speaker","openapi":"delete /speakers/{id}","href":"/api-reference/speakers/delete"}]},{"group":"Voice cloning","pages":[{"title":"Create voice","openapi":"post /organization/voices","href":"/api-reference/voices/create"},{"title":"Clone instant voice","openapi":"post /organization/voices/{id}/clone","href":"/api-reference/voices/clone"}]},{"group":"Languages","pages":[{"title":"List languages","openapi":"get /organization/languages","href":"/api-reference/languages/list"}]}]},{"group":"Distribution","pages":[{"group":"Player","pages":[{"title":"Get player by content ID","openapi":"get /projects/{project_id}/player/by_content_id/{id}","href":"/api-reference/player/by-content-id"},{"title":"Get player by source ID","openapi":"get /projects/{project_id}/player/by_source_id/{id}","href":"/api-reference/player/by-source-id"},{"title":"Get player by source URL","openapi":"get /projects/{project_id}/player/by_source_url/{url}","href":"/api-reference/player/by-source-url"},{"title":"Get player by playlist ID","openapi":"get /projects/{project_id}/player/by_playlist_id/{id}","href":"/api-reference/player/by-playlist-id"},{"title":"Get player by multiple identifiers","openapi":"get /projects/{project_id}/player/by_identifiers/{array}","href":"/api-reference/player/by-identifiers"}]},{"group":"Player settings","pages":[{"title":"Get player settings","openapi":"get /projects/{project_id}/player_settings","href":"/api-reference/player-settings/show"},{"title":"Update player settings","openapi":"put /projects/{project_id}/player_settings","href":"/api-reference/player-settings/update"}]},{"group":"Access tiers","pages":[{"title":"List access tiers","openapi":"get /projects/{project_id}/player_settings/access_tiers","href":"/api-reference/access-tiers/list"},{"title":"Create access tier","openapi":"post /projects/{project_id}/player_settings/access_tiers","href":"/api-reference/access-tiers/create"},{"title":"Get access tier","openapi":"get /projects/{project_id}/player_settings/access_tiers/{id}","href":"/api-reference/access-tiers/show"},{"title":"Update access tier","openapi":"put /projects/{project_id}/player_settings/access_tiers/{id}","href":"/api-reference/access-tiers/update"}]},{"group":"Playlists","pages":[{"title":"List playlists","openapi":"get /projects/{project_id}/playlists","href":"/api-reference/playlists/list"},{"title":"Create playlist","openapi":"post /projects/{project_id}/playlists","href":"/api-reference/playlists/create"},{"title":"Get playlist","openapi":"get /projects/{project_id}/playlists/{id}","href":"/api-reference/playlists/show"},{"title":"Update playlist","openapi":"put /projects/{project_id}/playlists/{id}","href":"/api-reference/playlists/update"},{"title":"Delete playlist","openapi":"delete /projects/{project_id}/playlists/{id}","href":"/api-reference/playlists/delete"}]},{"group":"Podcast feeds","pages":[{"title":"Get podcast feed settings","openapi":"get /projects/{project_id}/playlists/{playlist_id}/settings","href":"/api-reference/podcast-feeds/get-settings"},{"title":"Update podcast feed settings","openapi":"put /projects/{project_id}/playlists/{playlist_id}/settings","href":"/api-reference/podcast-feeds/update-settings"}]}]},{"group":"Integrations","pages":[{"group":"Webhooks","pages":[{"title":"List webhooks","openapi":"get /projects/{project_id}/webhooks","href":"/api-reference/webhooks/list"},{"title":"Create webhook","openapi":"post /projects/{project_id}/webhooks","href":"/api-reference/webhooks/create"},{"title":"Get webhook","openapi":"get /projects/{project_id}/webhooks/{id}","href":"/api-reference/webhooks/show"},{"title":"Update webhook","openapi":"put /projects/{project_id}/webhooks/{id}","href":"/api-reference/webhooks/update"},{"title":"Delete webhook","openapi":"delete /projects/{project_id}/webhooks/{id}","href":"/api-reference/webhooks/delete"},{"title":"Test webhook","openapi":"post /projects/{project_id}/webhooks/test","href":"/api-reference/webhooks/test"}]},{"group":"RSS feed importer","pages":[{"title":"List RSS feed imports","openapi":"get /projects/{project_id}/integrations/rss_importer/feeds","href":"/api-reference/rss-feed-importer/list"},{"title":"Create RSS feed import","openapi":"post /projects/{project_id}/integrations/rss_importer/feeds","href":"/api-reference/rss-feed-importer/create"},{"title":"Get RSS feed import","openapi":"get /projects/{project_id}/integrations/rss_importer/feeds/{id}","href":"/api-reference/rss-feed-importer/show"},{"title":"Update RSS feed import","openapi":"put /projects/{project_id}/integrations/rss_importer/feeds/{id}","href":"/api-reference/rss-feed-importer/update"},{"title":"Delete RSS feed import","openapi":"delete /projects/{project_id}/integrations/rss_importer/feeds/{id}","href":"/api-reference/rss-feed-importer/delete"},{"title":"Run RSS feed import","openapi":"post /projects/{project_id}/integrations/rss_importer/feeds/{id}/run","href":"/api-reference/rss-feed-importer/run"},{"title":"Test RSS feed import","openapi":"post /projects/{project_id}/integrations/rss_importer/feeds/test","href":"/api-reference/rss-feed-importer/test"}]},{"group":"Magic Embed","pages":[{"title":"Get Magic Embed settings","openapi":"get /projects/{project_id}/integrations/client_side","href":"/api-reference/magic-embed/show"},{"title":"Update Magic Embed settings","openapi":"put /projects/{project_id}/integrations/client_side","href":"/api-reference/magic-embed/update"}]},{"group":"Ghost","pages":[{"title":"Get Ghost integration","openapi":"get /projects/{project_id}/integrations/ghost","href":"/api-reference/ghost/show"},{"title":"Update Ghost integration","openapi":"put /projects/{project_id}/integrations/ghost","href":"/api-reference/ghost/update"},{"title":"Test Ghost integration","openapi":"post /projects/{project_id}/integrations/ghost/test","href":"/api-reference/ghost/test"},{"title":"Ghost posts webhook","openapi":"post /projects/{project_id}/integrations/ghost/posts","href":"/api-reference/ghost/posts"}]}]},{"group":"Analytics","pages":[{"group":"Content","pages":[{"group":"Analytics","pages":[{"title":"Get organization analytics","openapi":"get /organization/analytics","href":"/api-reference/analytics/organization-analytics"},{"title":"List projects analytics","openapi":"get /projects/analytics","href":"/api-reference/analytics/projects-analytics"},{"title":"Get project analytics","openapi":"get /projects/{id}/analytics","href":"/api-reference/analytics/project-analytics"},{"title":"List content analytics","openapi":"get /projects/{project_id}/content/analytics","href":"/api-reference/analytics/contents-analytics"},{"title":"Get content analytics","openapi":"get /projects/{project_id}/content/{id}/analytics","href":"/api-reference/analytics/content-analytics"}]}]},{"group":"Ads","pages":[{"group":"Analytics","pages":[{"title":"List ads analytics","openapi":"get /projects/{project_id}/ads/analytics","href":"/api-reference/analytics/ads-analytics"},{"title":"Get ad analytics","openapi":"get /projects/{project_id}/ads/{id}/analytics","description":"Retrieve analytics for a single ad in a project.","href":"/api-reference/analytics/ad-analytics"}]}]}]},{"group":"Monetization","pages":[{"group":"Ads","pages":[{"title":"List ads","openapi":"get /projects/{project_id}/ads","href":"/api-reference/ads/list"},{"title":"Create ad","openapi":"post /projects/{project_id}/ads","description":"Creates an ad in a project.","href":"/api-reference/ads/create"},{"title":"Get ad","openapi":"get /projects/{project_id}/ads/{id}","href":"/api-reference/ads/show"},{"title":"Update ad","openapi":"put /projects/{project_id}/ads/{id}","href":"/api-reference/ads/update"},{"title":"Delete ad","openapi":"delete /projects/{project_id}/ads/{id}","href":"/api-reference/ads/delete"}]}]},{"group":"Organization","pages":[{"group":"Projects","pages":[{"title":"List projects","openapi":"get /projects","href":"/api-reference/projects/list"},{"title":"Create project","openapi":"post /projects","href":"/api-reference/projects/create"},{"title":"Get project","openapi":"get /projects/{id}","href":"/api-reference/projects/show"},{"title":"Update project","openapi":"put /projects/{id}","href":"/api-reference/projects/update"},{"title":"Delete project","openapi":"delete /projects/{id}","href":"/api-reference/projects/delete"},{"title":"Get project voices","openapi":"get /projects/{id}/voices","href":"/api-reference/projects/voices"}]}]}]},{"anchor":"Full reference","icon":"rectangle-terminal","pages":[{"title":"Full reference","href":"/full-api-reference/overview"}]},{"anchor":"Components","icon":"puzzle-piece","pages":[{"title":"Components","href":"/components/react/introduction"}]},{"anchor":"Changelog","icon":"file-code","pages":[{"title":"Changelog","href":"/docs-and-guides/changelog"}]}]},"basePath":"","title":"List ads - Docs and guides","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","Page-CVJ-f_k1.js","CodeSnippet-D_HwgQO_.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","getApiPlaygroundDisplay-CmCoerhe.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}