{"info":{"title":"Wisewand API","description":"\n  Welcome to the Wisewand API documentation.\n  Please feel free to reach out to us if you have any questions.\n\n  ## Authentication\n  You muse use your api key to authenticate yourself with an Authorization header.\n\n  ```\n  Authorization: Bearer {your_api_key}\n  ```\n\n  ## Rate Limiting\n  We use a rate limiting system to prevent abuse.\n  You can make up to 60 requests per minute.\n","version":"0.0.1"},"openapi":"3.1.2","paths":{"/v1/articles/":{"get":{"tags":["articles"],"summary":"List articles","parameters":[{"name":"skip","in":"query","required":false,"schema":{"default":0,"anyOf":[{"default":0,"format":"numeric","type":"string"},{"default":0,"type":"number"}]}},{"name":"take","in":"query","required":false,"schema":{"default":9,"maximum":50,"anyOf":[{"default":0,"maximum":50,"format":"numeric","type":"string"},{"default":9,"maximum":50,"type":"number"}]}},{"name":"search","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"maker","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"status","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"projectId","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"persona","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"author","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"category","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"published","in":"query","required":false,"schema":{"type":"string"}},{"name":"source","in":"query","required":false,"schema":{"description":"Comma-separated sources (app, autopilot, feed, api, merlin); `none` = contents without a source","examples":["feed,api","none"],"type":"string"}},{"name":"format","in":"query","required":false,"schema":{"description":"Comma-separated article formats (`data.input.type`)","examples":["blog,news"],"type":"string"}},{"name":"statusGroup","in":"query","required":false,"schema":{"description":"Comma-separated status groups: waiting (prequeued, queued, idle), running (starting, running), success, error (error, interrupted)","examples":["waiting,error"],"type":"string"}},{"name":"created_from","in":"query","required":false,"schema":{"description":"Created at or after this ISO date-time","examples":["2026-10-01T00:00:00+02:00"],"type":"string"}},{"name":"created_to","in":"query","required":false,"schema":{"description":"Created at or before this ISO date-time","examples":["2026-10-31T23:59:59+01:00"],"type":"string"}}],"responses":{"200":{"description":"The list of articles","content":{"application/json":{"schema":{"description":"The list of articles","type":"object","required":["items","count"],"properties":{"items":{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{"id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"},"name":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"title":{"type":"string"},"data":{"type":"object","required":["input"],"properties":{"input":{"additionalProperties":true,"type":"object","properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}}},"status":{"enum":["queued","running","success","error"],"type":"string"},"status_detail":{"type":"string"},"last_output_id":{"format":"uuid","type":"string"},"project_id":{"format":"uuid","type":"string"},"maker_id":{"format":"uuid","type":"string"},"source":{"enum":["app","autopilot","feed","api","merlin"],"description":"Where the content comes from, written by the API on creation (null = unknown)","type":["string","null"]},"cover_image":{"type":"string"},"is_published":{"type":"boolean"},"placed_resources":{"description":"The article's resources (data.input.resources) that came out as a block in its HTML, in the order of the article: an empty list means none was placed. Read from the current HTML: an article edited by hand afterwards may differ from what was written. Present once the article is written and carries a resource list.","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"description":"Title of the resource, as the list holds it.","type":"string"},"url":{"description":"Its link, as the list holds it.","type":"string"}}}}}}},"count":{"default":0,"type":"number"}},"additionalProperties":false}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}},"additionalProperties":false}}}}},"operationId":"getV1Articles"},"post":{"tags":["articles"],"summary":"Create and run a articles","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}}}},"responses":{"200":{"description":"The id of the created article","content":{"application/json":{"schema":{"description":"The id of the created article","type":"object","required":["id"],"properties":{"id":{"type":"string"}},"additionalProperties":false}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}},"additionalProperties":false}}}},"500":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}},"additionalProperties":false}}}}},"operationId":"postV1Articles"}},"/v1/articles/{id}":{"get":{"tags":["articles"],"summary":"Get a articles","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The articles","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{"id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"},"name":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"title":{"type":"string"},"data":{"type":"object","required":["input"],"properties":{"input":{"additionalProperties":true,"type":"object","properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}}},"status":{"enum":["queued","running","success","error"],"type":"string"},"status_detail":{"type":"string"},"last_output_id":{"format":"uuid","type":"string"},"project_id":{"format":"uuid","type":"string"},"maker_id":{"format":"uuid","type":"string"},"source":{"enum":["app","autopilot","feed","api","merlin"],"description":"Where the content comes from, written by the API on creation (null = unknown)","type":["string","null"]},"cover_image":{"type":"string"},"is_published":{"type":"boolean"},"placed_resources":{"description":"The article's resources (data.input.resources) that came out as a block in its HTML, in the order of the article: an empty list means none was placed. Read from the current HTML: an article edited by hand afterwards may differ from what was written. Present once the article is written and carries a resource list.","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"description":"Title of the resource, as the list holds it.","type":"string"},"url":{"description":"Its link, as the list holds it.","type":"string"}}}}},"description":"The articles"}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}},"additionalProperties":false}}}}},"operationId":"getV1ArticlesById"},"patch":{"tags":["articles"],"summary":"Update a articles","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"description":"Length of the article in words.","type":"number"},{"pattern":"auto","type":"string"}]},"keep_title":{"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string"},"persona_id":{"type":"string"},"use_cta":{"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"type":"boolean"},"use_indexed_pages_internal_links":{"type":"boolean"},"use_wp_internal_links":{"type":"boolean"},"use_shopify_internal_links":{"type":"boolean"},"use_app_internal_links":{"type":"boolean"},"use_list_internal_links":{"type":"boolean"},"internal_links_wp_status":{"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string"},"publishwordpress_category":{"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string"},"use_inlinephotos":{"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":true,"type":"object","properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"description":"Length of the article in words.","type":"number"},{"pattern":"auto","type":"string"}]},"keep_title":{"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string"},"persona_id":{"type":"string"},"use_cta":{"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"type":"boolean"},"use_indexed_pages_internal_links":{"type":"boolean"},"use_wp_internal_links":{"type":"boolean"},"use_shopify_internal_links":{"type":"boolean"},"use_app_internal_links":{"type":"boolean"},"use_list_internal_links":{"type":"boolean"},"internal_links_wp_status":{"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string"},"publishwordpress_category":{"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string"},"use_inlinephotos":{"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":true,"type":"object","properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"description":"Length of the article in words.","type":"number"},{"pattern":"auto","type":"string"}]},"keep_title":{"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string"},"persona_id":{"type":"string"},"use_cta":{"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"type":"boolean"},"use_indexed_pages_internal_links":{"type":"boolean"},"use_wp_internal_links":{"type":"boolean"},"use_shopify_internal_links":{"type":"boolean"},"use_app_internal_links":{"type":"boolean"},"use_list_internal_links":{"type":"boolean"},"internal_links_wp_status":{"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string"},"publishwordpress_category":{"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string"},"use_inlinephotos":{"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}}}},"responses":{"200":{"description":"The updated articles","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{"id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"},"name":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"title":{"type":"string"},"data":{"type":"object","required":["input"],"properties":{"input":{"additionalProperties":true,"type":"object","properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}}},"status":{"enum":["queued","running","success","error"],"type":"string"},"status_detail":{"type":"string"},"last_output_id":{"format":"uuid","type":"string"},"project_id":{"format":"uuid","type":"string"},"maker_id":{"format":"uuid","type":"string"},"source":{"enum":["app","autopilot","feed","api","merlin"],"description":"Where the content comes from, written by the API on creation (null = unknown)","type":["string","null"]},"cover_image":{"type":"string"},"is_published":{"type":"boolean"},"placed_resources":{"description":"The article's resources (data.input.resources) that came out as a block in its HTML, in the order of the article: an empty list means none was placed. Read from the current HTML: an article edited by hand afterwards may differ from what was written. Present once the article is written and carries a resource list.","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"description":"Title of the resource, as the list holds it.","type":"string"},"url":{"description":"Its link, as the list holds it.","type":"string"}}}}},"description":"The updated articles"}}}}},"operationId":"patchV1ArticlesById"}},"/v1/articles/{id}/output":{"get":{"tags":["articles"],"summary":"Get the result of articles","description":"If no outputId is provided, the latest output will be returned","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"outputId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The articles output","content":{"application/json":{"schema":{"description":"The articles output","type":"object","required":["id","all_outputs","output"],"properties":{"id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"all_outputs":{"type":"array","items":{"type":"object","required":["id","created_at"],"properties":{"id":{"type":"string"},"created_at":{"type":"string"}}}},"input":{"additionalProperties":true,"type":"object","properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}},"output":{"additionalProperties":true,"type":"object","properties":{"h1":{"type":"string"},"content":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"keywords_analysis":{"type":"array","items":{"type":"object","properties":{"keyword":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"occurences_minimum_number":{"type":"number"},"occurences_maximum_number":{"type":"number"}}}},"url":{"type":"string"},"cover":{"type":"number"},"cover_image":{"type":"string"},"cover_images":{"type":"array","items":{"type":"string"}},"faq":{"type":"string"},"information_search":{"type":"string"},"social":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"facebook":{"type":"string"},"x":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"root_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}}},"audio":{"type":"string"}}},"status":{"type":"string"}},"additionalProperties":false}}}}},"operationId":"getV1ArticlesByIdOutput"}},"/v1/articles/{id}/output/{outputId}":{"patch":{"tags":["articles"],"summary":"Update the result of articles","description":"If no outputId is provided, the latest output will be returned","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"outputId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{"h1":{"type":"string"},"content":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"keywords_analysis":{"type":"array","items":{"type":"object","properties":{"keyword":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"occurences_minimum_number":{"type":"number"},"occurences_maximum_number":{"type":"number"}}}},"url":{"type":"string"},"cover":{"type":"number"},"cover_image":{"type":"string"},"cover_images":{"type":"array","items":{"type":"string"}},"faq":{"type":"string"},"information_search":{"type":"string"},"social":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"facebook":{"type":"string"},"x":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"root_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}}},"audio":{"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":true,"type":"object","properties":{"h1":{"type":"string"},"content":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"keywords_analysis":{"type":"array","items":{"type":"object","properties":{"keyword":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"occurences_minimum_number":{"type":"number"},"occurences_maximum_number":{"type":"number"}}}},"url":{"type":"string"},"cover":{"type":"number"},"cover_image":{"type":"string"},"cover_images":{"type":"array","items":{"type":"string"}},"faq":{"type":"string"},"information_search":{"type":"string"},"social":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"facebook":{"type":"string"},"x":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"root_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}}},"audio":{"type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":true,"type":"object","properties":{"h1":{"type":"string"},"content":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"keywords_analysis":{"type":"array","items":{"type":"object","properties":{"keyword":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"occurences_minimum_number":{"type":"number"},"occurences_maximum_number":{"type":"number"}}}},"url":{"type":"string"},"cover":{"type":"number"},"cover_image":{"type":"string"},"cover_images":{"type":"array","items":{"type":"string"}},"faq":{"type":"string"},"information_search":{"type":"string"},"social":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"facebook":{"type":"string"},"x":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"root_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}}},"audio":{"type":"string"}}}}}},"responses":{"200":{"description":"The articles output","content":{"application/json":{"schema":{"description":"The articles output","type":"object","required":["id","output"],"properties":{"id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"output":{"additionalProperties":true,"type":"object","properties":{"h1":{"type":"string"},"content":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"keywords_analysis":{"type":"array","items":{"type":"object","properties":{"keyword":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"occurences_minimum_number":{"type":"number"},"occurences_maximum_number":{"type":"number"}}}},"url":{"type":"string"},"cover":{"type":"number"},"cover_image":{"type":"string"},"cover_images":{"type":"array","items":{"type":"string"}},"faq":{"type":"string"},"information_search":{"type":"string"},"social":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"facebook":{"type":"string"},"x":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"root_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}}},"audio":{"type":"string"}}}},"additionalProperties":false}}}}},"operationId":"patchV1ArticlesByIdOutputByOutputId"}},"/v1/articles/bulk":{"post":{"tags":["articles"],"summary":"Create multiple articles","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}}},"application/x-www-form-urlencoded":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}}},"multipart/form-data":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}}}}},"responses":{"200":{"description":"The ids of the created articles","content":{"application/json":{"schema":{"description":"The ids of the created articles","type":"object","required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}}}},"operationId":"postV1ArticlesBulk"}},"/v1/articles/cost":{"post":{"tags":["articles"],"summary":"Get the cost of creating one articles","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}}}},"responses":{"200":{"description":"Get the cost of creating one articles and remaining credits","content":{"application/json":{"schema":{"description":"Get the cost of creating one articles and remaining credits","type":"object","required":["credits","cost"],"properties":{"credits":{"type":"number"},"cost":{"type":"number"}},"additionalProperties":false}}}}},"operationId":"postV1ArticlesCost"}},"/v1/articles/bulk/cost":{"post":{"tags":["articles"],"summary":"Get the cost of creating multiple articles","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}}},"application/x-www-form-urlencoded":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}}},"multipart/form-data":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}}}}},"responses":{"200":{"description":"The cost of creating multiple articles and remaining credits","content":{"application/json":{"schema":{"description":"The cost of creating multiple articles and remaining credits","type":"object","required":["credits","cost"],"properties":{"credits":{"type":"number"},"cost":{"type":"number"}},"additionalProperties":false}}}}},"operationId":"postV1ArticlesBulkCost"}},"/v1/articles/{id}/run":{"post":{"tags":["articles"],"summary":"Run a articles","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{}},"application/x-www-form-urlencoded":{"schema":{}},"multipart/form-data":{"schema":{}}}},"responses":{"200":{"description":"The id of the articles","content":{"application/json":{"schema":{"description":"The id of the articles","type":"object","required":["id","status"],"properties":{"id":{"type":"string"},"status":{"type":"string"}},"additionalProperties":false}}}}},"operationId":"postV1ArticlesByIdRun"}},"/v1/connections/":{"get":{"tags":["connections"],"summary":"List connections","parameters":[{"name":"search","in":"query","required":false,"schema":{"type":"string"}},{"name":"skip","in":"query","required":false,"schema":{"default":0,"anyOf":[{"default":0,"format":"numeric","type":"string"},{"default":0,"type":"number"}]}},{"name":"take","in":"query","required":false,"schema":{"default":100,"maximum":100,"anyOf":[{"default":0,"maximum":100,"format":"numeric","type":"string"},{"default":100,"maximum":100,"type":"number"}]}},{"name":"extra_fields","in":"query","required":false,"schema":{"type":"object","properties":{"feeds_infos":{"default":false,"type":"boolean"}}}}],"responses":{"200":{"description":"The list of connections","content":{"application/json":{"schema":{"description":"The list of connections","type":"object","required":["items","count"],"properties":{"items":{"type":"array","items":{}},"count":{"type":"number"}},"additionalProperties":false}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}},"additionalProperties":false}}}},"500":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}},"additionalProperties":false}}}}},"operationId":"getV1Connections"},"post":{"tags":["connections"],"summary":"Create connections","requestBody":{"description":"The connection","required":true,"content":{"application/json":{"schema":{"description":"The connection","anyOf":[{"description":"The WordPress connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["wordpress"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","properties":{"url":{"type":"string"},"login":{"type":"string"},"authors":{"type":"array","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"number"},"name":{"type":"string"}}}},"categories":{"type":"array","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"number"},"name":{"type":"string"}}}}}},"encrypted_data":{"type":"object","required":["password"],"properties":{"password":{"type":"string"}}}}},{"description":"The webhook connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["webhook"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"encrypted_data":{"type":"object","required":["password"],"properties":{"password":{"type":"string"}}}}},{"description":"The Shopify connection","type":"object","required":["type"],"properties":{"type":{"enum":["shopify"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","properties":{"url":{"type":"string"},"shop":{"type":"string"},"shop_id":{"type":"string"},"blog_id":{"type":"string"},"blog_handle":{"type":"string"}}},"encrypted_data":{"type":"object","required":["access_token"],"properties":{"access_token":{"type":"string"},"scope":{"type":"string"},"refresh_token":{"type":"string"},"expires_at":{"type":"number"}}}}},{"description":"The PrestaShop connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["prestashop"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"encrypted_data":{"type":"object","required":["client_id","client_secret"],"properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"}}}}},{"description":"The WooCommerce connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["woocommerce"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"encrypted_data":{"type":"object","required":["client_id","client_secret"],"properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"}}}}},{"description":"The Google Search Console connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["gsc"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","properties":{}},"encrypted_data":{"type":"object","required":["refresh_token"],"properties":{"refresh_token":{"type":"string"}}}}}]}},"application/x-www-form-urlencoded":{"schema":{"description":"The connection","anyOf":[{"description":"The WordPress connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["wordpress"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","properties":{"url":{"type":"string"},"login":{"type":"string"},"authors":{"type":"array","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"number"},"name":{"type":"string"}}}},"categories":{"type":"array","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"number"},"name":{"type":"string"}}}}}},"encrypted_data":{"type":"object","required":["password"],"properties":{"password":{"type":"string"}}}}},{"description":"The webhook connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["webhook"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"encrypted_data":{"type":"object","required":["password"],"properties":{"password":{"type":"string"}}}}},{"description":"The Shopify connection","type":"object","required":["type"],"properties":{"type":{"enum":["shopify"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","properties":{"url":{"type":"string"},"shop":{"type":"string"},"shop_id":{"type":"string"},"blog_id":{"type":"string"},"blog_handle":{"type":"string"}}},"encrypted_data":{"type":"object","required":["access_token"],"properties":{"access_token":{"type":"string"},"scope":{"type":"string"},"refresh_token":{"type":"string"},"expires_at":{"type":"number"}}}}},{"description":"The PrestaShop connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["prestashop"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"encrypted_data":{"type":"object","required":["client_id","client_secret"],"properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"}}}}},{"description":"The WooCommerce connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["woocommerce"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"encrypted_data":{"type":"object","required":["client_id","client_secret"],"properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"}}}}},{"description":"The Google Search Console connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["gsc"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","properties":{}},"encrypted_data":{"type":"object","required":["refresh_token"],"properties":{"refresh_token":{"type":"string"}}}}}]}},"multipart/form-data":{"schema":{"description":"The connection","anyOf":[{"description":"The WordPress connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["wordpress"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","properties":{"url":{"type":"string"},"login":{"type":"string"},"authors":{"type":"array","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"number"},"name":{"type":"string"}}}},"categories":{"type":"array","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"number"},"name":{"type":"string"}}}}}},"encrypted_data":{"type":"object","required":["password"],"properties":{"password":{"type":"string"}}}}},{"description":"The webhook connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["webhook"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"encrypted_data":{"type":"object","required":["password"],"properties":{"password":{"type":"string"}}}}},{"description":"The Shopify connection","type":"object","required":["type"],"properties":{"type":{"enum":["shopify"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","properties":{"url":{"type":"string"},"shop":{"type":"string"},"shop_id":{"type":"string"},"blog_id":{"type":"string"},"blog_handle":{"type":"string"}}},"encrypted_data":{"type":"object","required":["access_token"],"properties":{"access_token":{"type":"string"},"scope":{"type":"string"},"refresh_token":{"type":"string"},"expires_at":{"type":"number"}}}}},{"description":"The PrestaShop connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["prestashop"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"encrypted_data":{"type":"object","required":["client_id","client_secret"],"properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"}}}}},{"description":"The WooCommerce connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["woocommerce"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"encrypted_data":{"type":"object","required":["client_id","client_secret"],"properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"}}}}},{"description":"The Google Search Console connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["gsc"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","properties":{}},"encrypted_data":{"type":"object","required":["refresh_token"],"properties":{"refresh_token":{"type":"string"}}}}}]}}}},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"500":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}}},"operationId":"postV1Connections"}},"/v1/connections/{id}":{"get":{"tags":["connections"],"summary":"Get connections","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"500":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}}},"operationId":"getV1ConnectionsById"},"patch":{"tags":["connections"],"summary":"Update connections","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The connection","required":true,"content":{"application/json":{"schema":{"description":"The connection","anyOf":[{"description":"The WordPress connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["wordpress"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","properties":{"url":{"type":"string"},"login":{"type":"string"},"authors":{"type":"array","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"number"},"name":{"type":"string"}}}},"categories":{"type":"array","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"number"},"name":{"type":"string"}}}}}},"encrypted_data":{"type":"object","required":["password"],"properties":{"password":{"type":"string"}}}}},{"description":"The webhook connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["webhook"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"encrypted_data":{"type":"object","required":["password"],"properties":{"password":{"type":"string"}}}}},{"description":"The Shopify connection","type":"object","required":["type"],"properties":{"type":{"enum":["shopify"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","properties":{"url":{"type":"string"},"shop":{"type":"string"},"shop_id":{"type":"string"},"blog_id":{"type":"string"},"blog_handle":{"type":"string"}}},"encrypted_data":{"type":"object","required":["access_token"],"properties":{"access_token":{"type":"string"},"scope":{"type":"string"},"refresh_token":{"type":"string"},"expires_at":{"type":"number"}}}}},{"description":"The PrestaShop connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["prestashop"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"encrypted_data":{"type":"object","required":["client_id","client_secret"],"properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"}}}}},{"description":"The WooCommerce connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["woocommerce"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"encrypted_data":{"type":"object","required":["client_id","client_secret"],"properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"}}}}},{"description":"The Google Search Console connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["gsc"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","properties":{}},"encrypted_data":{"type":"object","required":["refresh_token"],"properties":{"refresh_token":{"type":"string"}}}}}]}},"application/x-www-form-urlencoded":{"schema":{"description":"The connection","anyOf":[{"description":"The WordPress connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["wordpress"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","properties":{"url":{"type":"string"},"login":{"type":"string"},"authors":{"type":"array","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"number"},"name":{"type":"string"}}}},"categories":{"type":"array","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"number"},"name":{"type":"string"}}}}}},"encrypted_data":{"type":"object","required":["password"],"properties":{"password":{"type":"string"}}}}},{"description":"The webhook connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["webhook"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"encrypted_data":{"type":"object","required":["password"],"properties":{"password":{"type":"string"}}}}},{"description":"The Shopify connection","type":"object","required":["type"],"properties":{"type":{"enum":["shopify"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","properties":{"url":{"type":"string"},"shop":{"type":"string"},"shop_id":{"type":"string"},"blog_id":{"type":"string"},"blog_handle":{"type":"string"}}},"encrypted_data":{"type":"object","required":["access_token"],"properties":{"access_token":{"type":"string"},"scope":{"type":"string"},"refresh_token":{"type":"string"},"expires_at":{"type":"number"}}}}},{"description":"The PrestaShop connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["prestashop"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"encrypted_data":{"type":"object","required":["client_id","client_secret"],"properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"}}}}},{"description":"The WooCommerce connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["woocommerce"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"encrypted_data":{"type":"object","required":["client_id","client_secret"],"properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"}}}}},{"description":"The Google Search Console connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["gsc"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","properties":{}},"encrypted_data":{"type":"object","required":["refresh_token"],"properties":{"refresh_token":{"type":"string"}}}}}]}},"multipart/form-data":{"schema":{"description":"The connection","anyOf":[{"description":"The WordPress connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["wordpress"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","properties":{"url":{"type":"string"},"login":{"type":"string"},"authors":{"type":"array","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"number"},"name":{"type":"string"}}}},"categories":{"type":"array","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"number"},"name":{"type":"string"}}}}}},"encrypted_data":{"type":"object","required":["password"],"properties":{"password":{"type":"string"}}}}},{"description":"The webhook connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["webhook"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"encrypted_data":{"type":"object","required":["password"],"properties":{"password":{"type":"string"}}}}},{"description":"The Shopify connection","type":"object","required":["type"],"properties":{"type":{"enum":["shopify"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","properties":{"url":{"type":"string"},"shop":{"type":"string"},"shop_id":{"type":"string"},"blog_id":{"type":"string"},"blog_handle":{"type":"string"}}},"encrypted_data":{"type":"object","required":["access_token"],"properties":{"access_token":{"type":"string"},"scope":{"type":"string"},"refresh_token":{"type":"string"},"expires_at":{"type":"number"}}}}},{"description":"The PrestaShop connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["prestashop"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"encrypted_data":{"type":"object","required":["client_id","client_secret"],"properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"}}}}},{"description":"The WooCommerce connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["woocommerce"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"encrypted_data":{"type":"object","required":["client_id","client_secret"],"properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"}}}}},{"description":"The Google Search Console connection","type":"object","required":["type","encrypted_data"],"properties":{"type":{"enum":["gsc"],"type":"string"},"name":{"type":"string"},"data":{"type":"object","properties":{}},"encrypted_data":{"type":"object","required":["refresh_token"],"properties":{"refresh_token":{"type":"string"}}}}}]}}}},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"500":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}}},"operationId":"patchV1ConnectionsById"},"delete":{"tags":["connections"],"summary":"Delete connections","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The id of the deleted connection","content":{"application/json":{"schema":{"description":"The id of the deleted connection","type":"object","required":["id"],"properties":{"id":{"format":"uuid","type":"string"}}}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"500":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}}},"operationId":"deleteV1ConnectionsById"}},"/v1/connections/{id}/shopify/blogs":{"get":{"tags":["connections"],"summary":"List Shopify blogs for a connection","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"operationId":"getV1ConnectionsByIdShopifyBlogs"}},"/v1/connections/{id}/shopify/internal-link-targets":{"get":{"tags":["connections"],"summary":"Find Shopify internal-link targets for a topic","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"query","in":"query","required":true,"schema":{"description":"Article topic / target keyword to find links for","type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"default":10,"minimum":1,"maximum":50,"anyOf":[{"format":"numeric","default":0,"type":"string"},{"default":10,"minimum":1,"maximum":50,"type":"number"}]}},{"name":"types","in":"query","required":false,"schema":{"description":"Comma-separated resource types: products, collections, articles","type":"string"}}],"operationId":"getV1ConnectionsByIdShopifyInternal-link-targets"}},"/v1/connections/{id}/shopify/":{"patch":{"tags":["connections"],"summary":"Update a Shopify connection (blog / name)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"blog_id":{"type":"string"},"blog_handle":{"type":"string"},"name":{"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"blog_id":{"type":"string"},"blog_handle":{"type":"string"},"name":{"type":"string"}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"blog_id":{"type":"string"},"blog_handle":{"type":"string"},"name":{"type":"string"}}}}}},"operationId":"patchV1ConnectionsByIdShopify"}},"/v1/connections/{id}/wordpress/internal-link-targets":{"get":{"tags":["connections"],"summary":"Find WordPress internal-link targets for a topic","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"query","in":"query","required":true,"schema":{"description":"Article topic / target keyword to find links for","type":"string"}},{"name":"status","in":"query","required":false,"schema":{"description":"Comma-separated post statuses: publish, draft, future","type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"default":10,"minimum":1,"maximum":50,"anyOf":[{"format":"numeric","default":0,"type":"string"},{"default":10,"minimum":1,"maximum":50,"type":"number","anyOf":[{"default":0,"minimum":1,"maximum":50,"type":"string","format":"numeric"},{"default":10,"minimum":1,"maximum":50,"type":"number"}]}]}}],"operationId":"getV1ConnectionsByIdWordpressInternal-link-targets"}},"/v1/personas/":{"get":{"tags":["personas"],"summary":"List personas","parameters":[{"name":"search","in":"query","required":false,"schema":{"type":"string"}},{"name":"skip","in":"query","required":false,"schema":{"default":0,"anyOf":[{"default":0,"format":"numeric","type":"string"},{"default":0,"type":"number"}]}},{"name":"take","in":"query","required":false,"schema":{"default":100,"maximum":100,"anyOf":[{"default":0,"maximum":100,"format":"numeric","type":"string"},{"default":100,"maximum":100,"type":"number"}]}},{"name":"extra_fields","in":"query","required":false,"schema":{"type":"object","properties":{"feeds_infos":{"default":false,"type":"boolean"}}}}],"responses":{"200":{"description":"The list of personas","content":{"application/json":{"schema":{"description":"The list of personas","type":"object","required":["items","count"],"properties":{"items":{"type":"array","items":{"description":"The persona","type":"object","required":["id","user_id"],"properties":{"id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"},"created_at":{"type":"string"},"last_example":{"type":"string"},"type":{"enum":["user","system"],"type":"string"},"resume":{"allOf":[{"type":"string"},{"type":"string"}]},"name":{"type":"string"},"style":{"type":"string"},"picture":{"default":"1","type":"string"}},"additionalProperties":false}},"count":{"default":0,"type":"number"}},"additionalProperties":false}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}},"additionalProperties":false}}}},"500":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}},"additionalProperties":false}}}}},"operationId":"getV1Personas"},"post":{"tags":["personas"],"summary":"Create personas","requestBody":{"description":"The persona","required":true,"content":{"application/json":{"schema":{"description":"The persona","type":"object","properties":{"name":{"type":"string"},"style":{"type":"string"},"resume":{"type":"string"},"picture":{"default":"1","type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"description":"The persona","type":"object","properties":{"name":{"type":"string"},"style":{"type":"string"},"resume":{"type":"string"},"picture":{"default":"1","type":"string"}}}},"multipart/form-data":{"schema":{"description":"The persona","type":"object","properties":{"name":{"type":"string"},"style":{"type":"string"},"resume":{"type":"string"},"picture":{"default":"1","type":"string"}}}}}},"responses":{"200":{"description":"The persona","content":{"application/json":{"schema":{"description":"The persona","type":"object","required":["id","user_id"],"properties":{"id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"},"created_at":{"type":"string"},"last_example":{"type":"string"},"type":{"enum":["user","system"],"type":"string"},"resume":{"allOf":[{"type":"string"},{"type":"string"}]},"name":{"type":"string"},"style":{"type":"string"},"picture":{"default":"1","type":"string"}},"additionalProperties":false}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"500":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}}},"operationId":"postV1Personas"}},"/v1/personas/{id}":{"get":{"tags":["personas"],"summary":"Get personas","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The persona","content":{"application/json":{"schema":{"description":"The persona","type":"object","required":["id","user_id"],"properties":{"id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"},"created_at":{"type":"string"},"last_example":{"type":"string"},"type":{"enum":["user","system"],"type":"string"},"resume":{"allOf":[{"type":"string"},{"type":"string"}]},"name":{"type":"string"},"style":{"type":"string"},"picture":{"default":"1","type":"string"}},"additionalProperties":false}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}},"additionalProperties":false}}}},"500":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}},"additionalProperties":false}}}}},"operationId":"getV1PersonasById"},"patch":{"tags":["personas"],"summary":"Update personas","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The persona","required":true,"content":{"application/json":{"schema":{"description":"The persona","type":"object","properties":{"name":{"type":"string"},"style":{"type":"string"},"resume":{"type":"string"},"picture":{"default":"1","type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"description":"The persona","type":"object","properties":{"name":{"type":"string"},"style":{"type":"string"},"resume":{"type":"string"},"picture":{"default":"1","type":"string"}}}},"multipart/form-data":{"schema":{"description":"The persona","type":"object","properties":{"name":{"type":"string"},"style":{"type":"string"},"resume":{"type":"string"},"picture":{"default":"1","type":"string"}}}}}},"responses":{"200":{"description":"The persona","content":{"application/json":{"schema":{"description":"The persona","type":"object","required":["id","user_id"],"properties":{"id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"},"created_at":{"type":"string"},"last_example":{"type":"string"},"type":{"enum":["user","system"],"type":"string"},"resume":{"allOf":[{"type":"string"},{"type":"string"}]},"name":{"type":"string"},"style":{"type":"string"},"picture":{"default":"1","type":"string"}},"additionalProperties":false}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"500":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}}},"operationId":"patchV1PersonasById"},"delete":{"tags":["personas"],"summary":"Delete personas","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The id of the deleted persona","content":{"application/json":{"schema":{"description":"The id of the deleted persona","type":"object","required":["id"],"properties":{"id":{"format":"uuid","type":"string"}}}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"500":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}}},"operationId":"deleteV1PersonasById"}},"/v1/projects/":{"get":{"tags":["projects"],"summary":"List projects","parameters":[{"name":"search","in":"query","required":false,"schema":{"type":"string"}},{"name":"skip","in":"query","required":false,"schema":{"default":0,"anyOf":[{"default":0,"format":"numeric","type":"string"},{"default":0,"type":"number"}]}},{"name":"take","in":"query","required":false,"schema":{"default":100,"maximum":100,"anyOf":[{"default":0,"maximum":100,"format":"numeric","type":"string"},{"default":100,"maximum":100,"type":"number"}]}},{"name":"extra_fields","in":"query","required":false,"schema":{"type":"object","properties":{"feeds_infos":{"default":false,"type":"boolean"}}}},{"name":"autopilot","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"format":"boolean","default":false,"type":"string"}]}}],"responses":{"200":{"description":"The list of projects","content":{"application/json":{"schema":{"description":"The list of projects","type":"object","required":["items","count"],"properties":{"items":{"type":"array","items":{"description":"The project","additionalProperties":true,"type":"object","required":["id"],"properties":{"id":{"format":"uuid","type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"paused_at":{"type":["string","null"]},"title":{"type":"string"},"website":{"type":"string"},"connection":{"type":"string"},"category":{"type":"number"},"author":{"type":"number"},"persona":{"type":"string"},"brief":{"type":"string"},"color":{"enum":["purple","gray","red","orange","yellow","green","blue"],"type":"string"},"feeds_config":{"type":"object","properties":{"quota_value":{"default":0,"description":"The number of currently generated entities since the start of the quota_period. If the quota_period is 'day', the quota_value start at midnight. If the quota_period is 'week', the quota_value start on monday at midnight. If the quota_period is 'month', the quota_value start on the first day of the month at midnight.","type":"number"},"quota_limit":{"default":1,"description":"The maximum number of entities that can be generated per quota_period.","type":"number"},"quota_period":{"enum":["day","week","month"],"default":"day","description":"The period of the quota (day, week or month). See the description of the quota_value for more information.","type":"string"},"is_quota_active":{"default":true,"description":"Whether the quota is active.","type":"boolean"}}},"feeds_count":{"description":"The number of feeds in the project.","type":"number"},"quota_value":{"type":"number"},"quota_limit":{"type":"number"},"quota_period":{"type":"string"},"is_quota_active":{"type":"boolean"},"is_brief_config_active":{"description":"Whether the brief config is active.","type":"boolean"},"autopilot":{"description":"Whether the project is managed in autopilot mode (lists in the autopilot sidebar).","type":"boolean"},"sells_what":{"description":"Free-text answer to \"what does this project sell?\".","type":"string"},"sells_to_whom":{"description":"Free-text answer to \"who is the target audience?\".","type":"string"},"six_month_success":{"description":"Free-text answer to \"what would a successful 6-month outcome look like?\".","type":"string"},"sitemap_url":{"description":"Sitemap URL persisted at first-run so resume / regenerate flows re-trigger the audit-plan job without re-probing /sitemap.xml.","type":["string","null"]},"clusters":{"description":"Editorial clusters generated by the autopilot audit-plan job (uuid → title, used to color cards on the planning page).","type":"array","items":{"additionalProperties":true,"type":"object","properties":{"uuid":{"type":"string"},"title":{"type":"string"},"parent_id":{"type":["string","null"]},"description":{"type":"string"}}}},"plan_directives":{"maxItems":200,"description":"Autopilot editorial steering. Two formats share this array, told apart by `cluster_id`. THEME (`cluster_id` set, pointing at a root entry of `clusters`): `weight` is the presence level — 10 (un peu) / 20 (normal) / 30 (beaucoup) — read relatively against the other themes covering the same calendar week, which together cover the whole week. LEGACY (no `cluster_id`): `weight`% of the contents scheduled between `from` and `to` must serve `instruction`, and the uncovered share is planned normally. `to: null` means open-ended. Ranges may overlap. Applied by the audit-plan job, which allocates the slots deterministically before the LLM call. Takes effect on the next planning run — pass `replan_card_ids` to POST /v1/jobs/projet-audit-plan to rebuild the upcoming days right away.","type":"array","items":{"type":"object","required":["id","from","weight"],"properties":{"id":{"type":"string"},"from":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"to":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":["string","null"]},"instruction":{"maxLength":500,"type":"string"},"weight":{"minimum":1,"maximum":100,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":1,"maximum":100,"type":"integer"}]},"cluster_id":{"type":"string"}}}},"brief_config":{"additionalProperties":true,"type":"object","properties":{"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"},"style_guide_primary_color":{"description":"Primary color for style guide (hex format). Falls back to image_primary_color if not set.","type":"string"},"publishshopify_blogs":{"description":"Blogs this project publishes to, with their share of the planning. A single entry (or none) keeps the historical single-blog behaviour.","type":"array","items":{"additionalProperties":true,"type":"object","required":["handle"],"properties":{"handle":{"description":"Blog handle, as it appears in the store URLs.","type":"string"},"id":{"description":"Blog GID. Unknown until the store is connected — the handle alone is enough to publish.","type":"string"},"title":{"type":"string"},"share":{"minimum":0,"maximum":100,"description":"Percentage of the planned days that go to this blog. Normalized to a total of 100 at read time; equal split when unset.","type":"number"},"scope":{"description":"The user's own description of this blog's editorial line. Takes precedence over scope_auto.","type":["string","null"]},"scope_auto":{"description":"Editorial line deduced by the audit from the blog's existing articles. Never overwrites `scope`.","type":["string","null"]}}}}}}}}},"count":{"type":"number"}},"additionalProperties":false}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}},"additionalProperties":false}}}},"500":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}},"additionalProperties":false}}}}},"operationId":"getV1Projects"},"post":{"tags":["projects"],"summary":"Create projects","requestBody":{"description":"The project","required":true,"content":{"application/json":{"schema":{"description":"The project","additionalProperties":true,"type":"object","properties":{"title":{"type":"string"},"website":{"type":"string"},"connection":{"type":"string"},"category":{"type":"number"},"author":{"type":"number"},"persona":{"type":"string"},"brief":{"type":"string"},"color":{"enum":["purple","gray","red","orange","yellow","green","blue"],"type":"string"},"feeds_config":{"type":"object","properties":{"quota_value":{"default":0,"description":"The number of currently generated entities since the start of the quota_period. If the quota_period is 'day', the quota_value start at midnight. If the quota_period is 'week', the quota_value start on monday at midnight. If the quota_period is 'month', the quota_value start on the first day of the month at midnight.","type":"number"},"quota_limit":{"default":1,"description":"The maximum number of entities that can be generated per quota_period.","type":"number"},"quota_period":{"enum":["day","week","month"],"default":"day","description":"The period of the quota (day, week or month). See the description of the quota_value for more information.","type":"string"},"is_quota_active":{"default":true,"description":"Whether the quota is active.","type":"boolean"}}},"feeds_count":{"description":"The number of feeds in the project.","type":"number"},"quota_value":{"type":"number"},"quota_limit":{"type":"number"},"quota_period":{"type":"string"},"is_quota_active":{"type":"boolean"},"is_brief_config_active":{"description":"Whether the brief config is active.","type":"boolean"},"autopilot":{"description":"Whether the project is managed in autopilot mode (lists in the autopilot sidebar).","type":"boolean"},"sells_what":{"description":"Free-text answer to \"what does this project sell?\".","type":"string"},"sells_to_whom":{"description":"Free-text answer to \"who is the target audience?\".","type":"string"},"six_month_success":{"description":"Free-text answer to \"what would a successful 6-month outcome look like?\".","type":"string"},"sitemap_url":{"description":"Sitemap URL persisted at first-run so resume / regenerate flows re-trigger the audit-plan job without re-probing /sitemap.xml.","type":["string","null"]},"clusters":{"description":"Editorial clusters generated by the autopilot audit-plan job (uuid → title, used to color cards on the planning page).","type":"array","items":{"additionalProperties":true,"type":"object","properties":{"uuid":{"type":"string"},"title":{"type":"string"},"parent_id":{"type":["string","null"]},"description":{"type":"string"}}}},"plan_directives":{"maxItems":200,"description":"Autopilot editorial steering. Two formats share this array, told apart by `cluster_id`. THEME (`cluster_id` set, pointing at a root entry of `clusters`): `weight` is the presence level — 10 (un peu) / 20 (normal) / 30 (beaucoup) — read relatively against the other themes covering the same calendar week, which together cover the whole week. LEGACY (no `cluster_id`): `weight`% of the contents scheduled between `from` and `to` must serve `instruction`, and the uncovered share is planned normally. `to: null` means open-ended. Ranges may overlap. Applied by the audit-plan job, which allocates the slots deterministically before the LLM call. Takes effect on the next planning run — pass `replan_card_ids` to POST /v1/jobs/projet-audit-plan to rebuild the upcoming days right away.","type":"array","items":{"type":"object","required":["id","from","weight"],"properties":{"id":{"type":"string"},"from":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"to":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":["string","null"]},"instruction":{"maxLength":500,"type":"string"},"weight":{"minimum":1,"maximum":100,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":1,"maximum":100,"type":"integer"}]},"cluster_id":{"type":"string"}}}},"brief_config":{"additionalProperties":true,"type":"object","properties":{"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"},"style_guide_primary_color":{"description":"Primary color for style guide (hex format). Falls back to image_primary_color if not set.","type":"string"},"publishshopify_blogs":{"description":"Blogs this project publishes to, with their share of the planning. A single entry (or none) keeps the historical single-blog behaviour.","type":"array","items":{"additionalProperties":true,"type":"object","required":["handle"],"properties":{"handle":{"description":"Blog handle, as it appears in the store URLs.","type":"string"},"id":{"description":"Blog GID. Unknown until the store is connected — the handle alone is enough to publish.","type":"string"},"title":{"type":"string"},"share":{"minimum":0,"maximum":100,"description":"Percentage of the planned days that go to this blog. Normalized to a total of 100 at read time; equal split when unset.","type":"number"},"scope":{"description":"The user's own description of this blog's editorial line. Takes precedence over scope_auto.","type":["string","null"]},"scope_auto":{"description":"Editorial line deduced by the audit from the blog's existing articles. Never overwrites `scope`.","type":["string","null"]}}}}}}}}},"application/x-www-form-urlencoded":{"schema":{"description":"The project","additionalProperties":true,"type":"object","properties":{"title":{"type":"string"},"website":{"type":"string"},"connection":{"type":"string"},"category":{"type":"number"},"author":{"type":"number"},"persona":{"type":"string"},"brief":{"type":"string"},"color":{"enum":["purple","gray","red","orange","yellow","green","blue"],"type":"string"},"feeds_config":{"type":"object","properties":{"quota_value":{"default":0,"description":"The number of currently generated entities since the start of the quota_period. If the quota_period is 'day', the quota_value start at midnight. If the quota_period is 'week', the quota_value start on monday at midnight. If the quota_period is 'month', the quota_value start on the first day of the month at midnight.","type":"number"},"quota_limit":{"default":1,"description":"The maximum number of entities that can be generated per quota_period.","type":"number"},"quota_period":{"enum":["day","week","month"],"default":"day","description":"The period of the quota (day, week or month). See the description of the quota_value for more information.","type":"string"},"is_quota_active":{"default":true,"description":"Whether the quota is active.","type":"boolean"}}},"feeds_count":{"description":"The number of feeds in the project.","type":"number"},"quota_value":{"type":"number"},"quota_limit":{"type":"number"},"quota_period":{"type":"string"},"is_quota_active":{"type":"boolean"},"is_brief_config_active":{"description":"Whether the brief config is active.","type":"boolean"},"autopilot":{"description":"Whether the project is managed in autopilot mode (lists in the autopilot sidebar).","type":"boolean"},"sells_what":{"description":"Free-text answer to \"what does this project sell?\".","type":"string"},"sells_to_whom":{"description":"Free-text answer to \"who is the target audience?\".","type":"string"},"six_month_success":{"description":"Free-text answer to \"what would a successful 6-month outcome look like?\".","type":"string"},"sitemap_url":{"description":"Sitemap URL persisted at first-run so resume / regenerate flows re-trigger the audit-plan job without re-probing /sitemap.xml.","type":["string","null"]},"clusters":{"description":"Editorial clusters generated by the autopilot audit-plan job (uuid → title, used to color cards on the planning page).","type":"array","items":{"additionalProperties":true,"type":"object","properties":{"uuid":{"type":"string"},"title":{"type":"string"},"parent_id":{"type":["string","null"]},"description":{"type":"string"}}}},"plan_directives":{"maxItems":200,"description":"Autopilot editorial steering. Two formats share this array, told apart by `cluster_id`. THEME (`cluster_id` set, pointing at a root entry of `clusters`): `weight` is the presence level — 10 (un peu) / 20 (normal) / 30 (beaucoup) — read relatively against the other themes covering the same calendar week, which together cover the whole week. LEGACY (no `cluster_id`): `weight`% of the contents scheduled between `from` and `to` must serve `instruction`, and the uncovered share is planned normally. `to: null` means open-ended. Ranges may overlap. Applied by the audit-plan job, which allocates the slots deterministically before the LLM call. Takes effect on the next planning run — pass `replan_card_ids` to POST /v1/jobs/projet-audit-plan to rebuild the upcoming days right away.","type":"array","items":{"type":"object","required":["id","from","weight"],"properties":{"id":{"type":"string"},"from":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"to":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":["string","null"]},"instruction":{"maxLength":500,"type":"string"},"weight":{"minimum":1,"maximum":100,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":1,"maximum":100,"type":"integer"}]},"cluster_id":{"type":"string"}}}},"brief_config":{"additionalProperties":true,"type":"object","properties":{"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"},"style_guide_primary_color":{"description":"Primary color for style guide (hex format). Falls back to image_primary_color if not set.","type":"string"},"publishshopify_blogs":{"description":"Blogs this project publishes to, with their share of the planning. A single entry (or none) keeps the historical single-blog behaviour.","type":"array","items":{"additionalProperties":true,"type":"object","required":["handle"],"properties":{"handle":{"description":"Blog handle, as it appears in the store URLs.","type":"string"},"id":{"description":"Blog GID. Unknown until the store is connected — the handle alone is enough to publish.","type":"string"},"title":{"type":"string"},"share":{"minimum":0,"maximum":100,"description":"Percentage of the planned days that go to this blog. Normalized to a total of 100 at read time; equal split when unset.","type":"number"},"scope":{"description":"The user's own description of this blog's editorial line. Takes precedence over scope_auto.","type":["string","null"]},"scope_auto":{"description":"Editorial line deduced by the audit from the blog's existing articles. Never overwrites `scope`.","type":["string","null"]}}}}}}}}},"multipart/form-data":{"schema":{"description":"The project","additionalProperties":true,"type":"object","properties":{"title":{"type":"string"},"website":{"type":"string"},"connection":{"type":"string"},"category":{"type":"number"},"author":{"type":"number"},"persona":{"type":"string"},"brief":{"type":"string"},"color":{"enum":["purple","gray","red","orange","yellow","green","blue"],"type":"string"},"feeds_config":{"type":"object","properties":{"quota_value":{"default":0,"description":"The number of currently generated entities since the start of the quota_period. If the quota_period is 'day', the quota_value start at midnight. If the quota_period is 'week', the quota_value start on monday at midnight. If the quota_period is 'month', the quota_value start on the first day of the month at midnight.","type":"number"},"quota_limit":{"default":1,"description":"The maximum number of entities that can be generated per quota_period.","type":"number"},"quota_period":{"enum":["day","week","month"],"default":"day","description":"The period of the quota (day, week or month). See the description of the quota_value for more information.","type":"string"},"is_quota_active":{"default":true,"description":"Whether the quota is active.","type":"boolean"}}},"feeds_count":{"description":"The number of feeds in the project.","type":"number"},"quota_value":{"type":"number"},"quota_limit":{"type":"number"},"quota_period":{"type":"string"},"is_quota_active":{"type":"boolean"},"is_brief_config_active":{"description":"Whether the brief config is active.","type":"boolean"},"autopilot":{"description":"Whether the project is managed in autopilot mode (lists in the autopilot sidebar).","type":"boolean"},"sells_what":{"description":"Free-text answer to \"what does this project sell?\".","type":"string"},"sells_to_whom":{"description":"Free-text answer to \"who is the target audience?\".","type":"string"},"six_month_success":{"description":"Free-text answer to \"what would a successful 6-month outcome look like?\".","type":"string"},"sitemap_url":{"description":"Sitemap URL persisted at first-run so resume / regenerate flows re-trigger the audit-plan job without re-probing /sitemap.xml.","type":["string","null"]},"clusters":{"description":"Editorial clusters generated by the autopilot audit-plan job (uuid → title, used to color cards on the planning page).","type":"array","items":{"additionalProperties":true,"type":"object","properties":{"uuid":{"type":"string"},"title":{"type":"string"},"parent_id":{"type":["string","null"]},"description":{"type":"string"}}}},"plan_directives":{"maxItems":200,"description":"Autopilot editorial steering. Two formats share this array, told apart by `cluster_id`. THEME (`cluster_id` set, pointing at a root entry of `clusters`): `weight` is the presence level — 10 (un peu) / 20 (normal) / 30 (beaucoup) — read relatively against the other themes covering the same calendar week, which together cover the whole week. LEGACY (no `cluster_id`): `weight`% of the contents scheduled between `from` and `to` must serve `instruction`, and the uncovered share is planned normally. `to: null` means open-ended. Ranges may overlap. Applied by the audit-plan job, which allocates the slots deterministically before the LLM call. Takes effect on the next planning run — pass `replan_card_ids` to POST /v1/jobs/projet-audit-plan to rebuild the upcoming days right away.","type":"array","items":{"type":"object","required":["id","from","weight"],"properties":{"id":{"type":"string"},"from":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"to":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":["string","null"]},"instruction":{"maxLength":500,"type":"string"},"weight":{"minimum":1,"maximum":100,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":1,"maximum":100,"type":"integer"}]},"cluster_id":{"type":"string"}}}},"brief_config":{"additionalProperties":true,"type":"object","properties":{"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"},"style_guide_primary_color":{"description":"Primary color for style guide (hex format). Falls back to image_primary_color if not set.","type":"string"},"publishshopify_blogs":{"description":"Blogs this project publishes to, with their share of the planning. A single entry (or none) keeps the historical single-blog behaviour.","type":"array","items":{"additionalProperties":true,"type":"object","required":["handle"],"properties":{"handle":{"description":"Blog handle, as it appears in the store URLs.","type":"string"},"id":{"description":"Blog GID. Unknown until the store is connected — the handle alone is enough to publish.","type":"string"},"title":{"type":"string"},"share":{"minimum":0,"maximum":100,"description":"Percentage of the planned days that go to this blog. Normalized to a total of 100 at read time; equal split when unset.","type":"number"},"scope":{"description":"The user's own description of this blog's editorial line. Takes precedence over scope_auto.","type":["string","null"]},"scope_auto":{"description":"Editorial line deduced by the audit from the blog's existing articles. Never overwrites `scope`.","type":["string","null"]}}}}}}}}}}},"responses":{"200":{"description":"The project","content":{"application/json":{"schema":{"description":"The project","additionalProperties":true,"type":"object","required":["id"],"properties":{"id":{"format":"uuid","type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"paused_at":{"type":["string","null"]},"title":{"type":"string"},"website":{"type":"string"},"connection":{"type":"string"},"category":{"type":"number"},"author":{"type":"number"},"persona":{"type":"string"},"brief":{"type":"string"},"color":{"enum":["purple","gray","red","orange","yellow","green","blue"],"type":"string"},"feeds_config":{"type":"object","properties":{"quota_value":{"default":0,"description":"The number of currently generated entities since the start of the quota_period. If the quota_period is 'day', the quota_value start at midnight. If the quota_period is 'week', the quota_value start on monday at midnight. If the quota_period is 'month', the quota_value start on the first day of the month at midnight.","type":"number"},"quota_limit":{"default":1,"description":"The maximum number of entities that can be generated per quota_period.","type":"number"},"quota_period":{"enum":["day","week","month"],"default":"day","description":"The period of the quota (day, week or month). See the description of the quota_value for more information.","type":"string"},"is_quota_active":{"default":true,"description":"Whether the quota is active.","type":"boolean"}}},"feeds_count":{"description":"The number of feeds in the project.","type":"number"},"quota_value":{"type":"number"},"quota_limit":{"type":"number"},"quota_period":{"type":"string"},"is_quota_active":{"type":"boolean"},"is_brief_config_active":{"description":"Whether the brief config is active.","type":"boolean"},"autopilot":{"description":"Whether the project is managed in autopilot mode (lists in the autopilot sidebar).","type":"boolean"},"sells_what":{"description":"Free-text answer to \"what does this project sell?\".","type":"string"},"sells_to_whom":{"description":"Free-text answer to \"who is the target audience?\".","type":"string"},"six_month_success":{"description":"Free-text answer to \"what would a successful 6-month outcome look like?\".","type":"string"},"sitemap_url":{"description":"Sitemap URL persisted at first-run so resume / regenerate flows re-trigger the audit-plan job without re-probing /sitemap.xml.","type":["string","null"]},"clusters":{"description":"Editorial clusters generated by the autopilot audit-plan job (uuid → title, used to color cards on the planning page).","type":"array","items":{"additionalProperties":true,"type":"object","properties":{"uuid":{"type":"string"},"title":{"type":"string"},"parent_id":{"type":["string","null"]},"description":{"type":"string"}}}},"plan_directives":{"maxItems":200,"description":"Autopilot editorial steering. Two formats share this array, told apart by `cluster_id`. THEME (`cluster_id` set, pointing at a root entry of `clusters`): `weight` is the presence level — 10 (un peu) / 20 (normal) / 30 (beaucoup) — read relatively against the other themes covering the same calendar week, which together cover the whole week. LEGACY (no `cluster_id`): `weight`% of the contents scheduled between `from` and `to` must serve `instruction`, and the uncovered share is planned normally. `to: null` means open-ended. Ranges may overlap. Applied by the audit-plan job, which allocates the slots deterministically before the LLM call. Takes effect on the next planning run — pass `replan_card_ids` to POST /v1/jobs/projet-audit-plan to rebuild the upcoming days right away.","type":"array","items":{"type":"object","required":["id","from","weight"],"properties":{"id":{"type":"string"},"from":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"to":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":["string","null"]},"instruction":{"maxLength":500,"type":"string"},"weight":{"minimum":1,"maximum":100,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":1,"maximum":100,"type":"integer"}]},"cluster_id":{"type":"string"}}}},"brief_config":{"additionalProperties":true,"type":"object","properties":{"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"},"style_guide_primary_color":{"description":"Primary color for style guide (hex format). Falls back to image_primary_color if not set.","type":"string"},"publishshopify_blogs":{"description":"Blogs this project publishes to, with their share of the planning. A single entry (or none) keeps the historical single-blog behaviour.","type":"array","items":{"additionalProperties":true,"type":"object","required":["handle"],"properties":{"handle":{"description":"Blog handle, as it appears in the store URLs.","type":"string"},"id":{"description":"Blog GID. Unknown until the store is connected — the handle alone is enough to publish.","type":"string"},"title":{"type":"string"},"share":{"minimum":0,"maximum":100,"description":"Percentage of the planned days that go to this blog. Normalized to a total of 100 at read time; equal split when unset.","type":"number"},"scope":{"description":"The user's own description of this blog's editorial line. Takes precedence over scope_auto.","type":["string","null"]},"scope_auto":{"description":"Editorial line deduced by the audit from the blog's existing articles. Never overwrites `scope`.","type":["string","null"]}}}}}}}}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"500":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}}},"operationId":"postV1Projects"}},"/v1/projects/{id}":{"get":{"tags":["projects"],"summary":"Get projects","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The project","content":{"application/json":{"schema":{"description":"The project","additionalProperties":true,"type":"object","required":["id"],"properties":{"id":{"format":"uuid","type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"paused_at":{"type":["string","null"]},"title":{"type":"string"},"website":{"type":"string"},"connection":{"type":"string"},"category":{"type":"number"},"author":{"type":"number"},"persona":{"type":"string"},"brief":{"type":"string"},"color":{"enum":["purple","gray","red","orange","yellow","green","blue"],"type":"string"},"feeds_config":{"type":"object","properties":{"quota_value":{"default":0,"description":"The number of currently generated entities since the start of the quota_period. If the quota_period is 'day', the quota_value start at midnight. If the quota_period is 'week', the quota_value start on monday at midnight. If the quota_period is 'month', the quota_value start on the first day of the month at midnight.","type":"number"},"quota_limit":{"default":1,"description":"The maximum number of entities that can be generated per quota_period.","type":"number"},"quota_period":{"enum":["day","week","month"],"default":"day","description":"The period of the quota (day, week or month). See the description of the quota_value for more information.","type":"string"},"is_quota_active":{"default":true,"description":"Whether the quota is active.","type":"boolean"}}},"feeds_count":{"description":"The number of feeds in the project.","type":"number"},"quota_value":{"type":"number"},"quota_limit":{"type":"number"},"quota_period":{"type":"string"},"is_quota_active":{"type":"boolean"},"is_brief_config_active":{"description":"Whether the brief config is active.","type":"boolean"},"autopilot":{"description":"Whether the project is managed in autopilot mode (lists in the autopilot sidebar).","type":"boolean"},"sells_what":{"description":"Free-text answer to \"what does this project sell?\".","type":"string"},"sells_to_whom":{"description":"Free-text answer to \"who is the target audience?\".","type":"string"},"six_month_success":{"description":"Free-text answer to \"what would a successful 6-month outcome look like?\".","type":"string"},"sitemap_url":{"description":"Sitemap URL persisted at first-run so resume / regenerate flows re-trigger the audit-plan job without re-probing /sitemap.xml.","type":["string","null"]},"clusters":{"description":"Editorial clusters generated by the autopilot audit-plan job (uuid → title, used to color cards on the planning page).","type":"array","items":{"additionalProperties":true,"type":"object","properties":{"uuid":{"type":"string"},"title":{"type":"string"},"parent_id":{"type":["string","null"]},"description":{"type":"string"}}}},"plan_directives":{"maxItems":200,"description":"Autopilot editorial steering. Two formats share this array, told apart by `cluster_id`. THEME (`cluster_id` set, pointing at a root entry of `clusters`): `weight` is the presence level — 10 (un peu) / 20 (normal) / 30 (beaucoup) — read relatively against the other themes covering the same calendar week, which together cover the whole week. LEGACY (no `cluster_id`): `weight`% of the contents scheduled between `from` and `to` must serve `instruction`, and the uncovered share is planned normally. `to: null` means open-ended. Ranges may overlap. Applied by the audit-plan job, which allocates the slots deterministically before the LLM call. Takes effect on the next planning run — pass `replan_card_ids` to POST /v1/jobs/projet-audit-plan to rebuild the upcoming days right away.","type":"array","items":{"type":"object","required":["id","from","weight"],"properties":{"id":{"type":"string"},"from":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"to":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":["string","null"]},"instruction":{"maxLength":500,"type":"string"},"weight":{"minimum":1,"maximum":100,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":1,"maximum":100,"type":"integer"}]},"cluster_id":{"type":"string"}}}},"brief_config":{"additionalProperties":true,"type":"object","properties":{"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"},"style_guide_primary_color":{"description":"Primary color for style guide (hex format). Falls back to image_primary_color if not set.","type":"string"},"publishshopify_blogs":{"description":"Blogs this project publishes to, with their share of the planning. A single entry (or none) keeps the historical single-blog behaviour.","type":"array","items":{"additionalProperties":true,"type":"object","required":["handle"],"properties":{"handle":{"description":"Blog handle, as it appears in the store URLs.","type":"string"},"id":{"description":"Blog GID. Unknown until the store is connected — the handle alone is enough to publish.","type":"string"},"title":{"type":"string"},"share":{"minimum":0,"maximum":100,"description":"Percentage of the planned days that go to this blog. Normalized to a total of 100 at read time; equal split when unset.","type":"number"},"scope":{"description":"The user's own description of this blog's editorial line. Takes precedence over scope_auto.","type":["string","null"]},"scope_auto":{"description":"Editorial line deduced by the audit from the blog's existing articles. Never overwrites `scope`.","type":["string","null"]}}}}}}}}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}},"additionalProperties":false}}}},"500":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}},"additionalProperties":false}}}}},"operationId":"getV1ProjectsById"},"patch":{"tags":["projects"],"summary":"Update projects","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The project","required":true,"content":{"application/json":{"schema":{"description":"The project","additionalProperties":true,"type":"object","properties":{"title":{"type":"string"},"website":{"type":"string"},"connection":{"type":"string"},"category":{"type":"number"},"author":{"type":"number"},"persona":{"type":"string"},"brief":{"type":"string"},"color":{"enum":["purple","gray","red","orange","yellow","green","blue"],"type":"string"},"feeds_config":{"type":"object","properties":{"quota_value":{"default":0,"description":"The number of currently generated entities since the start of the quota_period. If the quota_period is 'day', the quota_value start at midnight. If the quota_period is 'week', the quota_value start on monday at midnight. If the quota_period is 'month', the quota_value start on the first day of the month at midnight.","type":"number"},"quota_limit":{"default":1,"description":"The maximum number of entities that can be generated per quota_period.","type":"number"},"quota_period":{"enum":["day","week","month"],"default":"day","description":"The period of the quota (day, week or month). See the description of the quota_value for more information.","type":"string"},"is_quota_active":{"default":true,"description":"Whether the quota is active.","type":"boolean"}}},"feeds_count":{"description":"The number of feeds in the project.","type":"number"},"quota_value":{"type":"number"},"quota_limit":{"type":"number"},"quota_period":{"type":"string"},"is_quota_active":{"type":"boolean"},"is_brief_config_active":{"description":"Whether the brief config is active.","type":"boolean"},"autopilot":{"description":"Whether the project is managed in autopilot mode (lists in the autopilot sidebar).","type":"boolean"},"sells_what":{"description":"Free-text answer to \"what does this project sell?\".","type":"string"},"sells_to_whom":{"description":"Free-text answer to \"who is the target audience?\".","type":"string"},"six_month_success":{"description":"Free-text answer to \"what would a successful 6-month outcome look like?\".","type":"string"},"sitemap_url":{"description":"Sitemap URL persisted at first-run so resume / regenerate flows re-trigger the audit-plan job without re-probing /sitemap.xml.","type":["string","null"]},"clusters":{"description":"Editorial clusters generated by the autopilot audit-plan job (uuid → title, used to color cards on the planning page).","type":"array","items":{"additionalProperties":true,"type":"object","properties":{"uuid":{"type":"string"},"title":{"type":"string"},"parent_id":{"type":["string","null"]},"description":{"type":"string"}}}},"plan_directives":{"maxItems":200,"description":"Autopilot editorial steering. Two formats share this array, told apart by `cluster_id`. THEME (`cluster_id` set, pointing at a root entry of `clusters`): `weight` is the presence level — 10 (un peu) / 20 (normal) / 30 (beaucoup) — read relatively against the other themes covering the same calendar week, which together cover the whole week. LEGACY (no `cluster_id`): `weight`% of the contents scheduled between `from` and `to` must serve `instruction`, and the uncovered share is planned normally. `to: null` means open-ended. Ranges may overlap. Applied by the audit-plan job, which allocates the slots deterministically before the LLM call. Takes effect on the next planning run — pass `replan_card_ids` to POST /v1/jobs/projet-audit-plan to rebuild the upcoming days right away.","type":"array","items":{"type":"object","required":["id","from","weight"],"properties":{"id":{"type":"string"},"from":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"to":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":["string","null"]},"instruction":{"maxLength":500,"type":"string"},"weight":{"minimum":1,"maximum":100,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":1,"maximum":100,"type":"integer"}]},"cluster_id":{"type":"string"}}}},"brief_config":{"additionalProperties":true,"type":"object","properties":{"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"},"style_guide_primary_color":{"description":"Primary color for style guide (hex format). Falls back to image_primary_color if not set.","type":"string"},"publishshopify_blogs":{"description":"Blogs this project publishes to, with their share of the planning. A single entry (or none) keeps the historical single-blog behaviour.","type":"array","items":{"additionalProperties":true,"type":"object","required":["handle"],"properties":{"handle":{"description":"Blog handle, as it appears in the store URLs.","type":"string"},"id":{"description":"Blog GID. Unknown until the store is connected — the handle alone is enough to publish.","type":"string"},"title":{"type":"string"},"share":{"minimum":0,"maximum":100,"description":"Percentage of the planned days that go to this blog. Normalized to a total of 100 at read time; equal split when unset.","type":"number"},"scope":{"description":"The user's own description of this blog's editorial line. Takes precedence over scope_auto.","type":["string","null"]},"scope_auto":{"description":"Editorial line deduced by the audit from the blog's existing articles. Never overwrites `scope`.","type":["string","null"]}}}}}}}}},"application/x-www-form-urlencoded":{"schema":{"description":"The project","additionalProperties":true,"type":"object","properties":{"title":{"type":"string"},"website":{"type":"string"},"connection":{"type":"string"},"category":{"type":"number"},"author":{"type":"number"},"persona":{"type":"string"},"brief":{"type":"string"},"color":{"enum":["purple","gray","red","orange","yellow","green","blue"],"type":"string"},"feeds_config":{"type":"object","properties":{"quota_value":{"default":0,"description":"The number of currently generated entities since the start of the quota_period. If the quota_period is 'day', the quota_value start at midnight. If the quota_period is 'week', the quota_value start on monday at midnight. If the quota_period is 'month', the quota_value start on the first day of the month at midnight.","type":"number"},"quota_limit":{"default":1,"description":"The maximum number of entities that can be generated per quota_period.","type":"number"},"quota_period":{"enum":["day","week","month"],"default":"day","description":"The period of the quota (day, week or month). See the description of the quota_value for more information.","type":"string"},"is_quota_active":{"default":true,"description":"Whether the quota is active.","type":"boolean"}}},"feeds_count":{"description":"The number of feeds in the project.","type":"number"},"quota_value":{"type":"number"},"quota_limit":{"type":"number"},"quota_period":{"type":"string"},"is_quota_active":{"type":"boolean"},"is_brief_config_active":{"description":"Whether the brief config is active.","type":"boolean"},"autopilot":{"description":"Whether the project is managed in autopilot mode (lists in the autopilot sidebar).","type":"boolean"},"sells_what":{"description":"Free-text answer to \"what does this project sell?\".","type":"string"},"sells_to_whom":{"description":"Free-text answer to \"who is the target audience?\".","type":"string"},"six_month_success":{"description":"Free-text answer to \"what would a successful 6-month outcome look like?\".","type":"string"},"sitemap_url":{"description":"Sitemap URL persisted at first-run so resume / regenerate flows re-trigger the audit-plan job without re-probing /sitemap.xml.","type":["string","null"]},"clusters":{"description":"Editorial clusters generated by the autopilot audit-plan job (uuid → title, used to color cards on the planning page).","type":"array","items":{"additionalProperties":true,"type":"object","properties":{"uuid":{"type":"string"},"title":{"type":"string"},"parent_id":{"type":["string","null"]},"description":{"type":"string"}}}},"plan_directives":{"maxItems":200,"description":"Autopilot editorial steering. Two formats share this array, told apart by `cluster_id`. THEME (`cluster_id` set, pointing at a root entry of `clusters`): `weight` is the presence level — 10 (un peu) / 20 (normal) / 30 (beaucoup) — read relatively against the other themes covering the same calendar week, which together cover the whole week. LEGACY (no `cluster_id`): `weight`% of the contents scheduled between `from` and `to` must serve `instruction`, and the uncovered share is planned normally. `to: null` means open-ended. Ranges may overlap. Applied by the audit-plan job, which allocates the slots deterministically before the LLM call. Takes effect on the next planning run — pass `replan_card_ids` to POST /v1/jobs/projet-audit-plan to rebuild the upcoming days right away.","type":"array","items":{"type":"object","required":["id","from","weight"],"properties":{"id":{"type":"string"},"from":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"to":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":["string","null"]},"instruction":{"maxLength":500,"type":"string"},"weight":{"minimum":1,"maximum":100,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":1,"maximum":100,"type":"integer"}]},"cluster_id":{"type":"string"}}}},"brief_config":{"additionalProperties":true,"type":"object","properties":{"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"},"style_guide_primary_color":{"description":"Primary color for style guide (hex format). Falls back to image_primary_color if not set.","type":"string"},"publishshopify_blogs":{"description":"Blogs this project publishes to, with their share of the planning. A single entry (or none) keeps the historical single-blog behaviour.","type":"array","items":{"additionalProperties":true,"type":"object","required":["handle"],"properties":{"handle":{"description":"Blog handle, as it appears in the store URLs.","type":"string"},"id":{"description":"Blog GID. Unknown until the store is connected — the handle alone is enough to publish.","type":"string"},"title":{"type":"string"},"share":{"minimum":0,"maximum":100,"description":"Percentage of the planned days that go to this blog. Normalized to a total of 100 at read time; equal split when unset.","type":"number"},"scope":{"description":"The user's own description of this blog's editorial line. Takes precedence over scope_auto.","type":["string","null"]},"scope_auto":{"description":"Editorial line deduced by the audit from the blog's existing articles. Never overwrites `scope`.","type":["string","null"]}}}}}}}}},"multipart/form-data":{"schema":{"description":"The project","additionalProperties":true,"type":"object","properties":{"title":{"type":"string"},"website":{"type":"string"},"connection":{"type":"string"},"category":{"type":"number"},"author":{"type":"number"},"persona":{"type":"string"},"brief":{"type":"string"},"color":{"enum":["purple","gray","red","orange","yellow","green","blue"],"type":"string"},"feeds_config":{"type":"object","properties":{"quota_value":{"default":0,"description":"The number of currently generated entities since the start of the quota_period. If the quota_period is 'day', the quota_value start at midnight. If the quota_period is 'week', the quota_value start on monday at midnight. If the quota_period is 'month', the quota_value start on the first day of the month at midnight.","type":"number"},"quota_limit":{"default":1,"description":"The maximum number of entities that can be generated per quota_period.","type":"number"},"quota_period":{"enum":["day","week","month"],"default":"day","description":"The period of the quota (day, week or month). See the description of the quota_value for more information.","type":"string"},"is_quota_active":{"default":true,"description":"Whether the quota is active.","type":"boolean"}}},"feeds_count":{"description":"The number of feeds in the project.","type":"number"},"quota_value":{"type":"number"},"quota_limit":{"type":"number"},"quota_period":{"type":"string"},"is_quota_active":{"type":"boolean"},"is_brief_config_active":{"description":"Whether the brief config is active.","type":"boolean"},"autopilot":{"description":"Whether the project is managed in autopilot mode (lists in the autopilot sidebar).","type":"boolean"},"sells_what":{"description":"Free-text answer to \"what does this project sell?\".","type":"string"},"sells_to_whom":{"description":"Free-text answer to \"who is the target audience?\".","type":"string"},"six_month_success":{"description":"Free-text answer to \"what would a successful 6-month outcome look like?\".","type":"string"},"sitemap_url":{"description":"Sitemap URL persisted at first-run so resume / regenerate flows re-trigger the audit-plan job without re-probing /sitemap.xml.","type":["string","null"]},"clusters":{"description":"Editorial clusters generated by the autopilot audit-plan job (uuid → title, used to color cards on the planning page).","type":"array","items":{"additionalProperties":true,"type":"object","properties":{"uuid":{"type":"string"},"title":{"type":"string"},"parent_id":{"type":["string","null"]},"description":{"type":"string"}}}},"plan_directives":{"maxItems":200,"description":"Autopilot editorial steering. Two formats share this array, told apart by `cluster_id`. THEME (`cluster_id` set, pointing at a root entry of `clusters`): `weight` is the presence level — 10 (un peu) / 20 (normal) / 30 (beaucoup) — read relatively against the other themes covering the same calendar week, which together cover the whole week. LEGACY (no `cluster_id`): `weight`% of the contents scheduled between `from` and `to` must serve `instruction`, and the uncovered share is planned normally. `to: null` means open-ended. Ranges may overlap. Applied by the audit-plan job, which allocates the slots deterministically before the LLM call. Takes effect on the next planning run — pass `replan_card_ids` to POST /v1/jobs/projet-audit-plan to rebuild the upcoming days right away.","type":"array","items":{"type":"object","required":["id","from","weight"],"properties":{"id":{"type":"string"},"from":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"to":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":["string","null"]},"instruction":{"maxLength":500,"type":"string"},"weight":{"minimum":1,"maximum":100,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":1,"maximum":100,"type":"integer"}]},"cluster_id":{"type":"string"}}}},"brief_config":{"additionalProperties":true,"type":"object","properties":{"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"},"style_guide_primary_color":{"description":"Primary color for style guide (hex format). Falls back to image_primary_color if not set.","type":"string"},"publishshopify_blogs":{"description":"Blogs this project publishes to, with their share of the planning. A single entry (or none) keeps the historical single-blog behaviour.","type":"array","items":{"additionalProperties":true,"type":"object","required":["handle"],"properties":{"handle":{"description":"Blog handle, as it appears in the store URLs.","type":"string"},"id":{"description":"Blog GID. Unknown until the store is connected — the handle alone is enough to publish.","type":"string"},"title":{"type":"string"},"share":{"minimum":0,"maximum":100,"description":"Percentage of the planned days that go to this blog. Normalized to a total of 100 at read time; equal split when unset.","type":"number"},"scope":{"description":"The user's own description of this blog's editorial line. Takes precedence over scope_auto.","type":["string","null"]},"scope_auto":{"description":"Editorial line deduced by the audit from the blog's existing articles. Never overwrites `scope`.","type":["string","null"]}}}}}}}}}}},"responses":{"200":{"description":"The project","content":{"application/json":{"schema":{"description":"The project","additionalProperties":true,"type":"object","required":["id"],"properties":{"id":{"format":"uuid","type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"paused_at":{"type":["string","null"]},"title":{"type":"string"},"website":{"type":"string"},"connection":{"type":"string"},"category":{"type":"number"},"author":{"type":"number"},"persona":{"type":"string"},"brief":{"type":"string"},"color":{"enum":["purple","gray","red","orange","yellow","green","blue"],"type":"string"},"feeds_config":{"type":"object","properties":{"quota_value":{"default":0,"description":"The number of currently generated entities since the start of the quota_period. If the quota_period is 'day', the quota_value start at midnight. If the quota_period is 'week', the quota_value start on monday at midnight. If the quota_period is 'month', the quota_value start on the first day of the month at midnight.","type":"number"},"quota_limit":{"default":1,"description":"The maximum number of entities that can be generated per quota_period.","type":"number"},"quota_period":{"enum":["day","week","month"],"default":"day","description":"The period of the quota (day, week or month). See the description of the quota_value for more information.","type":"string"},"is_quota_active":{"default":true,"description":"Whether the quota is active.","type":"boolean"}}},"feeds_count":{"description":"The number of feeds in the project.","type":"number"},"quota_value":{"type":"number"},"quota_limit":{"type":"number"},"quota_period":{"type":"string"},"is_quota_active":{"type":"boolean"},"is_brief_config_active":{"description":"Whether the brief config is active.","type":"boolean"},"autopilot":{"description":"Whether the project is managed in autopilot mode (lists in the autopilot sidebar).","type":"boolean"},"sells_what":{"description":"Free-text answer to \"what does this project sell?\".","type":"string"},"sells_to_whom":{"description":"Free-text answer to \"who is the target audience?\".","type":"string"},"six_month_success":{"description":"Free-text answer to \"what would a successful 6-month outcome look like?\".","type":"string"},"sitemap_url":{"description":"Sitemap URL persisted at first-run so resume / regenerate flows re-trigger the audit-plan job without re-probing /sitemap.xml.","type":["string","null"]},"clusters":{"description":"Editorial clusters generated by the autopilot audit-plan job (uuid → title, used to color cards on the planning page).","type":"array","items":{"additionalProperties":true,"type":"object","properties":{"uuid":{"type":"string"},"title":{"type":"string"},"parent_id":{"type":["string","null"]},"description":{"type":"string"}}}},"plan_directives":{"maxItems":200,"description":"Autopilot editorial steering. Two formats share this array, told apart by `cluster_id`. THEME (`cluster_id` set, pointing at a root entry of `clusters`): `weight` is the presence level — 10 (un peu) / 20 (normal) / 30 (beaucoup) — read relatively against the other themes covering the same calendar week, which together cover the whole week. LEGACY (no `cluster_id`): `weight`% of the contents scheduled between `from` and `to` must serve `instruction`, and the uncovered share is planned normally. `to: null` means open-ended. Ranges may overlap. Applied by the audit-plan job, which allocates the slots deterministically before the LLM call. Takes effect on the next planning run — pass `replan_card_ids` to POST /v1/jobs/projet-audit-plan to rebuild the upcoming days right away.","type":"array","items":{"type":"object","required":["id","from","weight"],"properties":{"id":{"type":"string"},"from":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"to":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":["string","null"]},"instruction":{"maxLength":500,"type":"string"},"weight":{"minimum":1,"maximum":100,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":1,"maximum":100,"type":"integer"}]},"cluster_id":{"type":"string"}}}},"brief_config":{"additionalProperties":true,"type":"object","properties":{"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"},"style_guide_primary_color":{"description":"Primary color for style guide (hex format). Falls back to image_primary_color if not set.","type":"string"},"publishshopify_blogs":{"description":"Blogs this project publishes to, with their share of the planning. A single entry (or none) keeps the historical single-blog behaviour.","type":"array","items":{"additionalProperties":true,"type":"object","required":["handle"],"properties":{"handle":{"description":"Blog handle, as it appears in the store URLs.","type":"string"},"id":{"description":"Blog GID. Unknown until the store is connected — the handle alone is enough to publish.","type":"string"},"title":{"type":"string"},"share":{"minimum":0,"maximum":100,"description":"Percentage of the planned days that go to this blog. Normalized to a total of 100 at read time; equal split when unset.","type":"number"},"scope":{"description":"The user's own description of this blog's editorial line. Takes precedence over scope_auto.","type":["string","null"]},"scope_auto":{"description":"Editorial line deduced by the audit from the blog's existing articles. Never overwrites `scope`.","type":["string","null"]}}}}}}}}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}},"additionalProperties":false}}}},"500":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}},"additionalProperties":false}}}}},"operationId":"patchV1ProjectsById"},"delete":{"tags":["projects"],"summary":"Delete projects","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The id of the deleted project","content":{"application/json":{"schema":{"description":"The id of the deleted project","type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"500":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}}},"operationId":"deleteV1ProjectsById"}},"/v1/projects/{id}/planning":{"get":{"tags":["projects"],"summary":"List the Autopilot planning of a project (≤ 90 days, default today → +30)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"from","in":"query","required":false,"schema":{"type":"string"}},{"name":"to","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["items","count"],"properties":{"items":{"type":"array","items":{"type":"object","required":["id","date","status","title","keyword"],"properties":{"id":{"type":"string"},"date":{"description":"YYYY-MM-DD in the project timezone","type":["string","null"]},"status":{"type":"string","enum":["planned","generating","done","failed"]},"title":{"type":"string"},"keyword":{"type":["string","null"]}}}},"count":{"type":"number"}}}}}}},"operationId":"getV1ProjectsByIdPlanning"},"post":{"tags":["projects"],"summary":"Add a card to the Autopilot planning","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["date","keyword"],"properties":{"date":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"YYYY-MM-DD in the project timezone","type":"string"},"keyword":{"minLength":1,"maxLength":200,"type":"string"},"title":{"maxLength":300,"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["date","keyword"],"properties":{"date":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"YYYY-MM-DD in the project timezone","type":"string"},"keyword":{"minLength":1,"maxLength":200,"type":"string"},"title":{"maxLength":300,"type":"string"}}}},"multipart/form-data":{"schema":{"type":"object","required":["date","keyword"],"properties":{"date":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"YYYY-MM-DD in the project timezone","type":"string"},"keyword":{"minLength":1,"maxLength":200,"type":"string"},"title":{"maxLength":300,"type":"string"}}}}}},"responses":{"201":{"description":"Response for status 201","content":{"application/json":{"schema":{"type":"object","required":["id","date","status","title","keyword"],"properties":{"id":{"type":"string"},"date":{"description":"YYYY-MM-DD in the project timezone","type":["string","null"]},"status":{"type":"string","enum":["planned","generating","done","failed"]},"title":{"type":"string"},"keyword":{"type":["string","null"]}}}}}}},"operationId":"postV1ProjectsByIdPlanning"}},"/v1/projects/{id}/planning/{cardId}":{"patch":{"tags":["projects"],"summary":"Move, rename or re-target a planned card","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"cardId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"date":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"YYYY-MM-DD in the project timezone","type":"string"},"keyword":{"minLength":1,"maxLength":200,"type":"string"},"title":{"minLength":1,"maxLength":300,"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"date":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"YYYY-MM-DD in the project timezone","type":"string"},"keyword":{"minLength":1,"maxLength":200,"type":"string"},"title":{"minLength":1,"maxLength":300,"type":"string"}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"date":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"YYYY-MM-DD in the project timezone","type":"string"},"keyword":{"minLength":1,"maxLength":200,"type":"string"},"title":{"minLength":1,"maxLength":300,"type":"string"}}}}}},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["id","date","status","title","keyword"],"properties":{"id":{"type":"string"},"date":{"description":"YYYY-MM-DD in the project timezone","type":["string","null"]},"status":{"type":"string","enum":["planned","generating","done","failed"]},"title":{"type":"string"},"keyword":{"type":["string","null"]}}}}}}},"operationId":"patchV1ProjectsByIdPlanningByCardId"},"delete":{"tags":["projects"],"summary":"Remove a planned card","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"cardId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}}},"operationId":"deleteV1ProjectsByIdPlanningByCardId"}},"/v1/projects/{id}/planning/replan":{"post":{"tags":["projects"],"summary":"Re-plan planned cards (same budget as the planning page)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["card_ids"],"properties":{"card_ids":{"minItems":1,"maxItems":30,"type":"array","items":{"type":"string"}}}}},"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["card_ids"],"properties":{"card_ids":{"minItems":1,"maxItems":30,"type":"array","items":{"type":"string"}}}}},"multipart/form-data":{"schema":{"type":"object","required":["card_ids"],"properties":{"card_ids":{"minItems":1,"maxItems":30,"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["ids","job_id"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"job_id":{"type":"string"}}}}}}},"operationId":"postV1ProjectsByIdPlanningReplan"}},"/v1/projects/{id}/autopilot/settings":{"get":{"tags":["projects"],"summary":"Autopilot rhythm of a project","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["articles_per_day","max_per_day","plan","articles_per_week","days"],"properties":{"articles_per_day":{"description":"Articles a day the planning runs at (wish capped by the plan)","type":"number"},"max_per_day":{"description":"15 on a live Pro or Agency plan, 1 otherwise","type":"number"},"plan":{"type":["string","null"],"enum":["starter","pro","agency"]},"articles_per_week":{"type":"number"},"days":{"type":"array","items":{"type":"string"}}}}}}}},"operationId":"getV1ProjectsByIdAutopilotSettings"},"put":{"tags":["projects"],"summary":"Set the Autopilot rhythm of a project (1 to 15 a day on Pro and Agency, 1 otherwise), re-planned from tomorrow","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["articles_per_day"],"properties":{"articles_per_day":{"minimum":1,"maximum":15,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":1,"maximum":15,"type":"integer"}]}}}},"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["articles_per_day"],"properties":{"articles_per_day":{"minimum":1,"maximum":15,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":1,"maximum":15,"type":"integer"}]}}}},"multipart/form-data":{"schema":{"type":"object","required":["articles_per_day"],"properties":{"articles_per_day":{"minimum":1,"maximum":15,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":1,"maximum":15,"type":"integer"}]}}}}}},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["articles_per_day","max_per_day","plan","articles_per_week","days","job_id"],"properties":{"articles_per_day":{"description":"Articles a day the planning runs at (wish capped by the plan)","type":"number"},"max_per_day":{"description":"15 on a live Pro or Agency plan, 1 otherwise","type":"number"},"plan":{"type":["string","null"],"enum":["starter","pro","agency"]},"articles_per_week":{"type":"number"},"days":{"type":"array","items":{"type":"string"}},"job_id":{"type":["string","null"]}}}}}}},"operationId":"putV1ProjectsByIdAutopilotSettings"}},"/v1/categorypages/":{"get":{"tags":["categorypages"],"summary":"List categorypages","parameters":[{"name":"skip","in":"query","required":false,"schema":{"default":0,"anyOf":[{"default":0,"format":"numeric","type":"string"},{"default":0,"type":"number"}]}},{"name":"take","in":"query","required":false,"schema":{"default":9,"maximum":50,"anyOf":[{"default":0,"maximum":50,"format":"numeric","type":"string"},{"default":9,"maximum":50,"type":"number"}]}},{"name":"search","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"maker","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"status","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"projectId","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"persona","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"author","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"category","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"published","in":"query","required":false,"schema":{"type":"string"}},{"name":"source","in":"query","required":false,"schema":{"description":"Comma-separated sources (app, autopilot, feed, api, merlin); `none` = contents without a source","examples":["feed,api","none"],"type":"string"}},{"name":"format","in":"query","required":false,"schema":{"description":"Comma-separated article formats (`data.input.type`)","examples":["blog,news"],"type":"string"}},{"name":"statusGroup","in":"query","required":false,"schema":{"description":"Comma-separated status groups: waiting (prequeued, queued, idle), running (starting, running), success, error (error, interrupted)","examples":["waiting,error"],"type":"string"}},{"name":"created_from","in":"query","required":false,"schema":{"description":"Created at or after this ISO date-time","examples":["2026-10-01T00:00:00+02:00"],"type":"string"}},{"name":"created_to","in":"query","required":false,"schema":{"description":"Created at or before this ISO date-time","examples":["2026-10-31T23:59:59+01:00"],"type":"string"}}],"responses":{"200":{"description":"The list of category pages","content":{"application/json":{"schema":{"description":"The list of category pages","type":"object","required":["items","count"],"properties":{"items":{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{"id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"},"name":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"title":{"type":"string"},"data":{"type":"object","required":["input"],"properties":{"input":{"additionalProperties":true,"type":"object","properties":{"subject":{"minLength":1,"description":"The subject of the category page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the category page.","type":"string"},"website":{"description":"The website url of the category page.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the category page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the category page.","type":"string"},"additional_information":{"description":"Additional information about the category page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}},"status":{"enum":["queued","running","success","error"],"type":"string"},"status_detail":{"type":"string"},"last_output_id":{"format":"uuid","type":"string"},"project_id":{"format":"uuid","type":"string"},"maker_id":{"format":"uuid","type":"string"},"source":{"enum":["app","autopilot","feed","api","merlin"],"description":"Where the content comes from, written by the API on creation (null = unknown)","type":["string","null"]},"is_published":{"type":"boolean"}}}},"count":{"default":0,"type":"number"}},"additionalProperties":false}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}},"additionalProperties":false}}}}},"operationId":"getV1Categorypages"},"post":{"tags":["categorypages"],"summary":"Create and run a categorypages","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the category page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the category page.","type":"string"},"website":{"description":"The website url of the category page.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the category page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the category page.","type":"string"},"additional_information":{"description":"Additional information about the category page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the category page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the category page.","type":"string"},"website":{"description":"The website url of the category page.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the category page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the category page.","type":"string"},"additional_information":{"description":"Additional information about the category page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}},"multipart/form-data":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the category page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the category page.","type":"string"},"website":{"description":"The website url of the category page.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the category page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the category page.","type":"string"},"additional_information":{"description":"Additional information about the category page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}}},"responses":{"200":{"description":"The id of the created article","content":{"application/json":{"schema":{"description":"The id of the created article","type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"500":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}},"operationId":"postV1Categorypages"}},"/v1/categorypages/{id}":{"get":{"tags":["categorypages"],"summary":"Get a categorypages","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The categorypages","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{"id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"},"name":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"title":{"type":"string"},"data":{"type":"object","required":["input"],"properties":{"input":{"additionalProperties":true,"type":"object","properties":{"subject":{"minLength":1,"description":"The subject of the category page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the category page.","type":"string"},"website":{"description":"The website url of the category page.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the category page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the category page.","type":"string"},"additional_information":{"description":"Additional information about the category page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}},"status":{"enum":["queued","running","success","error"],"type":"string"},"status_detail":{"type":"string"},"last_output_id":{"format":"uuid","type":"string"},"project_id":{"format":"uuid","type":"string"},"maker_id":{"format":"uuid","type":"string"},"source":{"enum":["app","autopilot","feed","api","merlin"],"description":"Where the content comes from, written by the API on creation (null = unknown)","type":["string","null"]},"is_published":{"type":"boolean"}},"description":"The categorypages"}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}},"operationId":"getV1CategorypagesById"},"patch":{"tags":["categorypages"],"summary":"Update a categorypages","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{"subject":{"minLength":1,"description":"The subject of the category page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the category page.","type":"string"},"website":{"description":"The website url of the category page.","type":"string"},"length":{"description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"description":"Length of the article in words.","type":"number"},{"pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the category page.","type":"string"},"apply_project_brief_config":{"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the category page.","type":"string"},"additional_information":{"description":"Additional information about the category page.","type":"string"},"use_boldkeywords":{"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string"},"persona_id":{"type":"string"},"use_cta":{"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string"},"use_faq":{"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"type":"boolean"},"use_indexed_pages_internal_links":{"type":"boolean"},"use_wp_internal_links":{"type":"boolean"},"use_shopify_internal_links":{"type":"boolean"},"use_app_internal_links":{"type":"boolean"},"use_list_internal_links":{"type":"boolean"},"internal_links_wp_status":{"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string"},"publishwordpress_category":{"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":true,"type":"object","properties":{"subject":{"minLength":1,"description":"The subject of the category page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the category page.","type":"string"},"website":{"description":"The website url of the category page.","type":"string"},"length":{"description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"description":"Length of the article in words.","type":"number"},{"pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the category page.","type":"string"},"apply_project_brief_config":{"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the category page.","type":"string"},"additional_information":{"description":"Additional information about the category page.","type":"string"},"use_boldkeywords":{"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string"},"persona_id":{"type":"string"},"use_cta":{"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string"},"use_faq":{"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"type":"boolean"},"use_indexed_pages_internal_links":{"type":"boolean"},"use_wp_internal_links":{"type":"boolean"},"use_shopify_internal_links":{"type":"boolean"},"use_app_internal_links":{"type":"boolean"},"use_list_internal_links":{"type":"boolean"},"internal_links_wp_status":{"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string"},"publishwordpress_category":{"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}},"multipart/form-data":{"schema":{"additionalProperties":true,"type":"object","properties":{"subject":{"minLength":1,"description":"The subject of the category page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the category page.","type":"string"},"website":{"description":"The website url of the category page.","type":"string"},"length":{"description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"description":"Length of the article in words.","type":"number"},{"pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the category page.","type":"string"},"apply_project_brief_config":{"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the category page.","type":"string"},"additional_information":{"description":"Additional information about the category page.","type":"string"},"use_boldkeywords":{"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string"},"persona_id":{"type":"string"},"use_cta":{"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string"},"use_faq":{"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"type":"boolean"},"use_indexed_pages_internal_links":{"type":"boolean"},"use_wp_internal_links":{"type":"boolean"},"use_shopify_internal_links":{"type":"boolean"},"use_app_internal_links":{"type":"boolean"},"use_list_internal_links":{"type":"boolean"},"internal_links_wp_status":{"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string"},"publishwordpress_category":{"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}}},"responses":{"200":{"description":"The updated categorypages","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{"id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"},"name":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"title":{"type":"string"},"data":{"type":"object","required":["input"],"properties":{"input":{"additionalProperties":true,"type":"object","properties":{"subject":{"minLength":1,"description":"The subject of the category page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the category page.","type":"string"},"website":{"description":"The website url of the category page.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the category page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the category page.","type":"string"},"additional_information":{"description":"Additional information about the category page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}},"status":{"enum":["queued","running","success","error"],"type":"string"},"status_detail":{"type":"string"},"last_output_id":{"format":"uuid","type":"string"},"project_id":{"format":"uuid","type":"string"},"maker_id":{"format":"uuid","type":"string"},"source":{"enum":["app","autopilot","feed","api","merlin"],"description":"Where the content comes from, written by the API on creation (null = unknown)","type":["string","null"]},"is_published":{"type":"boolean"}},"description":"The updated categorypages"}}}}},"operationId":"patchV1CategorypagesById"}},"/v1/categorypages/{id}/output":{"get":{"tags":["categorypages"],"summary":"Get the result of categorypages","description":"If no outputId is provided, the latest output will be returned","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"outputId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The categorypages output","content":{"application/json":{"schema":{"description":"The categorypages output","type":"object","required":["id","all_outputs","output"],"properties":{"id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"all_outputs":{"type":"array","items":{"type":"object","required":["id","created_at"],"properties":{"id":{"type":"string"},"created_at":{"type":"string"}}}},"input":{"additionalProperties":true,"type":"object","properties":{"subject":{"minLength":1,"description":"The subject of the category page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the category page.","type":"string"},"website":{"description":"The website url of the category page.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the category page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the category page.","type":"string"},"additional_information":{"description":"Additional information about the category page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}},"output":{"additionalProperties":true,"type":"object","properties":{"h1":{"type":"string"},"content":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"keywords_analysis":{"type":"array","items":{"type":"object","properties":{"keyword":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"occurences_minimum_number":{"type":"number"},"occurences_maximum_number":{"type":"number"}}}},"url":{"type":"string"},"cover_image":{"type":"string"},"cover_images":{"type":"array","items":{"type":"string"}},"cover":{"type":"number"},"social":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"facebook":{"type":"string"},"x":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"root_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}}},"audio":{"type":"string"}}},"status":{"type":"string"}}}}}}},"operationId":"getV1CategorypagesByIdOutput"}},"/v1/categorypages/{id}/output/{outputId}":{"patch":{"tags":["categorypages"],"summary":"Update the result of categorypages","description":"If no outputId is provided, the latest output will be returned","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"outputId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{"h1":{"type":"string"},"content":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"keywords_analysis":{"type":"array","items":{"type":"object","properties":{"keyword":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"occurences_minimum_number":{"type":"number"},"occurences_maximum_number":{"type":"number"}}}},"url":{"type":"string"},"cover_image":{"type":"string"},"cover_images":{"type":"array","items":{"type":"string"}},"cover":{"type":"number"},"social":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"facebook":{"type":"string"},"x":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"root_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}}},"audio":{"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":true,"type":"object","properties":{"h1":{"type":"string"},"content":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"keywords_analysis":{"type":"array","items":{"type":"object","properties":{"keyword":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"occurences_minimum_number":{"type":"number"},"occurences_maximum_number":{"type":"number"}}}},"url":{"type":"string"},"cover_image":{"type":"string"},"cover_images":{"type":"array","items":{"type":"string"}},"cover":{"type":"number"},"social":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"facebook":{"type":"string"},"x":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"root_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}}},"audio":{"type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":true,"type":"object","properties":{"h1":{"type":"string"},"content":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"keywords_analysis":{"type":"array","items":{"type":"object","properties":{"keyword":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"occurences_minimum_number":{"type":"number"},"occurences_maximum_number":{"type":"number"}}}},"url":{"type":"string"},"cover_image":{"type":"string"},"cover_images":{"type":"array","items":{"type":"string"}},"cover":{"type":"number"},"social":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"facebook":{"type":"string"},"x":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"root_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}}},"audio":{"type":"string"}}}}}},"responses":{"200":{"description":"The categorypages output","content":{"application/json":{"schema":{"description":"The categorypages output","type":"object","required":["id","output"],"properties":{"id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"output":{"additionalProperties":true,"type":"object","properties":{"h1":{"type":"string"},"content":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"keywords_analysis":{"type":"array","items":{"type":"object","properties":{"keyword":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"occurences_minimum_number":{"type":"number"},"occurences_maximum_number":{"type":"number"}}}},"url":{"type":"string"},"cover_image":{"type":"string"},"cover_images":{"type":"array","items":{"type":"string"}},"cover":{"type":"number"},"social":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"facebook":{"type":"string"},"x":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"root_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}}},"audio":{"type":"string"}}}}}}}}},"operationId":"patchV1CategorypagesByIdOutputByOutputId"}},"/v1/categorypages/bulk":{"post":{"tags":["categorypages"],"summary":"Create multiple categorypages","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the category page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the category page.","type":"string"},"website":{"description":"The website url of the category page.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the category page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the category page.","type":"string"},"additional_information":{"description":"Additional information about the category page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}},"application/x-www-form-urlencoded":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the category page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the category page.","type":"string"},"website":{"description":"The website url of the category page.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the category page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the category page.","type":"string"},"additional_information":{"description":"Additional information about the category page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}},"multipart/form-data":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the category page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the category page.","type":"string"},"website":{"description":"The website url of the category page.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the category page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the category page.","type":"string"},"additional_information":{"description":"Additional information about the category page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}}}},"responses":{"200":{"description":"The ids of the created articles","content":{"application/json":{"schema":{"description":"The ids of the created articles","type":"object","required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"string"}}}}}}}},"operationId":"postV1CategorypagesBulk"}},"/v1/categorypages/cost":{"post":{"tags":["categorypages"],"summary":"Get the cost of creating one categorypages","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the category page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the category page.","type":"string"},"website":{"description":"The website url of the category page.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the category page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the category page.","type":"string"},"additional_information":{"description":"Additional information about the category page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the category page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the category page.","type":"string"},"website":{"description":"The website url of the category page.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the category page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the category page.","type":"string"},"additional_information":{"description":"Additional information about the category page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}},"multipart/form-data":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the category page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the category page.","type":"string"},"website":{"description":"The website url of the category page.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the category page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the category page.","type":"string"},"additional_information":{"description":"Additional information about the category page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}}},"responses":{"200":{"description":"Get the cost of creating one categorypages and remaining credits","content":{"application/json":{"schema":{"description":"Get the cost of creating one categorypages and remaining credits","type":"object","required":["credits","cost"],"properties":{"credits":{"type":"number"},"cost":{"type":"number"}}}}}}},"operationId":"postV1CategorypagesCost"}},"/v1/categorypages/bulk/cost":{"post":{"tags":["categorypages"],"summary":"Get the cost of creating multiple categorypages","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the category page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the category page.","type":"string"},"website":{"description":"The website url of the category page.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the category page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the category page.","type":"string"},"additional_information":{"description":"Additional information about the category page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}},"application/x-www-form-urlencoded":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the category page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the category page.","type":"string"},"website":{"description":"The website url of the category page.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the category page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the category page.","type":"string"},"additional_information":{"description":"Additional information about the category page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}},"multipart/form-data":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the category page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the category page.","type":"string"},"website":{"description":"The website url of the category page.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the category page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the category page.","type":"string"},"additional_information":{"description":"Additional information about the category page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}}}},"responses":{"200":{"description":"The cost of creating multiple categorypages and remaining credits","content":{"application/json":{"schema":{"description":"The cost of creating multiple categorypages and remaining credits","type":"object","required":["credits","cost"],"properties":{"credits":{"type":"number"},"cost":{"type":"number"}}}}}}},"operationId":"postV1CategorypagesBulkCost"}},"/v1/categorypages/{id}/run":{"post":{"tags":["categorypages"],"summary":"Run a categorypages","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{}},"application/x-www-form-urlencoded":{"schema":{}},"multipart/form-data":{"schema":{}}}},"responses":{"200":{"description":"The id of the categorypages","content":{"application/json":{"schema":{"description":"The id of the categorypages","type":"object","required":["id","status"],"properties":{"id":{"type":"string"},"status":{"type":"string"}}}}}}},"operationId":"postV1CategorypagesByIdRun"}},"/v1/productpages/":{"get":{"tags":["productpages"],"summary":"List productpages","parameters":[{"name":"skip","in":"query","required":false,"schema":{"default":0,"anyOf":[{"default":0,"format":"numeric","type":"string"},{"default":0,"type":"number"}]}},{"name":"take","in":"query","required":false,"schema":{"default":9,"maximum":50,"anyOf":[{"default":0,"maximum":50,"format":"numeric","type":"string"},{"default":9,"maximum":50,"type":"number"}]}},{"name":"search","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"maker","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"status","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"projectId","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"persona","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"author","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"category","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"published","in":"query","required":false,"schema":{"type":"string"}},{"name":"source","in":"query","required":false,"schema":{"description":"Comma-separated sources (app, autopilot, feed, api, merlin); `none` = contents without a source","examples":["feed,api","none"],"type":"string"}},{"name":"format","in":"query","required":false,"schema":{"description":"Comma-separated article formats (`data.input.type`)","examples":["blog,news"],"type":"string"}},{"name":"statusGroup","in":"query","required":false,"schema":{"description":"Comma-separated status groups: waiting (prequeued, queued, idle), running (starting, running), success, error (error, interrupted)","examples":["waiting,error"],"type":"string"}},{"name":"created_from","in":"query","required":false,"schema":{"description":"Created at or after this ISO date-time","examples":["2026-10-01T00:00:00+02:00"],"type":"string"}},{"name":"created_to","in":"query","required":false,"schema":{"description":"Created at or before this ISO date-time","examples":["2026-10-31T23:59:59+01:00"],"type":"string"}}],"responses":{"200":{"description":"The list of product pages","content":{"application/json":{"schema":{"description":"The list of product pages","type":"object","required":["items","count"],"properties":{"items":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["id","user_id"],"properties":{"id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"},"name":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"title":{"type":"string"},"data":{"type":"object","required":["input"],"properties":{"input":{"additionalProperties":true,"type":"object","properties":{"subject":{"minLength":1,"description":"The subject of the product page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the product page.","type":"string"},"website":{"description":"The website url of the product page.","type":"string"},"length":{"default":400,"description":"Length of the product page in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the product page in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the product page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the product page.","type":"string"},"additional_information":{"description":"Additional information about the product page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}},"status":{"enum":["queued","running","success","error"],"type":"string"},"status_detail":{"type":"string"},"last_output_id":{"format":"uuid","type":"string"},"project_id":{"format":"uuid","type":"string"},"maker_id":{"format":"uuid","type":"string"},"source":{"enum":["app","autopilot","feed","api","merlin"],"description":"Where the content comes from, written by the API on creation (null = unknown)","type":["string","null"]},"is_published":{"type":"boolean"}}}},"count":{"default":0,"type":"number"}},"additionalProperties":false}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}},"additionalProperties":false}}}}},"operationId":"getV1Productpages"},"post":{"tags":["productpages"],"summary":"Create and run a productpages","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the product page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the product page.","type":"string"},"website":{"description":"The website url of the product page.","type":"string"},"length":{"default":400,"description":"Length of the product page in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the product page in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the product page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the product page.","type":"string"},"additional_information":{"description":"Additional information about the product page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the product page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the product page.","type":"string"},"website":{"description":"The website url of the product page.","type":"string"},"length":{"default":400,"description":"Length of the product page in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the product page in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the product page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the product page.","type":"string"},"additional_information":{"description":"Additional information about the product page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}},"multipart/form-data":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the product page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the product page.","type":"string"},"website":{"description":"The website url of the product page.","type":"string"},"length":{"default":400,"description":"Length of the product page in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the product page in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the product page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the product page.","type":"string"},"additional_information":{"description":"Additional information about the product page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}}},"responses":{"200":{"description":"The id of the created article","content":{"application/json":{"schema":{"description":"The id of the created article","type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"500":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}},"operationId":"postV1Productpages"}},"/v1/productpages/{id}":{"get":{"tags":["productpages"],"summary":"Get a productpages","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The productpages","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{"id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"},"name":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"title":{"type":"string"},"data":{"type":"object","required":["input"],"properties":{"input":{"additionalProperties":true,"type":"object","properties":{"subject":{"minLength":1,"description":"The subject of the product page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the product page.","type":"string"},"website":{"description":"The website url of the product page.","type":"string"},"length":{"default":400,"description":"Length of the product page in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the product page in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the product page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the product page.","type":"string"},"additional_information":{"description":"Additional information about the product page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}},"status":{"enum":["queued","running","success","error"],"type":"string"},"status_detail":{"type":"string"},"last_output_id":{"format":"uuid","type":"string"},"project_id":{"format":"uuid","type":"string"},"maker_id":{"format":"uuid","type":"string"},"source":{"enum":["app","autopilot","feed","api","merlin"],"description":"Where the content comes from, written by the API on creation (null = unknown)","type":["string","null"]},"is_published":{"type":"boolean"}},"description":"The productpages"}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}},"additionalProperties":false}}}}},"operationId":"getV1ProductpagesById"},"patch":{"tags":["productpages"],"summary":"Update a productpages","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{"subject":{"minLength":1,"description":"The subject of the product page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the product page.","type":"string"},"website":{"description":"The website url of the product page.","type":"string"},"length":{"description":"Length of the product page in words. Default is 'auto'","anyOf":[{"maximum":2000,"description":"Length of the product page in words.","type":"number"},{"pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the product page.","type":"string"},"apply_project_brief_config":{"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the product page.","type":"string"},"additional_information":{"description":"Additional information about the product page.","type":"string"},"use_boldkeywords":{"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string"},"persona_id":{"type":"string"},"use_cta":{"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string"},"use_faq":{"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"type":"boolean"},"use_indexed_pages_internal_links":{"type":"boolean"},"use_wp_internal_links":{"type":"boolean"},"use_shopify_internal_links":{"type":"boolean"},"use_app_internal_links":{"type":"boolean"},"use_list_internal_links":{"type":"boolean"},"internal_links_wp_status":{"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string"},"publishwordpress_category":{"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":true,"type":"object","properties":{"subject":{"minLength":1,"description":"The subject of the product page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the product page.","type":"string"},"website":{"description":"The website url of the product page.","type":"string"},"length":{"description":"Length of the product page in words. Default is 'auto'","anyOf":[{"maximum":2000,"description":"Length of the product page in words.","type":"number"},{"pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the product page.","type":"string"},"apply_project_brief_config":{"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the product page.","type":"string"},"additional_information":{"description":"Additional information about the product page.","type":"string"},"use_boldkeywords":{"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string"},"persona_id":{"type":"string"},"use_cta":{"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string"},"use_faq":{"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"type":"boolean"},"use_indexed_pages_internal_links":{"type":"boolean"},"use_wp_internal_links":{"type":"boolean"},"use_shopify_internal_links":{"type":"boolean"},"use_app_internal_links":{"type":"boolean"},"use_list_internal_links":{"type":"boolean"},"internal_links_wp_status":{"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string"},"publishwordpress_category":{"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}},"multipart/form-data":{"schema":{"additionalProperties":true,"type":"object","properties":{"subject":{"minLength":1,"description":"The subject of the product page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the product page.","type":"string"},"website":{"description":"The website url of the product page.","type":"string"},"length":{"description":"Length of the product page in words. Default is 'auto'","anyOf":[{"maximum":2000,"description":"Length of the product page in words.","type":"number"},{"pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the product page.","type":"string"},"apply_project_brief_config":{"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the product page.","type":"string"},"additional_information":{"description":"Additional information about the product page.","type":"string"},"use_boldkeywords":{"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string"},"persona_id":{"type":"string"},"use_cta":{"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string"},"use_faq":{"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"type":"boolean"},"use_indexed_pages_internal_links":{"type":"boolean"},"use_wp_internal_links":{"type":"boolean"},"use_shopify_internal_links":{"type":"boolean"},"use_app_internal_links":{"type":"boolean"},"use_list_internal_links":{"type":"boolean"},"internal_links_wp_status":{"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string"},"publishwordpress_category":{"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}}},"responses":{"200":{"description":"The updated productpages","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{"id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"},"name":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"title":{"type":"string"},"data":{"type":"object","required":["input"],"properties":{"input":{"additionalProperties":true,"type":"object","properties":{"subject":{"minLength":1,"description":"The subject of the product page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the product page.","type":"string"},"website":{"description":"The website url of the product page.","type":"string"},"length":{"default":400,"description":"Length of the product page in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the product page in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the product page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the product page.","type":"string"},"additional_information":{"description":"Additional information about the product page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}},"status":{"enum":["queued","running","success","error"],"type":"string"},"status_detail":{"type":"string"},"last_output_id":{"format":"uuid","type":"string"},"project_id":{"format":"uuid","type":"string"},"maker_id":{"format":"uuid","type":"string"},"source":{"enum":["app","autopilot","feed","api","merlin"],"description":"Where the content comes from, written by the API on creation (null = unknown)","type":["string","null"]},"is_published":{"type":"boolean"}},"description":"The updated productpages"}}}}},"operationId":"patchV1ProductpagesById"}},"/v1/productpages/{id}/output":{"get":{"tags":["productpages"],"summary":"Get the result of productpages","description":"If no outputId is provided, the latest output will be returned","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"outputId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The productpages output","content":{"application/json":{"schema":{"description":"The productpages output","type":"object","required":["id","all_outputs","output"],"properties":{"id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"all_outputs":{"type":"array","items":{"type":"object","required":["id","created_at"],"properties":{"id":{"type":"string"},"created_at":{"type":"string"}}}},"input":{"additionalProperties":true,"type":"object","properties":{"subject":{"minLength":1,"description":"The subject of the product page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the product page.","type":"string"},"website":{"description":"The website url of the product page.","type":"string"},"length":{"default":400,"description":"Length of the product page in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the product page in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the product page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the product page.","type":"string"},"additional_information":{"description":"Additional information about the product page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}},"output":{"additionalProperties":true,"type":"object","properties":{"h1":{"type":"string"},"content":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"keywords_analysis":{"type":"array","items":{"type":"object","properties":{"keyword":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"occurences_minimum_number":{"type":"number"},"occurences_maximum_number":{"type":"number"}}}},"url":{"type":"string"},"cover_image":{"type":"string"},"cover_images":{"type":"array","items":{"type":"string"}},"cover":{"type":"number"},"social":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"facebook":{"type":"string"},"x":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"root_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}}},"audio":{"type":"string"}}},"status":{"type":"string"}}}}}}},"operationId":"getV1ProductpagesByIdOutput"}},"/v1/productpages/{id}/output/{outputId}":{"patch":{"tags":["productpages"],"summary":"Update the result of productpages","description":"If no outputId is provided, the latest output will be returned","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"outputId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{"h1":{"type":"string"},"content":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"keywords_analysis":{"type":"array","items":{"type":"object","properties":{"keyword":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"occurences_minimum_number":{"type":"number"},"occurences_maximum_number":{"type":"number"}}}},"url":{"type":"string"},"cover_image":{"type":"string"},"cover_images":{"type":"array","items":{"type":"string"}},"cover":{"type":"number"},"social":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"facebook":{"type":"string"},"x":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"root_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}}},"audio":{"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":true,"type":"object","properties":{"h1":{"type":"string"},"content":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"keywords_analysis":{"type":"array","items":{"type":"object","properties":{"keyword":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"occurences_minimum_number":{"type":"number"},"occurences_maximum_number":{"type":"number"}}}},"url":{"type":"string"},"cover_image":{"type":"string"},"cover_images":{"type":"array","items":{"type":"string"}},"cover":{"type":"number"},"social":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"facebook":{"type":"string"},"x":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"root_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}}},"audio":{"type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":true,"type":"object","properties":{"h1":{"type":"string"},"content":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"keywords_analysis":{"type":"array","items":{"type":"object","properties":{"keyword":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"occurences_minimum_number":{"type":"number"},"occurences_maximum_number":{"type":"number"}}}},"url":{"type":"string"},"cover_image":{"type":"string"},"cover_images":{"type":"array","items":{"type":"string"}},"cover":{"type":"number"},"social":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"facebook":{"type":"string"},"x":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"root_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}}},"audio":{"type":"string"}}}}}},"responses":{"200":{"description":"The productpages output","content":{"application/json":{"schema":{"description":"The productpages output","type":"object","required":["id","output"],"properties":{"id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"output":{"additionalProperties":true,"type":"object","properties":{"h1":{"type":"string"},"content":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"keywords_analysis":{"type":"array","items":{"type":"object","properties":{"keyword":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"occurences_minimum_number":{"type":"number"},"occurences_maximum_number":{"type":"number"}}}},"url":{"type":"string"},"cover_image":{"type":"string"},"cover_images":{"type":"array","items":{"type":"string"}},"cover":{"type":"number"},"social":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"facebook":{"type":"string"},"x":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"root_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}}},"audio":{"type":"string"}}}}}}}}},"operationId":"patchV1ProductpagesByIdOutputByOutputId"}},"/v1/productpages/bulk":{"post":{"tags":["productpages"],"summary":"Create multiple productpages","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the product page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the product page.","type":"string"},"website":{"description":"The website url of the product page.","type":"string"},"length":{"default":400,"description":"Length of the product page in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the product page in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the product page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the product page.","type":"string"},"additional_information":{"description":"Additional information about the product page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}},"application/x-www-form-urlencoded":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the product page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the product page.","type":"string"},"website":{"description":"The website url of the product page.","type":"string"},"length":{"default":400,"description":"Length of the product page in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the product page in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the product page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the product page.","type":"string"},"additional_information":{"description":"Additional information about the product page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}},"multipart/form-data":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the product page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the product page.","type":"string"},"website":{"description":"The website url of the product page.","type":"string"},"length":{"default":400,"description":"Length of the product page in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the product page in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the product page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the product page.","type":"string"},"additional_information":{"description":"Additional information about the product page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}}}},"responses":{"200":{"description":"The ids of the created articles","content":{"application/json":{"schema":{"description":"The ids of the created articles","type":"object","required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"string"}}}}}}}},"operationId":"postV1ProductpagesBulk"}},"/v1/productpages/cost":{"post":{"tags":["productpages"],"summary":"Get the cost of creating one productpages","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the product page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the product page.","type":"string"},"website":{"description":"The website url of the product page.","type":"string"},"length":{"default":400,"description":"Length of the product page in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the product page in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the product page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the product page.","type":"string"},"additional_information":{"description":"Additional information about the product page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the product page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the product page.","type":"string"},"website":{"description":"The website url of the product page.","type":"string"},"length":{"default":400,"description":"Length of the product page in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the product page in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the product page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the product page.","type":"string"},"additional_information":{"description":"Additional information about the product page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}},"multipart/form-data":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the product page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the product page.","type":"string"},"website":{"description":"The website url of the product page.","type":"string"},"length":{"default":400,"description":"Length of the product page in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the product page in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the product page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the product page.","type":"string"},"additional_information":{"description":"Additional information about the product page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}}},"responses":{"200":{"description":"Get the cost of creating one productpages and remaining credits","content":{"application/json":{"schema":{"description":"Get the cost of creating one productpages and remaining credits","type":"object","required":["credits","cost"],"properties":{"credits":{"type":"number"},"cost":{"type":"number"}}}}}}},"operationId":"postV1ProductpagesCost"}},"/v1/productpages/bulk/cost":{"post":{"tags":["productpages"],"summary":"Get the cost of creating multiple productpages","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the product page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the product page.","type":"string"},"website":{"description":"The website url of the product page.","type":"string"},"length":{"default":400,"description":"Length of the product page in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the product page in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the product page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the product page.","type":"string"},"additional_information":{"description":"Additional information about the product page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}},"application/x-www-form-urlencoded":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the product page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the product page.","type":"string"},"website":{"description":"The website url of the product page.","type":"string"},"length":{"default":400,"description":"Length of the product page in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the product page in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the product page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the product page.","type":"string"},"additional_information":{"description":"Additional information about the product page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}},"multipart/form-data":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the product page.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"writing_style":{"description":"The writing style of the product page.","type":"string"},"website":{"description":"The website url of the product page.","type":"string"},"length":{"default":400,"description":"Length of the product page in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the product page in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the product page.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the product page.","type":"string"},"additional_information":{"description":"Additional information about the product page.","type":"string"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}}}},"responses":{"200":{"description":"The cost of creating multiple productpages and remaining credits","content":{"application/json":{"schema":{"description":"The cost of creating multiple productpages and remaining credits","type":"object","required":["credits","cost"],"properties":{"credits":{"type":"number"},"cost":{"type":"number"}}}}}}},"operationId":"postV1ProductpagesBulkCost"}},"/v1/productpages/{id}/run":{"post":{"tags":["productpages"],"summary":"Run a productpages","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{}},"application/x-www-form-urlencoded":{"schema":{}},"multipart/form-data":{"schema":{}}}},"responses":{"200":{"description":"The id of the productpages","content":{"application/json":{"schema":{"description":"The id of the productpages","type":"object","required":["id","status"],"properties":{"id":{"type":"string"},"status":{"type":"string"}}}}}}},"operationId":"postV1ProductpagesByIdRun"}},"/v1/discoverarticles/":{"get":{"tags":["discoverarticles"],"summary":"List discoverarticles","parameters":[{"name":"skip","in":"query","required":false,"schema":{"default":0,"anyOf":[{"default":0,"format":"numeric","type":"string"},{"default":0,"type":"number"}]}},{"name":"take","in":"query","required":false,"schema":{"default":9,"maximum":50,"anyOf":[{"default":0,"maximum":50,"format":"numeric","type":"string"},{"default":9,"maximum":50,"type":"number"}]}},{"name":"search","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"maker","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"status","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"projectId","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"persona","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"author","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"category","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"published","in":"query","required":false,"schema":{"type":"string"}},{"name":"source","in":"query","required":false,"schema":{"description":"Comma-separated sources (app, autopilot, feed, api, merlin); `none` = contents without a source","examples":["feed,api","none"],"type":"string"}},{"name":"format","in":"query","required":false,"schema":{"description":"Comma-separated article formats (`data.input.type`)","examples":["blog,news"],"type":"string"}},{"name":"statusGroup","in":"query","required":false,"schema":{"description":"Comma-separated status groups: waiting (prequeued, queued, idle), running (starting, running), success, error (error, interrupted)","examples":["waiting,error"],"type":"string"}},{"name":"created_from","in":"query","required":false,"schema":{"description":"Created at or after this ISO date-time","examples":["2026-10-01T00:00:00+02:00"],"type":"string"}},{"name":"created_to","in":"query","required":false,"schema":{"description":"Created at or before this ISO date-time","examples":["2026-10-31T23:59:59+01:00"],"type":"string"}}],"responses":{"200":{"description":"The list of discover articles","content":{"application/json":{"schema":{"description":"The list of discover articles","type":"object","required":["items","count"],"properties":{"items":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["id","user_id"],"properties":{"id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"},"name":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"title":{"type":"string"},"data":{"type":"object","required":["input"],"properties":{"input":{"additionalProperties":true,"type":"object","properties":{"subject":{"minLength":1,"description":"The subject of the discover article.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"writing_style":{"description":"The writing style of the discover article.","type":"string"},"website":{"description":"The website url of the discover article.","type":"string"},"length":{"default":400,"description":"Length of the discover article in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the discover article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the discover article.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the discover article.","type":"string"},"additional_information":{"description":"Additional information about the discover article.","type":"string"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}},"status":{"enum":["queued","running","success","error"],"type":"string"},"status_detail":{"type":"string"},"last_output_id":{"format":"uuid","type":"string"},"project_id":{"format":"uuid","type":"string"},"maker_id":{"format":"uuid","type":"string"},"source":{"enum":["app","autopilot","feed","api","merlin"],"description":"Where the content comes from, written by the API on creation (null = unknown)","type":["string","null"]},"is_published":{"type":"boolean"}}}},"count":{"default":0,"type":"number"}},"additionalProperties":false}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}},"additionalProperties":false}}}}},"operationId":"getV1Discoverarticles"},"post":{"tags":["discoverarticles"],"summary":"Create and run a discoverarticles","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the discover article.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"writing_style":{"description":"The writing style of the discover article.","type":"string"},"website":{"description":"The website url of the discover article.","type":"string"},"length":{"default":400,"description":"Length of the discover article in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the discover article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the discover article.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the discover article.","type":"string"},"additional_information":{"description":"Additional information about the discover article.","type":"string"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the discover article.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"writing_style":{"description":"The writing style of the discover article.","type":"string"},"website":{"description":"The website url of the discover article.","type":"string"},"length":{"default":400,"description":"Length of the discover article in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the discover article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the discover article.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the discover article.","type":"string"},"additional_information":{"description":"Additional information about the discover article.","type":"string"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}},"multipart/form-data":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the discover article.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"writing_style":{"description":"The writing style of the discover article.","type":"string"},"website":{"description":"The website url of the discover article.","type":"string"},"length":{"default":400,"description":"Length of the discover article in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the discover article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the discover article.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the discover article.","type":"string"},"additional_information":{"description":"Additional information about the discover article.","type":"string"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}}},"responses":{"200":{"description":"The id of the created article","content":{"application/json":{"schema":{"description":"The id of the created article","type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"500":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}},"operationId":"postV1Discoverarticles"}},"/v1/discoverarticles/{id}":{"get":{"tags":["discoverarticles"],"summary":"Get a discoverarticles","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The discoverarticles","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{"id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"},"name":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"title":{"type":"string"},"data":{"type":"object","required":["input"],"properties":{"input":{"additionalProperties":true,"type":"object","properties":{"subject":{"minLength":1,"description":"The subject of the discover article.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"writing_style":{"description":"The writing style of the discover article.","type":"string"},"website":{"description":"The website url of the discover article.","type":"string"},"length":{"default":400,"description":"Length of the discover article in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the discover article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the discover article.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the discover article.","type":"string"},"additional_information":{"description":"Additional information about the discover article.","type":"string"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}},"status":{"enum":["queued","running","success","error"],"type":"string"},"status_detail":{"type":"string"},"last_output_id":{"format":"uuid","type":"string"},"project_id":{"format":"uuid","type":"string"},"maker_id":{"format":"uuid","type":"string"},"source":{"enum":["app","autopilot","feed","api","merlin"],"description":"Where the content comes from, written by the API on creation (null = unknown)","type":["string","null"]},"is_published":{"type":"boolean"}},"description":"The discoverarticles"}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}},"operationId":"getV1DiscoverarticlesById"},"patch":{"tags":["discoverarticles"],"summary":"Update a discoverarticles","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{"subject":{"minLength":1,"description":"The subject of the discover article.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"writing_style":{"description":"The writing style of the discover article.","type":"string"},"website":{"description":"The website url of the discover article.","type":"string"},"length":{"description":"Length of the discover article in words. Default is 'auto'","anyOf":[{"maximum":2000,"description":"Length of the discover article in words.","type":"number"},{"pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the discover article.","type":"string"},"apply_project_brief_config":{"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the discover article.","type":"string"},"additional_information":{"description":"Additional information about the discover article.","type":"string"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string"},"persona_id":{"type":"string"},"use_cta":{"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string"},"use_boldkeywords":{"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"type":"boolean"},"use_indexed_pages_internal_links":{"type":"boolean"},"use_wp_internal_links":{"type":"boolean"},"use_shopify_internal_links":{"type":"boolean"},"use_app_internal_links":{"type":"boolean"},"use_list_internal_links":{"type":"boolean"},"internal_links_wp_status":{"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string"},"publishwordpress_category":{"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"description":"If true, add a summary of the article","type":"boolean"},"use_schemaorg":{"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":true,"type":"object","properties":{"subject":{"minLength":1,"description":"The subject of the discover article.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"writing_style":{"description":"The writing style of the discover article.","type":"string"},"website":{"description":"The website url of the discover article.","type":"string"},"length":{"description":"Length of the discover article in words. Default is 'auto'","anyOf":[{"maximum":2000,"description":"Length of the discover article in words.","type":"number"},{"pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the discover article.","type":"string"},"apply_project_brief_config":{"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the discover article.","type":"string"},"additional_information":{"description":"Additional information about the discover article.","type":"string"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string"},"persona_id":{"type":"string"},"use_cta":{"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string"},"use_boldkeywords":{"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"type":"boolean"},"use_indexed_pages_internal_links":{"type":"boolean"},"use_wp_internal_links":{"type":"boolean"},"use_shopify_internal_links":{"type":"boolean"},"use_app_internal_links":{"type":"boolean"},"use_list_internal_links":{"type":"boolean"},"internal_links_wp_status":{"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string"},"publishwordpress_category":{"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"description":"If true, add a summary of the article","type":"boolean"},"use_schemaorg":{"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}},"multipart/form-data":{"schema":{"additionalProperties":true,"type":"object","properties":{"subject":{"minLength":1,"description":"The subject of the discover article.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"writing_style":{"description":"The writing style of the discover article.","type":"string"},"website":{"description":"The website url of the discover article.","type":"string"},"length":{"description":"Length of the discover article in words. Default is 'auto'","anyOf":[{"maximum":2000,"description":"Length of the discover article in words.","type":"number"},{"pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the discover article.","type":"string"},"apply_project_brief_config":{"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the discover article.","type":"string"},"additional_information":{"description":"Additional information about the discover article.","type":"string"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string"},"persona_id":{"type":"string"},"use_cta":{"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string"},"use_boldkeywords":{"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"type":"boolean"},"use_indexed_pages_internal_links":{"type":"boolean"},"use_wp_internal_links":{"type":"boolean"},"use_shopify_internal_links":{"type":"boolean"},"use_app_internal_links":{"type":"boolean"},"use_list_internal_links":{"type":"boolean"},"internal_links_wp_status":{"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string"},"publishwordpress_category":{"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"description":"If true, add a summary of the article","type":"boolean"},"use_schemaorg":{"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}}},"responses":{"200":{"description":"The updated discoverarticles","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{"id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"},"name":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"title":{"type":"string"},"data":{"type":"object","required":["input"],"properties":{"input":{"additionalProperties":true,"type":"object","properties":{"subject":{"minLength":1,"description":"The subject of the discover article.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"writing_style":{"description":"The writing style of the discover article.","type":"string"},"website":{"description":"The website url of the discover article.","type":"string"},"length":{"default":400,"description":"Length of the discover article in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the discover article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the discover article.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the discover article.","type":"string"},"additional_information":{"description":"Additional information about the discover article.","type":"string"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}},"status":{"enum":["queued","running","success","error"],"type":"string"},"status_detail":{"type":"string"},"last_output_id":{"format":"uuid","type":"string"},"project_id":{"format":"uuid","type":"string"},"maker_id":{"format":"uuid","type":"string"},"source":{"enum":["app","autopilot","feed","api","merlin"],"description":"Where the content comes from, written by the API on creation (null = unknown)","type":["string","null"]},"is_published":{"type":"boolean"}},"description":"The updated discoverarticles"}}}}},"operationId":"patchV1DiscoverarticlesById"}},"/v1/discoverarticles/{id}/output":{"get":{"tags":["discoverarticles"],"summary":"Get the result of discoverarticles","description":"If no outputId is provided, the latest output will be returned","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"outputId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The discoverarticles output","content":{"application/json":{"schema":{"description":"The discoverarticles output","type":"object","required":["id","all_outputs","output"],"properties":{"id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"all_outputs":{"type":"array","items":{"type":"object","required":["id","created_at"],"properties":{"id":{"type":"string"},"created_at":{"type":"string"}}}},"input":{"additionalProperties":true,"type":"object","properties":{"subject":{"minLength":1,"description":"The subject of the discover article.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"writing_style":{"description":"The writing style of the discover article.","type":"string"},"website":{"description":"The website url of the discover article.","type":"string"},"length":{"default":400,"description":"Length of the discover article in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the discover article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the discover article.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the discover article.","type":"string"},"additional_information":{"description":"Additional information about the discover article.","type":"string"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}},"output":{"additionalProperties":true,"type":"object","properties":{"h1":{"type":"string"},"content":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"keywords_analysis":{"type":"array","items":{"type":"object","properties":{"keyword":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"occurences_minimum_number":{"type":"number"},"occurences_maximum_number":{"type":"number"}}}},"url":{"type":"string"},"cover_image":{"type":"string"},"cover_images":{"type":"array","items":{"type":"string"}},"cover":{"type":"number"},"social":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"facebook":{"type":"string"},"x":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"root_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}}},"audio":{"type":"string"}}},"status":{"type":"string"}}}}}}},"operationId":"getV1DiscoverarticlesByIdOutput"}},"/v1/discoverarticles/{id}/output/{outputId}":{"patch":{"tags":["discoverarticles"],"summary":"Update the result of discoverarticles","description":"If no outputId is provided, the latest output will be returned","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"outputId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{"h1":{"type":"string"},"content":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"keywords_analysis":{"type":"array","items":{"type":"object","properties":{"keyword":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"occurences_minimum_number":{"type":"number"},"occurences_maximum_number":{"type":"number"}}}},"url":{"type":"string"},"cover_image":{"type":"string"},"cover_images":{"type":"array","items":{"type":"string"}},"cover":{"type":"number"},"social":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"facebook":{"type":"string"},"x":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"root_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}}},"audio":{"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":true,"type":"object","properties":{"h1":{"type":"string"},"content":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"keywords_analysis":{"type":"array","items":{"type":"object","properties":{"keyword":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"occurences_minimum_number":{"type":"number"},"occurences_maximum_number":{"type":"number"}}}},"url":{"type":"string"},"cover_image":{"type":"string"},"cover_images":{"type":"array","items":{"type":"string"}},"cover":{"type":"number"},"social":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"facebook":{"type":"string"},"x":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"root_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}}},"audio":{"type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":true,"type":"object","properties":{"h1":{"type":"string"},"content":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"keywords_analysis":{"type":"array","items":{"type":"object","properties":{"keyword":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"occurences_minimum_number":{"type":"number"},"occurences_maximum_number":{"type":"number"}}}},"url":{"type":"string"},"cover_image":{"type":"string"},"cover_images":{"type":"array","items":{"type":"string"}},"cover":{"type":"number"},"social":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"facebook":{"type":"string"},"x":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"root_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}}},"audio":{"type":"string"}}}}}},"responses":{"200":{"description":"The discoverarticles output","content":{"application/json":{"schema":{"description":"The discoverarticles output","type":"object","required":["id","output"],"properties":{"id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"output":{"additionalProperties":true,"type":"object","properties":{"h1":{"type":"string"},"content":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"keywords_analysis":{"type":"array","items":{"type":"object","properties":{"keyword":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"occurences_minimum_number":{"type":"number"},"occurences_maximum_number":{"type":"number"}}}},"url":{"type":"string"},"cover_image":{"type":"string"},"cover_images":{"type":"array","items":{"type":"string"}},"cover":{"type":"number"},"social":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"facebook":{"type":"string"},"x":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"root_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}}},"audio":{"type":"string"}}}}}}}}},"operationId":"patchV1DiscoverarticlesByIdOutputByOutputId"}},"/v1/discoverarticles/bulk":{"post":{"tags":["discoverarticles"],"summary":"Create multiple discoverarticles","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the discover article.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"writing_style":{"description":"The writing style of the discover article.","type":"string"},"website":{"description":"The website url of the discover article.","type":"string"},"length":{"default":400,"description":"Length of the discover article in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the discover article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the discover article.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the discover article.","type":"string"},"additional_information":{"description":"Additional information about the discover article.","type":"string"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}},"application/x-www-form-urlencoded":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the discover article.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"writing_style":{"description":"The writing style of the discover article.","type":"string"},"website":{"description":"The website url of the discover article.","type":"string"},"length":{"default":400,"description":"Length of the discover article in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the discover article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the discover article.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the discover article.","type":"string"},"additional_information":{"description":"Additional information about the discover article.","type":"string"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}},"multipart/form-data":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the discover article.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"writing_style":{"description":"The writing style of the discover article.","type":"string"},"website":{"description":"The website url of the discover article.","type":"string"},"length":{"default":400,"description":"Length of the discover article in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the discover article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the discover article.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the discover article.","type":"string"},"additional_information":{"description":"Additional information about the discover article.","type":"string"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}}}},"responses":{"200":{"description":"The ids of the created articles","content":{"application/json":{"schema":{"description":"The ids of the created articles","type":"object","required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"string"}}}}}}}},"operationId":"postV1DiscoverarticlesBulk"}},"/v1/discoverarticles/cost":{"post":{"tags":["discoverarticles"],"summary":"Get the cost of creating one discoverarticles","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the discover article.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"writing_style":{"description":"The writing style of the discover article.","type":"string"},"website":{"description":"The website url of the discover article.","type":"string"},"length":{"default":400,"description":"Length of the discover article in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the discover article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the discover article.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the discover article.","type":"string"},"additional_information":{"description":"Additional information about the discover article.","type":"string"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the discover article.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"writing_style":{"description":"The writing style of the discover article.","type":"string"},"website":{"description":"The website url of the discover article.","type":"string"},"length":{"default":400,"description":"Length of the discover article in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the discover article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the discover article.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the discover article.","type":"string"},"additional_information":{"description":"Additional information about the discover article.","type":"string"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}},"multipart/form-data":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the discover article.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"writing_style":{"description":"The writing style of the discover article.","type":"string"},"website":{"description":"The website url of the discover article.","type":"string"},"length":{"default":400,"description":"Length of the discover article in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the discover article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the discover article.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the discover article.","type":"string"},"additional_information":{"description":"Additional information about the discover article.","type":"string"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}}},"responses":{"200":{"description":"Get the cost of creating one discoverarticles and remaining credits","content":{"application/json":{"schema":{"description":"Get the cost of creating one discoverarticles and remaining credits","type":"object","required":["credits","cost"],"properties":{"credits":{"type":"number"},"cost":{"type":"number"}}}}}}},"operationId":"postV1DiscoverarticlesCost"}},"/v1/discoverarticles/bulk/cost":{"post":{"tags":["discoverarticles"],"summary":"Get the cost of creating multiple discoverarticles","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the discover article.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"writing_style":{"description":"The writing style of the discover article.","type":"string"},"website":{"description":"The website url of the discover article.","type":"string"},"length":{"default":400,"description":"Length of the discover article in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the discover article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the discover article.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the discover article.","type":"string"},"additional_information":{"description":"Additional information about the discover article.","type":"string"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}},"application/x-www-form-urlencoded":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the discover article.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"writing_style":{"description":"The writing style of the discover article.","type":"string"},"website":{"description":"The website url of the discover article.","type":"string"},"length":{"default":400,"description":"Length of the discover article in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the discover article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the discover article.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the discover article.","type":"string"},"additional_information":{"description":"Additional information about the discover article.","type":"string"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}},"multipart/form-data":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"subject":{"minLength":1,"description":"The subject of the discover article.","type":"string"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"writing_style":{"description":"The writing style of the discover article.","type":"string"},"website":{"description":"The website url of the discover article.","type":"string"},"length":{"default":400,"description":"Length of the discover article in words. Default is 'auto'","anyOf":[{"maximum":2000,"default":400,"description":"Length of the discover article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"project_id":{"description":"The project id of the discover article.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"title":{"description":"The title of the discover article.","type":"string"},"additional_information":{"description":"Additional information about the discover article.","type":"string"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"}}}}}}},"responses":{"200":{"description":"The cost of creating multiple discoverarticles and remaining credits","content":{"application/json":{"schema":{"description":"The cost of creating multiple discoverarticles and remaining credits","type":"object","required":["credits","cost"],"properties":{"credits":{"type":"number"},"cost":{"type":"number"}}}}}}},"operationId":"postV1DiscoverarticlesBulkCost"}},"/v1/discoverarticles/{id}/run":{"post":{"tags":["discoverarticles"],"summary":"Run a discoverarticles","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{}},"application/x-www-form-urlencoded":{"schema":{}},"multipart/form-data":{"schema":{}}}},"responses":{"200":{"description":"The id of the discoverarticles","content":{"application/json":{"schema":{"description":"The id of the discoverarticles","type":"object","required":["id","status"],"properties":{"id":{"type":"string"},"status":{"type":"string"}}}}}}},"operationId":"postV1DiscoverarticlesByIdRun"}},"/v1/entities/summary/":{"get":{"tags":["entities"],"summary":"Get entity counts summary","description":"Returns the count of entities per type for the authenticated user","parameters":[{"name":"projectId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","properties":{"articles":{"type":"number"},"categorypages":{"type":"number"},"productpages":{"type":"number"},"discoverarticles":{"type":"number"},"rssfeedtriggers":{"type":"number"},"total":{"type":"number"}},"additionalProperties":false}}}}},"operationId":"getV1EntitiesSummary"}},"/v1/entities/scheduled/":{"get":{"tags":["entities"],"summary":"List contents scheduled for WordPress in a range (≤ 62 days)","description":"Contents created with publishwordpress_status = \"future\", whose publishwordpress_date falls in [start, end). A date set later through the Publish button is only known to WordPress and is not listed.","parameters":[{"name":"start","in":"query","required":false,"schema":{"type":"string"}},{"name":"end","in":"query","required":false,"schema":{"type":"string"}},{"name":"projectId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","required":["id","name","title","project_id","status","scheduled_at","entity_published_url","entity_published_at"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"title":{"type":["string","null"]},"project_id":{"type":["string","null"]},"status":{"type":["string","null"]},"scheduled_at":{"type":"string"},"entity_published_url":{"type":["string","null"]},"entity_published_at":{"type":["string","null"]}}}}},"additionalProperties":false}}}}},"operationId":"getV1EntitiesScheduled"}},"/v1/authors/":{"get":{"tags":["authors"],"summary":"Get all authors","description":"Returns a flat list of all authors from all WordPress connections. Each author ID is formatted as \"{connection_uuid}_{author_id}\"","parameters":[{"name":"skip","in":"query","required":false,"schema":{"default":0,"anyOf":[{"default":0,"format":"numeric","type":"string"},{"default":0,"type":"number"}]}},{"name":"take","in":"query","required":false,"schema":{"default":9,"maximum":100,"anyOf":[{"default":0,"maximum":100,"format":"numeric","type":"string"},{"default":9,"maximum":100,"type":"number"}]}},{"name":"search","in":"query","required":false,"schema":{"default":"","type":"string"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["items","count"],"properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"connection_id":{"type":"string"},"author_id":{"type":"number"},"author_name":{"type":"string"},"user_id":{"type":"string"}}}},"count":{"type":"number"}},"additionalProperties":false}}}}},"operationId":"getV1Authors"}},"/v1/authors/{id}":{"get":{"tags":["authors"],"summary":"Get author by id","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"connection_id":{"type":"string"},"author_id":{"type":"number"},"author_name":{"type":"string"},"user_id":{"type":"string"}}}}}}},"operationId":"getV1AuthorsById"}},"/v1/categories/":{"get":{"tags":["categories"],"summary":"Get all categories","description":"Returns a flat list of all categoris from all WordPress connections. Each category ID is formatted as \"{connection_uuid}_{author_id}\"","parameters":[{"name":"skip","in":"query","required":false,"schema":{"default":0,"anyOf":[{"default":0,"format":"numeric","type":"string"},{"default":0,"type":"number"}]}},{"name":"take","in":"query","required":false,"schema":{"default":9,"maximum":100,"anyOf":[{"default":0,"maximum":100,"format":"numeric","type":"string"},{"default":9,"maximum":100,"type":"number"}]}},{"name":"search","in":"query","required":false,"schema":{"default":"","type":"string"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["items","count"],"properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"connection_id":{"type":"string"},"category_id":{"type":"number"},"category_name":{"type":"string"},"user_id":{"type":"string"}}}},"count":{"type":"number"}},"additionalProperties":false}}}}},"operationId":"getV1Categories"}},"/v1/categories/{id}":{"get":{"tags":["categories"],"summary":"Get category by id","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"connection_id":{"type":"string"},"category_id":{"type":"number"},"category_name":{"type":"string"},"user_id":{"type":"string"}}}}}}},"operationId":"getV1CategoriesById"}},"/v1/publish/wordpress/{entity_id}":{"post":{"tags":["publish"],"summary":"Publish entity to WordPress","description":"Publish an article or discover article to WordPress. Will create a new post or update existing one if found. Requests to WordPress include the User-Agent: Wisewand header — whitelist it in your hosting provider to avoid captcha blocks. You can also whitelist our IP : 34.76.27.167","parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"description":"The ID of the entity to publish","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["connection_id","status"],"properties":{"connection_id":{"description":"The ID of the WordPress connection to use","type":"string"},"status":{"description":"The status of the post","enum":["draft","publish","future"],"type":"string"},"date":{"description":"The date of the post, if the status is \"future\"","type":"string"},"author":{"description":"The author ID of the post. If not provided, will use the author associated with the WordPress credentials","type":"number"},"categories":{"type":"array","items":{"description":"The categories ID of the post. For automatic picking, use [-2]","type":"number"}},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish. Costs 0.1 credit.","type":"boolean"}},"additionalProperties":false}},"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["connection_id","status"],"properties":{"connection_id":{"description":"The ID of the WordPress connection to use","type":"string"},"status":{"description":"The status of the post","enum":["draft","publish","future"],"type":"string"},"date":{"description":"The date of the post, if the status is \"future\"","type":"string"},"author":{"description":"The author ID of the post. If not provided, will use the author associated with the WordPress credentials","type":"number"},"categories":{"type":"array","items":{"description":"The categories ID of the post. For automatic picking, use [-2]","type":"number"}},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish. Costs 0.1 credit.","type":"boolean"}},"additionalProperties":false}},"multipart/form-data":{"schema":{"type":"object","required":["connection_id","status"],"properties":{"connection_id":{"description":"The ID of the WordPress connection to use","type":"string"},"status":{"description":"The status of the post","enum":["draft","publish","future"],"type":"string"},"date":{"description":"The date of the post, if the status is \"future\"","type":"string"},"author":{"description":"The author ID of the post. If not provided, will use the author associated with the WordPress credentials","type":"number"},"categories":{"type":"array","items":{"description":"The categories ID of the post. For automatic picking, use [-2]","type":"number"}},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish. Costs 0.1 credit.","type":"boolean"}},"additionalProperties":false}}}},"operationId":"postV1PublishWordpressByEntity_id"}},"/v1/publish/webhook/{entity_id}":{"post":{"tags":["publish"],"summary":"Publish entity to webhook","description":"Publish an article or discover article to a webhook endpoint. Requests include the User-Agent: Wisewand header. You can also whitelist our IP : 34.76.27.167","parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"description":"The ID of the entity to publish","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["connection_id"],"properties":{"connection_id":{"description":"The ID of the webhook connection to use","type":"string"}},"additionalProperties":false}},"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["connection_id"],"properties":{"connection_id":{"description":"The ID of the webhook connection to use","type":"string"}},"additionalProperties":false}},"multipart/form-data":{"schema":{"type":"object","required":["connection_id"],"properties":{"connection_id":{"description":"The ID of the webhook connection to use","type":"string"}},"additionalProperties":false}}}},"operationId":"postV1PublishWebhookByEntity_id"}},"/v1/publish/shopify/{entity_id}":{"post":{"tags":["publish"],"summary":"Publish entity to Shopify","description":"Publish an article to a connected Shopify store via the GraphQL Admin API. Creates a new article or updates the existing one.","parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"description":"The ID of the entity to publish","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["connection_id"],"properties":{"connection_id":{"description":"The ID of the Shopify connection to use","type":"string"},"status":{"description":"Article status: \"publish\" (default) or \"draft\".","enum":["draft","publish","future"],"type":"string"},"date":{"description":"Publish date when status is \"future\".","type":"string"},"author":{"description":"Article author name shown on the store.","type":"string"},"blog_id":{"description":"Target blog GID (from the project or per-article config). When omitted, falls back to the project's saved blog, then to the store's default blog — which is then saved on the project.","type":"string"},"blog_handle":{"description":"Target blog handle, used to build the public post URL.","type":"string"},"tags":{"description":"Article tags.","type":"array","items":{"type":"string"}}}}},"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["connection_id"],"properties":{"connection_id":{"description":"The ID of the Shopify connection to use","type":"string"},"status":{"description":"Article status: \"publish\" (default) or \"draft\".","enum":["draft","publish","future"],"type":"string"},"date":{"description":"Publish date when status is \"future\".","type":"string"},"author":{"description":"Article author name shown on the store.","type":"string"},"blog_id":{"description":"Target blog GID (from the project or per-article config). When omitted, falls back to the project's saved blog, then to the store's default blog — which is then saved on the project.","type":"string"},"blog_handle":{"description":"Target blog handle, used to build the public post URL.","type":"string"},"tags":{"description":"Article tags.","type":"array","items":{"type":"string"}}}}},"multipart/form-data":{"schema":{"type":"object","required":["connection_id"],"properties":{"connection_id":{"description":"The ID of the Shopify connection to use","type":"string"},"status":{"description":"Article status: \"publish\" (default) or \"draft\".","enum":["draft","publish","future"],"type":"string"},"date":{"description":"Publish date when status is \"future\".","type":"string"},"author":{"description":"Article author name shown on the store.","type":"string"},"blog_id":{"description":"Target blog GID (from the project or per-article config). When omitted, falls back to the project's saved blog, then to the store's default blog — which is then saved on the project.","type":"string"},"blog_handle":{"description":"Target blog handle, used to build the public post URL.","type":"string"},"tags":{"description":"Article tags.","type":"array","items":{"type":"string"}}}}}}},"operationId":"postV1PublishShopifyByEntity_id"}},"/v1/publish/prestashop/{entity_id}":{"post":{"tags":["publish"],"summary":"Publish entity to Prestashop","description":"Publish an article or discover article to a Prestashop endpoint. Requests include the User-Agent: Wisewand header. You can also whitelist our IP : 34.76.27.167","parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"description":"The ID of the entity to publish","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["connection_id"],"properties":{"connection_id":{"description":"The ID of the Prestashop connection to use","type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["connection_id"],"properties":{"connection_id":{"description":"The ID of the Prestashop connection to use","type":"string"}}}},"multipart/form-data":{"schema":{"type":"object","required":["connection_id"],"properties":{"connection_id":{"description":"The ID of the Prestashop connection to use","type":"string"}}}}}},"operationId":"postV1PublishPrestashopByEntity_id"}},"/v1/publish/woocommerce/{entity_id}":{"post":{"tags":["publish"],"summary":"Publish entity to WooCommerce","description":"Publish an article or discover article to a WooCommerce endpoint. Requests include the User-Agent: Wisewand header. You can also whitelist our IP : 34.76.27.167","parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"description":"The ID of the entity to publish","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["connection_id"],"properties":{"connection_id":{"description":"The ID of the WooCommerce connection to use","type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["connection_id"],"properties":{"connection_id":{"description":"The ID of the WooCommerce connection to use","type":"string"}}}},"multipart/form-data":{"schema":{"type":"object","required":["connection_id"],"properties":{"connection_id":{"description":"The ID of the WooCommerce connection to use","type":"string"}}}}}},"operationId":"postV1PublishWoocommerceByEntity_id"}},"/v1/publish-errors/":{"get":{"tags":["publish"],"summary":"List unresolved publish errors","description":"Lists publish_errors rows with resolved_at IS NULL, filtered by entity, connection or project (exactly one filter required).","parameters":[{"name":"entity_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"connection_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"project_id","in":"query","required":false,"schema":{"type":"string"}}],"operationId":"getV1Publish-errors"}},"/v1/generation-failures/":{"get":{"tags":["entities"],"summary":"Why failed contents failed","description":"For each failed content among entity_ids (at most 50), its cause (credits, platform, rejected, no_data, other), the AI explanation for other, the Trigger.dev run and whether its credits were refunded; pending while the reason is being read.","parameters":[{"name":"entity_ids","in":"query","required":true,"schema":{"minLength":1,"maxLength":1850,"type":"string"}}],"responses":{"200":{"description":"The failed contents among entity_ids; the others are left out","content":{"application/json":{"schema":{"description":"The failed contents among entity_ids; the others are left out","type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","required":["entity_id","state","cause","message","run_id","refunded"],"properties":{"entity_id":{"type":"string"},"state":{"default":"ready","description":"pending while the reason is being read: ask again in a few seconds","type":"string","enum":["ready","pending"]},"cause":{"default":"credits","type":["string","null"],"enum":["credits","platform","rejected","no_data","other"]},"message":{"type":["string","null"]},"run_id":{"type":["string","null"]},"refunded":{"description":"Whether the credits of that run were refunded","type":"boolean"}}}}},"additionalProperties":false}}}},"400":{"description":"entity_ids missing, more than 50, or not content ids","content":{"application/json":{"schema":{"description":"entity_ids missing, more than 50, or not content ids","anyOf":[{"type":"object","required":["name","message"],"properties":{"name":{"type":"string"},"message":{"type":"string"}}},{"type":"object","required":["error","validation_errors"],"properties":{"error":{"type":"string"},"validation_errors":{"type":"array","items":{"type":"object","required":["field","messages"],"properties":{"field":{"type":"string"},"messages":{"type":"array","items":{"type":"string"}}}}}}}]}}}},"401":{"description":"Missing or invalid token","content":{"application/json":{"schema":{"description":"Missing or invalid token","type":"object","required":["name","message"],"properties":{"name":{"type":"string"},"message":{"type":"string"}},"additionalProperties":false}}}}},"operationId":"getV1Generation-failures"}},"/v1/updateposts/":{"get":{"tags":["updateposts"],"summary":"List updateposts","parameters":[{"name":"skip","in":"query","required":false,"schema":{"default":0,"type":"number"}},{"name":"take","in":"query","required":false,"schema":{"default":9,"maximum":50,"type":"number"}},{"name":"search","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"maker","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"status","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"projectId","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"persona","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"author","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"category","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"published","in":"query","required":false,"schema":{"type":"string"}},{"name":"source","in":"query","required":false,"schema":{"description":"Comma-separated sources (app, autopilot, feed, api, merlin); `none` = contents without a source","examples":["feed,api","none"],"type":"string"}},{"name":"format","in":"query","required":false,"schema":{"description":"Comma-separated article formats (`data.input.type`)","examples":["blog,news"],"type":"string"}},{"name":"statusGroup","in":"query","required":false,"schema":{"description":"Comma-separated status groups: waiting (prequeued, queued, idle), running (starting, running), success, error (error, interrupted)","examples":["waiting,error"],"type":"string"}},{"name":"created_from","in":"query","required":false,"schema":{"description":"Created at or after this ISO date-time","examples":["2026-10-01T00:00:00+02:00"],"type":"string"}},{"name":"created_to","in":"query","required":false,"schema":{"description":"Created at or before this ISO date-time","examples":["2026-10-31T23:59:59+01:00"],"type":"string"}}],"responses":{"200":{"description":"The list of articles","content":{"application/json":{"schema":{"description":"The list of articles","type":"object","required":["items","count"],"properties":{"items":{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{"id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"},"name":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"title":{"type":"string"},"data":{"type":"object","required":["input"],"properties":{"input":{"additionalProperties":true,"type":"object","properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}}},"status":{"enum":["queued","running","success","error"],"type":"string"},"status_detail":{"type":"string"},"last_output_id":{"format":"uuid","type":"string"},"project_id":{"format":"uuid","type":"string"},"maker_id":{"format":"uuid","type":"string"},"source":{"enum":["app","autopilot","feed","api","merlin"],"description":"Where the content comes from, written by the API on creation (null = unknown)","type":["string","null"]},"cover_image":{"type":"string"},"is_published":{"type":"boolean"},"placed_resources":{"description":"The article's resources (data.input.resources) that came out as a block in its HTML, in the order of the article: an empty list means none was placed. Read from the current HTML: an article edited by hand afterwards may differ from what was written. Present once the article is written and carries a resource list.","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"description":"Title of the resource, as the list holds it.","type":"string"},"url":{"description":"Its link, as the list holds it.","type":"string"}}}}}}},"count":{"default":0,"type":"number"}}}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}},"operationId":"getV1Updateposts"},"post":{"tags":["updateposts"],"summary":"Create and run a updateposts","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}}}},"responses":{"200":{"description":"The id of the created article","content":{"application/json":{"schema":{"description":"The id of the created article","type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"500":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}},"operationId":"postV1Updateposts"}},"/v1/updateposts/{id}":{"get":{"tags":["updateposts"],"summary":"Get a updateposts","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The updateposts","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{"id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"},"name":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"title":{"type":"string"},"data":{"type":"object","required":["input"],"properties":{"input":{"additionalProperties":true,"type":"object","properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}}},"status":{"enum":["queued","running","success","error"],"type":"string"},"status_detail":{"type":"string"},"last_output_id":{"format":"uuid","type":"string"},"project_id":{"format":"uuid","type":"string"},"maker_id":{"format":"uuid","type":"string"},"source":{"enum":["app","autopilot","feed","api","merlin"],"description":"Where the content comes from, written by the API on creation (null = unknown)","type":["string","null"]},"cover_image":{"type":"string"},"is_published":{"type":"boolean"},"placed_resources":{"description":"The article's resources (data.input.resources) that came out as a block in its HTML, in the order of the article: an empty list means none was placed. Read from the current HTML: an article edited by hand afterwards may differ from what was written. Present once the article is written and carries a resource list.","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"description":"Title of the resource, as the list holds it.","type":"string"},"url":{"description":"Its link, as the list holds it.","type":"string"}}}}},"description":"The updateposts"}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}},"operationId":"getV1UpdatepostsById"},"patch":{"tags":["updateposts"],"summary":"Update a updateposts","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"description":"Length of the article in words.","type":"number"},{"pattern":"auto","type":"string"}]},"keep_title":{"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string"},"persona_id":{"type":"string"},"use_cta":{"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"type":"boolean"},"use_indexed_pages_internal_links":{"type":"boolean"},"use_wp_internal_links":{"type":"boolean"},"use_shopify_internal_links":{"type":"boolean"},"use_app_internal_links":{"type":"boolean"},"use_list_internal_links":{"type":"boolean"},"internal_links_wp_status":{"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string"},"publishwordpress_category":{"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string"},"use_inlinephotos":{"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":true,"type":"object","properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"description":"Length of the article in words.","type":"number"},{"pattern":"auto","type":"string"}]},"keep_title":{"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string"},"persona_id":{"type":"string"},"use_cta":{"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"type":"boolean"},"use_indexed_pages_internal_links":{"type":"boolean"},"use_wp_internal_links":{"type":"boolean"},"use_shopify_internal_links":{"type":"boolean"},"use_app_internal_links":{"type":"boolean"},"use_list_internal_links":{"type":"boolean"},"internal_links_wp_status":{"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string"},"publishwordpress_category":{"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string"},"use_inlinephotos":{"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":true,"type":"object","properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"description":"Length of the article in words.","type":"number"},{"pattern":"auto","type":"string"}]},"keep_title":{"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string"},"persona_id":{"type":"string"},"use_cta":{"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"type":"boolean"},"use_indexed_pages_internal_links":{"type":"boolean"},"use_wp_internal_links":{"type":"boolean"},"use_shopify_internal_links":{"type":"boolean"},"use_app_internal_links":{"type":"boolean"},"use_list_internal_links":{"type":"boolean"},"internal_links_wp_status":{"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string"},"publishwordpress_category":{"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string"},"use_inlinephotos":{"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}}}},"responses":{"200":{"description":"The updated updateposts","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{"id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"},"name":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"title":{"type":"string"},"data":{"type":"object","required":["input"],"properties":{"input":{"additionalProperties":true,"type":"object","properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}}},"status":{"enum":["queued","running","success","error"],"type":"string"},"status_detail":{"type":"string"},"last_output_id":{"format":"uuid","type":"string"},"project_id":{"format":"uuid","type":"string"},"maker_id":{"format":"uuid","type":"string"},"source":{"enum":["app","autopilot","feed","api","merlin"],"description":"Where the content comes from, written by the API on creation (null = unknown)","type":["string","null"]},"cover_image":{"type":"string"},"is_published":{"type":"boolean"},"placed_resources":{"description":"The article's resources (data.input.resources) that came out as a block in its HTML, in the order of the article: an empty list means none was placed. Read from the current HTML: an article edited by hand afterwards may differ from what was written. Present once the article is written and carries a resource list.","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"description":"Title of the resource, as the list holds it.","type":"string"},"url":{"description":"Its link, as the list holds it.","type":"string"}}}}},"description":"The updated updateposts"}}}}},"operationId":"patchV1UpdatepostsById"}},"/v1/updateposts/{id}/output":{"get":{"tags":["updateposts"],"summary":"Get the result of updateposts","description":"If no outputId is provided, the latest output will be returned","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"outputId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The updateposts output","content":{"application/json":{"schema":{"description":"The updateposts output","type":"object","required":["id","all_outputs","output"],"properties":{"id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"all_outputs":{"type":"array","items":{"type":"object","required":["id","created_at"],"properties":{"id":{"type":"string"},"created_at":{"type":"string"}}}},"input":{"additionalProperties":true,"type":"object","properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}},"output":{"additionalProperties":true,"type":"object","properties":{"h1":{"type":"string"},"content":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"keywords_analysis":{"type":"array","items":{"type":"object","properties":{"keyword":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"occurences_minimum_number":{"type":"number"},"occurences_maximum_number":{"type":"number"}}}},"url":{"type":"string"},"cover":{"type":"number"},"cover_image":{"type":"string"},"cover_images":{"type":"array","items":{"type":"string"}},"faq":{"type":"string"},"information_search":{"type":"string"},"social":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"facebook":{"type":"string"},"x":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"root_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}}},"audio":{"type":"string"}}},"status":{"type":"string"}}}}}}},"operationId":"getV1UpdatepostsByIdOutput"}},"/v1/updateposts/{id}/output/{outputId}":{"patch":{"tags":["updateposts"],"summary":"Update the result of updateposts","description":"If no outputId is provided, the latest output will be returned","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"outputId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{"h1":{"type":"string"},"content":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"keywords_analysis":{"type":"array","items":{"type":"object","properties":{"keyword":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"occurences_minimum_number":{"type":"number"},"occurences_maximum_number":{"type":"number"}}}},"url":{"type":"string"},"cover":{"type":"number"},"cover_image":{"type":"string"},"cover_images":{"type":"array","items":{"type":"string"}},"faq":{"type":"string"},"information_search":{"type":"string"},"social":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"facebook":{"type":"string"},"x":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"root_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}}},"audio":{"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":true,"type":"object","properties":{"h1":{"type":"string"},"content":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"keywords_analysis":{"type":"array","items":{"type":"object","properties":{"keyword":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"occurences_minimum_number":{"type":"number"},"occurences_maximum_number":{"type":"number"}}}},"url":{"type":"string"},"cover":{"type":"number"},"cover_image":{"type":"string"},"cover_images":{"type":"array","items":{"type":"string"}},"faq":{"type":"string"},"information_search":{"type":"string"},"social":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"facebook":{"type":"string"},"x":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"root_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}}},"audio":{"type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":true,"type":"object","properties":{"h1":{"type":"string"},"content":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"keywords_analysis":{"type":"array","items":{"type":"object","properties":{"keyword":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"occurences_minimum_number":{"type":"number"},"occurences_maximum_number":{"type":"number"}}}},"url":{"type":"string"},"cover":{"type":"number"},"cover_image":{"type":"string"},"cover_images":{"type":"array","items":{"type":"string"}},"faq":{"type":"string"},"information_search":{"type":"string"},"social":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"facebook":{"type":"string"},"x":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"root_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}}},"audio":{"type":"string"}}}}}},"responses":{"200":{"description":"The updateposts output","content":{"application/json":{"schema":{"description":"The updateposts output","type":"object","required":["id","output"],"properties":{"id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"output":{"additionalProperties":true,"type":"object","properties":{"h1":{"type":"string"},"content":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"keywords_analysis":{"type":"array","items":{"type":"object","properties":{"keyword":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"occurences_minimum_number":{"type":"number"},"occurences_maximum_number":{"type":"number"}}}},"url":{"type":"string"},"cover":{"type":"number"},"cover_image":{"type":"string"},"cover_images":{"type":"array","items":{"type":"string"}},"faq":{"type":"string"},"information_search":{"type":"string"},"social":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"facebook":{"type":"string"},"x":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"root_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}}},"audio":{"type":"string"}}}}}}}}},"operationId":"patchV1UpdatepostsByIdOutputByOutputId"}},"/v1/updateposts/bulk":{"post":{"tags":["updateposts"],"summary":"Create multiple updateposts","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}}},"application/x-www-form-urlencoded":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}}},"multipart/form-data":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}}}}},"responses":{"200":{"description":"The ids of the created articles","content":{"application/json":{"schema":{"description":"The ids of the created articles","type":"object","required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"string"}}}}}}}},"operationId":"postV1UpdatepostsBulk"}},"/v1/updateposts/cost":{"post":{"tags":["updateposts"],"summary":"Get the cost of creating one updateposts","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}}}},"responses":{"200":{"description":"Get the cost of creating one updateposts and remaining credits","content":{"application/json":{"schema":{"description":"Get the cost of creating one updateposts and remaining credits","type":"object","required":["credits","cost"],"properties":{"credits":{"type":"number"},"cost":{"type":"number"}}}}}}},"operationId":"postV1UpdatepostsCost"}},"/v1/updateposts/bulk/cost":{"post":{"tags":["updateposts"],"summary":"Get the cost of creating multiple updateposts","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}}},"application/x-www-form-urlencoded":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}}},"multipart/form-data":{"schema":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["subject"],"properties":{"title":{"description":"Title of the article.","type":"string"},"type":{"description":"Type of the article. Default is \"blog\". The type \"affiliation-promo-code-product\" is deprecated.","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"subject":{"minLength":1,"description":"The subject of the article. It can also contains source URLs.","type":"string"},"length":{"default":"auto","description":"Length of the article in words. Default is 'auto'","anyOf":[{"maximum":5000,"default":1000,"description":"Length of the article in words.","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"keep_title":{"default":false,"description":"If true, the content of the subject field will be used as title","type":"boolean"},"target_keyword":{"description":"SERP target keyword","type":"string"},"keywords_secondary":{"description":"Secondary keywords","type":"string"},"search_intention_answer":{"type":"string"},"additional_information":{"type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter). Absent: the project's (brief_config.lang), else fr.","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string"},"country":{"description":"Country code (Google `gl` parameter). Absent: the project's when the language is the project's, else fr.","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string"},"project_id":{"format":"uuid","description":"By setting the project id, you will also link the website URL and other project default configuration.","type":"string"},"apply_project_brief_config":{"default":false,"description":"If true, the project brief config will be applied to the article.","type":"boolean"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"resources":{"maxItems":10,"description":"The client's resources: guides, ebooks or pages hosted elsewhere, that the article may point to with a « block + button ». The engine places at most 2, at the end of the section each one extends, and none when none is relevant; a forced one is always placed. Empty entries and duplicates are dropped. On a project (`brief_config.resources`), it is the default list of every article of the project; to change only the list, PATCH /v1/projects/{id} with a `brief_config` holding `resources` alone (any other key in `brief_config` replaces the whole brief). On an article: left out, the project's list applies (applied brief or not); an empty list means no resource for this article; a list sent replaces the project's for this article (send the project's list with one entry set `forced: true` to force it on one article).","type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"maxLength":200,"description":"Title of the resource, shown in the block (e.g. \"Guide des activités\").","type":"string"},"url":{"maxLength":2048,"pattern":"^\\s*(https?://\\S+)?\\s*$","description":"Where the resource is hosted: an http(s) link. Wisewand hosts no file.","type":"string"},"topic":{"maxLength":500,"description":"What the resource is about: what the engine judges its relevance on (the title when absent).","type":"string"},"forced":{"description":"If true, the resource is placed in every article, even one that is not about it. At most 2 forced resources on a project (a third answers 422): an article holds 2 blocks at most.","type":"boolean"}}}},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"},"affiliation_product_name":{"description":"[Affiliation 'product review'] product name","type":"string"},"affiliation_product_review_urls":{"description":"[Affiliation 'product review'] Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"[Affiliation 'product review'] Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code":{"description":"[Affiliation 'product review'] Promo code (e.g., 'PROMO20')","type":"string"},"affiliation_promo_percentage":{"description":"[Affiliation 'product review'] Promo percentage (e.g., '20%')","type":"string"},"affiliation_product_1_name":{"description":"[Affiliation 'compare products'] Product 1 name","type":"string"},"affiliation_product_1_review_urls":{"description":"[Affiliation 'compare products'] Product 1 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_1":{"description":"[Affiliation 'compare products'] Product 1 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_1":{"description":"[Affiliation 'compare products'] Product 1 promo code","type":"string"},"affiliation_promo_percentage_1":{"description":"[Affiliation 'compare products'] Product 1 promo percentage","type":"string"},"affiliation_product_2_name":{"description":"[Affiliation 'compare products'] Product 2 name","type":"string"},"affiliation_product_2_review_urls":{"description":"[Affiliation 'compare products'] Product 2 review URLs","type":"array","items":{"type":"string"}},"affiliation_links_product_2":{"description":"[Affiliation 'compare products'] Product 2 affiliation links","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"affiliation_promo_code_2":{"description":"[Affiliation 'compare products'] Product 2 promo code","type":"string"},"affiliation_promo_percentage_2":{"description":"[Affiliation 'compare products'] Product 2 promo percentage","type":"string"},"affiliation_top_products":{"description":"[Affiliation 'top products'] List of top products","type":"array","items":{"type":"object","properties":{"name":{"description":"Product name","type":"string"},"urls":{"description":"Product review URLs","type":"array","items":{"type":"string"}},"affiliation_links":{"description":"Affiliation links to insert","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"anchor":{"type":"string"}}}},"promo_code":{"description":"Promo code (e.g., \"PROMO20\")","type":"string"},"promo_percentage":{"description":"Promo percentage (e.g., \"20%\")","type":"string"}}}},"use_enhancedformatting":{"default":false,"description":"If true, the article will include styled formatting elements (tip boxes, info boxes, styled tables, CTA blocks) using the project style guide colors","type":"boolean"},"auto_import_assets":{"default":true,"description":"If true, automatically inject CSS stylesheet and Alpine.js script tags in the article HTML when enhanced formatting is enabled","type":"boolean"},"use_widget":{"default":false,"description":"If true, an interactive widget (calculator, quiz, etc.) relevant to the article subject will be generated and inserted","type":"boolean"},"use_video":{"default":false,"description":"If true, a relevant YouTube video will be searched and embedded in the article","type":"boolean"},"video_position":{"description":"Position where the YouTube video will be inserted in the article","enum":["after_intro","before_conclusion","after_first_h2"],"type":"string","default":"after_first_h2"},"use_inlinephotos":{"default":false,"description":"If true, a realistic photo will be generated and inserted for each H2 section (if no infographic is already present)","type":"boolean"},"use_schemaorg":{"default":false,"description":"If true, generates Schema.org JSON-LD structured data","type":"boolean"},"use_index":{"default":false,"description":"If true, the published URL is submitted to Google for indexing after a successful publish.","type":"boolean"},"use_catalog_web_complement":{"default":false,"description":"If true, web research may complete the article with products outside the connected store catalog. Store products always come first.","type":"boolean"},"use_product_web_enrichment":{"default":false,"description":"If true, missing product specs (dimensions, weight, materials) and usage context are looked up on the web for each store product.","type":"boolean"},"options_mode":{"description":"How a V3 article picks its content options. \"auto\": the standard set (bold keywords, FAQ, table of contents, landscape featured image, internal links, tables, lists, callouts, widget, video, photos, summary, quotes), whatever the use_* fields say. \"custom\": every use_* field is followed as sent. When absent, the API decides: \"custom\" if the request sends at least one content option (use_faq, use_infotable, use_bulletlist…), \"auto\" otherwise. With apply_project_brief_config, the project brief decides when it says something: its own options_mode, else \"custom\" if its brief_config holds a content option; a brief with neither keeps the mode of the request.","enum":["auto","custom"],"type":"string"}}}}}}},"responses":{"200":{"description":"The cost of creating multiple updateposts and remaining credits","content":{"application/json":{"schema":{"description":"The cost of creating multiple updateposts and remaining credits","type":"object","required":["credits","cost"],"properties":{"credits":{"type":"number"},"cost":{"type":"number"}}}}}}},"operationId":"postV1UpdatepostsBulkCost"}},"/v1/updateposts/{id}/run":{"post":{"tags":["updateposts"],"summary":"Run a updateposts","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{}},"application/x-www-form-urlencoded":{"schema":{}},"multipart/form-data":{"schema":{}}}},"responses":{"200":{"description":"The id of the updateposts","content":{"application/json":{"schema":{"description":"The id of the updateposts","type":"object","required":["id","status"],"properties":{"id":{"type":"string"},"status":{"type":"string"}}}}}}},"operationId":"postV1UpdatepostsByIdRun"}},"/v1/refreshes/diagnose":{"post":{"tags":["refreshes"],"summary":"Run the free diagnostic of a page (one per 24 hours)","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["url"],"properties":{"url":{"minLength":8,"maxLength":2000,"description":"The address of the published page, on any site","type":"string"},"project_id":{"format":"uuid","description":"The Wisewand project of the site","type":"string"},"target_keyword":{"minLength":1,"maxLength":200,"description":"The keyword to keep; absent, it is deduced","type":"string"},"lang":{"minLength":2,"maxLength":10,"description":"Language code, e.g. fr","type":"string"},"country":{"minLength":2,"maxLength":10,"description":"Country code, e.g. fr","type":"string"},"enable_generation":{"description":"false creates the line without running it (run it later by id)","type":"boolean"},"republish":{"description":"Republish in place on WordPress or Shopify once the update is done (D15); false delivers a copy to review","type":"boolean"},"allow_builder_republish":{"description":"Republish even a page built with a page builder (D16)","type":"boolean"},"listed_position":{"additionalProperties":false,"description":"The dated position of the page in the list of ranked pages (GET /v1/refreshes/candidates): the diagnostic shows it as the former position when the page fell since","type":"object","required":["value","fetched_at","source"],"properties":{"value":{"minimum":1,"maximum":1000,"description":"The position the list showed","type":"number"},"fetched_at":{"format":"date-time","description":"When it was measured, UTC","type":"string"},"source":{"type":"string","enum":["dataforseo_ranked_keywords","dataforseo_serp"]}}}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["url"],"properties":{"url":{"minLength":8,"maxLength":2000,"description":"The address of the published page, on any site","type":"string"},"project_id":{"format":"uuid","description":"The Wisewand project of the site","type":"string"},"target_keyword":{"minLength":1,"maxLength":200,"description":"The keyword to keep; absent, it is deduced","type":"string"},"lang":{"minLength":2,"maxLength":10,"description":"Language code, e.g. fr","type":"string"},"country":{"minLength":2,"maxLength":10,"description":"Country code, e.g. fr","type":"string"},"enable_generation":{"description":"false creates the line without running it (run it later by id)","type":"boolean"},"republish":{"description":"Republish in place on WordPress or Shopify once the update is done (D15); false delivers a copy to review","type":"boolean"},"allow_builder_republish":{"description":"Republish even a page built with a page builder (D16)","type":"boolean"},"listed_position":{"additionalProperties":false,"description":"The dated position of the page in the list of ranked pages (GET /v1/refreshes/candidates): the diagnostic shows it as the former position when the page fell since","type":"object","required":["value","fetched_at","source"],"properties":{"value":{"minimum":1,"maximum":1000,"description":"The position the list showed","type":"number"},"fetched_at":{"format":"date-time","description":"When it was measured, UTC","type":"string"},"source":{"type":"string","enum":["dataforseo_ranked_keywords","dataforseo_serp"]}}}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["url"],"properties":{"url":{"minLength":8,"maxLength":2000,"description":"The address of the published page, on any site","type":"string"},"project_id":{"format":"uuid","description":"The Wisewand project of the site","type":"string"},"target_keyword":{"minLength":1,"maxLength":200,"description":"The keyword to keep; absent, it is deduced","type":"string"},"lang":{"minLength":2,"maxLength":10,"description":"Language code, e.g. fr","type":"string"},"country":{"minLength":2,"maxLength":10,"description":"Country code, e.g. fr","type":"string"},"enable_generation":{"description":"false creates the line without running it (run it later by id)","type":"boolean"},"republish":{"description":"Republish in place on WordPress or Shopify once the update is done (D15); false delivers a copy to review","type":"boolean"},"allow_builder_republish":{"description":"Republish even a page built with a page builder (D16)","type":"boolean"},"listed_position":{"additionalProperties":false,"description":"The dated position of the page in the list of ranked pages (GET /v1/refreshes/candidates): the diagnostic shows it as the former position when the page fell since","type":"object","required":["value","fetched_at","source"],"properties":{"value":{"minimum":1,"maximum":1000,"description":"The position the list showed","type":"number"},"fetched_at":{"format":"date-time","description":"When it was measured, UTC","type":"string"},"source":{"type":"string","enum":["dataforseo_ranked_keywords","dataforseo_serp"]}}}}}}}},"operationId":"postV1RefreshesDiagnose"}},"/v1/refreshes/cost":{"post":{"tags":["refreshes"],"summary":"The cost of an update and the credits left","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"url":{"minLength":8,"maxLength":2000,"description":"The address of the published page, on any site","type":"string"},"project_id":{"format":"uuid","description":"The Wisewand project of the site","type":"string"},"target_keyword":{"minLength":1,"maxLength":200,"description":"The keyword to keep; absent, it is deduced","type":"string"},"lang":{"minLength":2,"maxLength":10,"description":"Language code, e.g. fr","type":"string"},"country":{"minLength":2,"maxLength":10,"description":"Country code, e.g. fr","type":"string"},"enable_generation":{"description":"false creates the line without running it (run it later by id)","type":"boolean"},"republish":{"description":"Republish in place on WordPress or Shopify once the update is done (D15); false delivers a copy to review","type":"boolean"},"allow_builder_republish":{"description":"Republish even a page built with a page builder (D16)","type":"boolean"},"listed_position":{"additionalProperties":false,"description":"The dated position of the page in the list of ranked pages (GET /v1/refreshes/candidates): the diagnostic shows it as the former position when the page fell since","type":"object","required":["value","fetched_at","source"],"properties":{"value":{"minimum":1,"maximum":1000,"description":"The position the list showed","type":"number"},"fetched_at":{"format":"date-time","description":"When it was measured, UTC","type":"string"},"source":{"type":"string","enum":["dataforseo_ranked_keywords","dataforseo_serp"]}}}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","properties":{"url":{"minLength":8,"maxLength":2000,"description":"The address of the published page, on any site","type":"string"},"project_id":{"format":"uuid","description":"The Wisewand project of the site","type":"string"},"target_keyword":{"minLength":1,"maxLength":200,"description":"The keyword to keep; absent, it is deduced","type":"string"},"lang":{"minLength":2,"maxLength":10,"description":"Language code, e.g. fr","type":"string"},"country":{"minLength":2,"maxLength":10,"description":"Country code, e.g. fr","type":"string"},"enable_generation":{"description":"false creates the line without running it (run it later by id)","type":"boolean"},"republish":{"description":"Republish in place on WordPress or Shopify once the update is done (D15); false delivers a copy to review","type":"boolean"},"allow_builder_republish":{"description":"Republish even a page built with a page builder (D16)","type":"boolean"},"listed_position":{"additionalProperties":false,"description":"The dated position of the page in the list of ranked pages (GET /v1/refreshes/candidates): the diagnostic shows it as the former position when the page fell since","type":"object","required":["value","fetched_at","source"],"properties":{"value":{"minimum":1,"maximum":1000,"description":"The position the list showed","type":"number"},"fetched_at":{"format":"date-time","description":"When it was measured, UTC","type":"string"},"source":{"type":"string","enum":["dataforseo_ranked_keywords","dataforseo_serp"]}}}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","properties":{"url":{"minLength":8,"maxLength":2000,"description":"The address of the published page, on any site","type":"string"},"project_id":{"format":"uuid","description":"The Wisewand project of the site","type":"string"},"target_keyword":{"minLength":1,"maxLength":200,"description":"The keyword to keep; absent, it is deduced","type":"string"},"lang":{"minLength":2,"maxLength":10,"description":"Language code, e.g. fr","type":"string"},"country":{"minLength":2,"maxLength":10,"description":"Country code, e.g. fr","type":"string"},"enable_generation":{"description":"false creates the line without running it (run it later by id)","type":"boolean"},"republish":{"description":"Republish in place on WordPress or Shopify once the update is done (D15); false delivers a copy to review","type":"boolean"},"allow_builder_republish":{"description":"Republish even a page built with a page builder (D16)","type":"boolean"},"listed_position":{"additionalProperties":false,"description":"The dated position of the page in the list of ranked pages (GET /v1/refreshes/candidates): the diagnostic shows it as the former position when the page fell since","type":"object","required":["value","fetched_at","source"],"properties":{"value":{"minimum":1,"maximum":1000,"description":"The position the list showed","type":"number"},"fetched_at":{"format":"date-time","description":"When it was measured, UTC","type":"string"},"source":{"type":"string","enum":["dataforseo_ranked_keywords","dataforseo_serp"]}}}}}}}},"operationId":"postV1RefreshesCost"}},"/v1/refreshes/settings":{"get":{"tags":["refreshes"],"summary":"The refresh settings of a project (defaults when unset)","parameters":[{"name":"project_id","in":"query","required":true,"schema":{"format":"uuid","type":"string"}}],"operationId":"getV1RefreshesSettings"},"put":{"tags":["refreshes"],"summary":"Set the refresh settings of a project","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["project_id","settings"],"properties":{"project_id":{"format":"uuid","type":"string"},"settings":{"additionalProperties":false,"type":"object","required":["positions","rhythm","delivery","allow_builder_republish","enrichments","eligibility_days"],"properties":{"positions":{"additionalProperties":false,"type":"object","required":["light_max","normal_max"],"properties":{"light_max":{"description":"Top of the light band (D8); 1 to 99","type":"integer"},"normal_max":{"description":"Top of the normal band (D8); 2 to 100, above light_max","type":"integer"}}},"rhythm":{"type":"string","enum":["manual","proposed","automatic"]},"delivery":{"type":"string","enum":["review","republish"]},"allow_builder_republish":{"type":"boolean"},"enrichments":{"description":"D9: 'auto' lets Wisewand decide, 'options' is the client's choice","anyOf":[{"additionalProperties":false,"type":"object","required":["mode"],"properties":{"mode":{"const":"auto","type":"string"}}},{"additionalProperties":false,"type":"object","required":["mode","faq","internal_links","dated_sources","new_images"],"properties":{"mode":{"const":"options","type":"string"},"faq":{"type":"boolean"},"internal_links":{"type":"boolean"},"dated_sources":{"type":"boolean"},"new_images":{"type":"boolean"}}}]},"eligibility_days":{"description":"Days before an updated page is eligible again; 28 to 365","type":"integer"},"cadence":{"type":"string","enum":["daily","every_2_days","twice_weekly","weekly"]}}}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["project_id","settings"],"properties":{"project_id":{"format":"uuid","type":"string"},"settings":{"additionalProperties":false,"type":"object","required":["positions","rhythm","delivery","allow_builder_republish","enrichments","eligibility_days"],"properties":{"positions":{"additionalProperties":false,"type":"object","required":["light_max","normal_max"],"properties":{"light_max":{"description":"Top of the light band (D8); 1 to 99","type":"integer"},"normal_max":{"description":"Top of the normal band (D8); 2 to 100, above light_max","type":"integer"}}},"rhythm":{"type":"string","enum":["manual","proposed","automatic"]},"delivery":{"type":"string","enum":["review","republish"]},"allow_builder_republish":{"type":"boolean"},"enrichments":{"description":"D9: 'auto' lets Wisewand decide, 'options' is the client's choice","anyOf":[{"additionalProperties":false,"type":"object","required":["mode"],"properties":{"mode":{"const":"auto","type":"string"}}},{"additionalProperties":false,"type":"object","required":["mode","faq","internal_links","dated_sources","new_images"],"properties":{"mode":{"const":"options","type":"string"},"faq":{"type":"boolean"},"internal_links":{"type":"boolean"},"dated_sources":{"type":"boolean"},"new_images":{"type":"boolean"}}}]},"eligibility_days":{"description":"Days before an updated page is eligible again; 28 to 365","type":"integer"},"cadence":{"type":"string","enum":["daily","every_2_days","twice_weekly","weekly"]}}}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["project_id","settings"],"properties":{"project_id":{"format":"uuid","type":"string"},"settings":{"additionalProperties":false,"type":"object","required":["positions","rhythm","delivery","allow_builder_republish","enrichments","eligibility_days"],"properties":{"positions":{"additionalProperties":false,"type":"object","required":["light_max","normal_max"],"properties":{"light_max":{"description":"Top of the light band (D8); 1 to 99","type":"integer"},"normal_max":{"description":"Top of the normal band (D8); 2 to 100, above light_max","type":"integer"}}},"rhythm":{"type":"string","enum":["manual","proposed","automatic"]},"delivery":{"type":"string","enum":["review","republish"]},"allow_builder_republish":{"type":"boolean"},"enrichments":{"description":"D9: 'auto' lets Wisewand decide, 'options' is the client's choice","anyOf":[{"additionalProperties":false,"type":"object","required":["mode"],"properties":{"mode":{"const":"auto","type":"string"}}},{"additionalProperties":false,"type":"object","required":["mode","faq","internal_links","dated_sources","new_images"],"properties":{"mode":{"const":"options","type":"string"},"faq":{"type":"boolean"},"internal_links":{"type":"boolean"},"dated_sources":{"type":"boolean"},"new_images":{"type":"boolean"}}}]},"eligibility_days":{"description":"Days before an updated page is eligible again; 28 to 365","type":"integer"},"cadence":{"type":"string","enum":["daily","every_2_days","twice_weekly","weekly"]}}}}}}}},"operationId":"putV1RefreshesSettings"}},"/v1/refreshes/candidates":{"get":{"tags":["refreshes"],"summary":"The ranked candidate pages of a project (DataForSEO, cached ~24h)","parameters":[{"name":"project_id","in":"query","required":true,"schema":{"format":"uuid","type":"string"}},{"name":"refresh","in":"query","required":false,"schema":{"type":"string","enum":["0","1"]}}],"operationId":"getV1RefreshesCandidates"}},"/v1/refreshes/candidates/verify":{"post":{"tags":["refreshes"],"summary":"Check the positions of the ranked pages in Google today (once a day per project)","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["project_id"],"properties":{"project_id":{"format":"uuid","type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["project_id"],"properties":{"project_id":{"format":"uuid","type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["project_id"],"properties":{"project_id":{"format":"uuid","type":"string"}}}}}},"operationId":"postV1RefreshesCandidatesVerify"}},"/v1/refreshes/forecast":{"get":{"tags":["refreshes"],"summary":"The month consumption forecast of a project against its plan (D29)","parameters":[{"name":"project_id","in":"query","required":true,"schema":{"format":"uuid","type":"string"}}],"operationId":"getV1RefreshesForecast"}},"/v1/refreshes/overview":{"get":{"tags":["refreshes"],"summary":"Search Console state, settings, forecast, balance and diagnostic quota","parameters":[{"name":"project_id","in":"query","required":true,"schema":{"format":"uuid","type":"string"}}],"operationId":"getV1RefreshesOverview"}},"/v1/refreshes/effects":{"get":{"tags":["refreshes"],"summary":"The effect of the page updates: launch, J+14 and J+28 readings","parameters":[{"name":"project_id","in":"query","required":false,"schema":{"format":"uuid","type":"string"}}],"operationId":"getV1RefreshesEffects"}},"/v1/refreshes/autopilot":{"get":{"tags":["refreshes"],"summary":"The Autopilot mode of a project and its update proposals","parameters":[{"name":"project_id","in":"query","required":true,"schema":{"format":"uuid","type":"string"}}],"operationId":"getV1RefreshesAutopilot"},"put":{"tags":["refreshes"],"summary":"Set what the Autopilot does: articles, page updates, or both","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["project_id","articles","rhythm"],"properties":{"project_id":{"format":"uuid","type":"string"},"articles":{"type":"boolean"},"rhythm":{"type":"string","enum":["manual","proposed","automatic"]},"confirm":{"type":"boolean"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["project_id","articles","rhythm"],"properties":{"project_id":{"format":"uuid","type":"string"},"articles":{"type":"boolean"},"rhythm":{"type":"string","enum":["manual","proposed","automatic"]},"confirm":{"type":"boolean"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["project_id","articles","rhythm"],"properties":{"project_id":{"format":"uuid","type":"string"},"articles":{"type":"boolean"},"rhythm":{"type":"string","enum":["manual","proposed","automatic"]},"confirm":{"type":"boolean"}}}}}},"operationId":"putV1RefreshesAutopilot"}},"/v1/refreshes/proposals":{"get":{"tags":["refreshes"],"summary":"The update proposals of a project (open=1: the open ones only)","parameters":[{"name":"project_id","in":"query","required":true,"schema":{"format":"uuid","type":"string"}},{"name":"open","in":"query","required":false,"schema":{"type":"string","enum":["0","1"]}}],"operationId":"getV1RefreshesProposals"}},"/v1/refreshes/proposals/{cardId}/launch":{"post":{"tags":["refreshes"],"summary":"Launch a proposed page update now (1 credit)","parameters":[{"name":"cardId","in":"path","required":true,"schema":{"type":"string"}}],"operationId":"postV1RefreshesProposalsByCardIdLaunch"}},"/v1/refreshes/proposals/{cardId}/schedule":{"post":{"tags":["refreshes"],"summary":"Leave a proposed page update to its planned day","parameters":[{"name":"cardId","in":"path","required":true,"schema":{"type":"string"}}],"operationId":"postV1RefreshesProposalsByCardIdSchedule"}},"/v1/refreshes/proposals/{cardId}/refuse":{"post":{"tags":["refreshes"],"summary":"Refuse a proposed page update","parameters":[{"name":"cardId","in":"path","required":true,"schema":{"type":"string"}}],"operationId":"postV1RefreshesProposalsByCardIdRefuse"}},"/v1/refreshes/":{"post":{"tags":["refreshes"],"summary":"Update a page (1 credit), diagnostic included","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["url"],"properties":{"url":{"minLength":8,"maxLength":2000,"description":"The address of the published page, on any site","type":"string"},"project_id":{"format":"uuid","description":"The Wisewand project of the site","type":"string"},"target_keyword":{"minLength":1,"maxLength":200,"description":"The keyword to keep; absent, it is deduced","type":"string"},"lang":{"minLength":2,"maxLength":10,"description":"Language code, e.g. fr","type":"string"},"country":{"minLength":2,"maxLength":10,"description":"Country code, e.g. fr","type":"string"},"enable_generation":{"description":"false creates the line without running it (run it later by id)","type":"boolean"},"republish":{"description":"Republish in place on WordPress or Shopify once the update is done (D15); false delivers a copy to review","type":"boolean"},"allow_builder_republish":{"description":"Republish even a page built with a page builder (D16)","type":"boolean"},"listed_position":{"additionalProperties":false,"description":"The dated position of the page in the list of ranked pages (GET /v1/refreshes/candidates): the diagnostic shows it as the former position when the page fell since","type":"object","required":["value","fetched_at","source"],"properties":{"value":{"minimum":1,"maximum":1000,"description":"The position the list showed","type":"number"},"fetched_at":{"format":"date-time","description":"When it was measured, UTC","type":"string"},"source":{"type":"string","enum":["dataforseo_ranked_keywords","dataforseo_serp"]}}}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["url"],"properties":{"url":{"minLength":8,"maxLength":2000,"description":"The address of the published page, on any site","type":"string"},"project_id":{"format":"uuid","description":"The Wisewand project of the site","type":"string"},"target_keyword":{"minLength":1,"maxLength":200,"description":"The keyword to keep; absent, it is deduced","type":"string"},"lang":{"minLength":2,"maxLength":10,"description":"Language code, e.g. fr","type":"string"},"country":{"minLength":2,"maxLength":10,"description":"Country code, e.g. fr","type":"string"},"enable_generation":{"description":"false creates the line without running it (run it later by id)","type":"boolean"},"republish":{"description":"Republish in place on WordPress or Shopify once the update is done (D15); false delivers a copy to review","type":"boolean"},"allow_builder_republish":{"description":"Republish even a page built with a page builder (D16)","type":"boolean"},"listed_position":{"additionalProperties":false,"description":"The dated position of the page in the list of ranked pages (GET /v1/refreshes/candidates): the diagnostic shows it as the former position when the page fell since","type":"object","required":["value","fetched_at","source"],"properties":{"value":{"minimum":1,"maximum":1000,"description":"The position the list showed","type":"number"},"fetched_at":{"format":"date-time","description":"When it was measured, UTC","type":"string"},"source":{"type":"string","enum":["dataforseo_ranked_keywords","dataforseo_serp"]}}}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["url"],"properties":{"url":{"minLength":8,"maxLength":2000,"description":"The address of the published page, on any site","type":"string"},"project_id":{"format":"uuid","description":"The Wisewand project of the site","type":"string"},"target_keyword":{"minLength":1,"maxLength":200,"description":"The keyword to keep; absent, it is deduced","type":"string"},"lang":{"minLength":2,"maxLength":10,"description":"Language code, e.g. fr","type":"string"},"country":{"minLength":2,"maxLength":10,"description":"Country code, e.g. fr","type":"string"},"enable_generation":{"description":"false creates the line without running it (run it later by id)","type":"boolean"},"republish":{"description":"Republish in place on WordPress or Shopify once the update is done (D15); false delivers a copy to review","type":"boolean"},"allow_builder_republish":{"description":"Republish even a page built with a page builder (D16)","type":"boolean"},"listed_position":{"additionalProperties":false,"description":"The dated position of the page in the list of ranked pages (GET /v1/refreshes/candidates): the diagnostic shows it as the former position when the page fell since","type":"object","required":["value","fetched_at","source"],"properties":{"value":{"minimum":1,"maximum":1000,"description":"The position the list showed","type":"number"},"fetched_at":{"format":"date-time","description":"When it was measured, UTC","type":"string"},"source":{"type":"string","enum":["dataforseo_ranked_keywords","dataforseo_serp"]}}}}}}}},"operationId":"postV1Refreshes"},"get":{"tags":["refreshes"],"summary":"List the page updates","parameters":[{"name":"project_id","in":"query","required":false,"schema":{"format":"uuid","type":"string"}},{"name":"skip","in":"query","required":false,"schema":{"minimum":0,"anyOf":[{"format":"numeric","default":0,"type":"string"},{"minimum":0,"type":"number"}]}},{"name":"take","in":"query","required":false,"schema":{"minimum":1,"maximum":50,"anyOf":[{"format":"numeric","default":0,"type":"string"},{"minimum":1,"maximum":50,"type":"number"}]}}],"operationId":"getV1Refreshes"}},"/v1/refreshes/{id}":{"get":{"tags":["refreshes"],"summary":"A page update, its versions and its diagnostic","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"operationId":"getV1RefreshesById"}},"/v1/refreshes/{id}/launch":{"post":{"tags":["refreshes"],"summary":"Launch the update of a diagnosed page (1 credit)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"target_keyword":{"minLength":1,"maxLength":200,"description":"Overrides the keyword of the diagnostic","type":"string"},"republish":{"description":"Republish in place on WordPress or Shopify once the update is done (D15); false delivers a copy to review","type":"boolean"},"allow_builder_republish":{"description":"Republish even a page built with a page builder (D16)","type":"boolean"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","properties":{"target_keyword":{"minLength":1,"maxLength":200,"description":"Overrides the keyword of the diagnostic","type":"string"},"republish":{"description":"Republish in place on WordPress or Shopify once the update is done (D15); false delivers a copy to review","type":"boolean"},"allow_builder_republish":{"description":"Republish even a page built with a page builder (D16)","type":"boolean"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","properties":{"target_keyword":{"minLength":1,"maxLength":200,"description":"Overrides the keyword of the diagnostic","type":"string"},"republish":{"description":"Republish in place on WordPress or Shopify once the update is done (D15); false delivers a copy to review","type":"boolean"},"allow_builder_republish":{"description":"Republish even a page built with a page builder (D16)","type":"boolean"}}}}}},"operationId":"postV1RefreshesByIdLaunch"}},"/v1/refreshes/{id}/changes":{"get":{"tags":["refreshes"],"summary":"The changes, their reasons and checkboxes","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"operationId":"getV1RefreshesByIdChanges"},"patch":{"tags":["refreshes"],"summary":"Accept or refuse changes","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"accept_all":{"description":"true checks every change again (D37)","type":"boolean"},"drop_edit":{"description":"true drops the free retouch: the boxes decide again (D38)","type":"boolean"},"decisions":{"maxItems":200,"type":"array","items":{"additionalProperties":false,"type":"object","required":["id","accepted"],"properties":{"id":{"minLength":1,"maxLength":40,"description":"The id of a change","type":"string"},"accepted":{"type":"boolean"}}}}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","properties":{"accept_all":{"description":"true checks every change again (D37)","type":"boolean"},"drop_edit":{"description":"true drops the free retouch: the boxes decide again (D38)","type":"boolean"},"decisions":{"maxItems":200,"type":"array","items":{"additionalProperties":false,"type":"object","required":["id","accepted"],"properties":{"id":{"minLength":1,"maxLength":40,"description":"The id of a change","type":"string"},"accepted":{"type":"boolean"}}}}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","properties":{"accept_all":{"description":"true checks every change again (D37)","type":"boolean"},"drop_edit":{"description":"true drops the free retouch: the boxes decide again (D38)","type":"boolean"},"decisions":{"maxItems":200,"type":"array","items":{"additionalProperties":false,"type":"object","required":["id","accepted"],"properties":{"id":{"minLength":1,"maxLength":40,"description":"The id of a change","type":"string"},"accepted":{"type":"boolean"}}}}}}}}},"operationId":"patchV1RefreshesByIdChanges"}},"/v1/refreshes/{id}/edit":{"patch":{"tags":["refreshes"],"summary":"Save the retouched page","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["html"],"properties":{"html":{"minLength":1,"maxLength":2000000,"description":"The whole page as the client retouched it (D38)","type":"string"},"scope":{"description":"html is the article only (the blocks of GET changes sewn end to end): it is put back into the page as read","const":"article","type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["html"],"properties":{"html":{"minLength":1,"maxLength":2000000,"description":"The whole page as the client retouched it (D38)","type":"string"},"scope":{"description":"html is the article only (the blocks of GET changes sewn end to end): it is put back into the page as read","const":"article","type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["html"],"properties":{"html":{"minLength":1,"maxLength":2000000,"description":"The whole page as the client retouched it (D38)","type":"string"},"scope":{"description":"html is the article only (the blocks of GET changes sewn end to end): it is put back into the page as read","const":"article","type":"string"}}}}}},"operationId":"patchV1RefreshesByIdEdit"}},"/v1/refreshes/{id}/publish":{"post":{"tags":["refreshes"],"summary":"Republish the reviewed update on the site, backup first (D15)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"force":{"description":"Publish even though the page changed on the site since it was read","type":"boolean"},"allow_builder":{"description":"Republish a page built with a page builder (D16)","type":"boolean"},"auto":{"description":"The end of a run: emits refresh.completed and republishes only when it was asked at launch","type":"boolean"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","properties":{"force":{"description":"Publish even though the page changed on the site since it was read","type":"boolean"},"allow_builder":{"description":"Republish a page built with a page builder (D16)","type":"boolean"},"auto":{"description":"The end of a run: emits refresh.completed and republishes only when it was asked at launch","type":"boolean"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","properties":{"force":{"description":"Publish even though the page changed on the site since it was read","type":"boolean"},"allow_builder":{"description":"Republish a page built with a page builder (D16)","type":"boolean"},"auto":{"description":"The end of a run: emits refresh.completed and republishes only when it was asked at launch","type":"boolean"}}}}}},"operationId":"postV1RefreshesByIdPublish"}},"/v1/refreshes/{id}/live":{"patch":{"tags":["refreshes"],"summary":"The day the reviewed update went live (the copy, or the user’s day)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"live_on":{"maxLength":10,"type":"string"},"copied":{"type":"boolean"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","properties":{"live_on":{"maxLength":10,"type":"string"},"copied":{"type":"boolean"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","properties":{"live_on":{"maxLength":10,"type":"string"},"copied":{"type":"boolean"}}}}}},"operationId":"patchV1RefreshesByIdLive"}},"/v1/refreshes/{id}/restore":{"post":{"tags":["refreshes"],"summary":"Write the backup back on the site (D15)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"force":{"description":"Restore even though the page changed on the site since it was published","type":"boolean"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","properties":{"force":{"description":"Restore even though the page changed on the site since it was published","type":"boolean"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","properties":{"force":{"description":"Restore even though the page changed on the site since it was published","type":"boolean"}}}}}},"operationId":"postV1RefreshesByIdRestore"}},"/v1/feeds/":{"get":{"tags":["feeds"],"summary":"List feeds","parameters":[{"name":"skip","in":"query","required":false,"schema":{"default":0,"anyOf":[{"default":0,"format":"numeric","type":"string"},{"default":0,"type":"number"}]}},{"name":"take","in":"query","required":false,"schema":{"default":9,"maximum":50,"anyOf":[{"default":0,"maximum":50,"format":"numeric","type":"string"},{"default":9,"maximum":50,"type":"number"}]}},{"name":"search","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"status","in":"query","required":false,"schema":{"default":"","type":"string"}},{"name":"project_id","in":"query","required":false,"schema":{"default":"","type":"string"}}],"responses":{"200":{"description":"The list of RSS feed configurations","content":{"application/json":{"schema":{"description":"The list of RSS feed configurations","type":"object","required":["items","count"],"properties":{"items":{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{"id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"},"title":{"type":"string"},"created_at":{"type":"string"},"project_id":{"format":"uuid","type":"string"},"is_active":{"type":"boolean"},"entity_type":{"enum":["articles","discoverarticles"],"type":"string"},"url":{"type":"string"},"frequency":{"type":"string"},"limit":{"type":"number"},"sort_by":{"type":"string"},"filtering_brief":{"type":"string"},"enable_generation":{"type":"boolean"},"last_fetched_at":{"type":"string"},"config":{},"icon":{"type":"string"},"color":{"type":"string"},"error":{"type":"string"}}}},"count":{"default":0,"type":"number"}},"additionalProperties":false}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}},"additionalProperties":false}}}}},"operationId":"getV1Feeds"},"post":{"tags":["feeds"],"summary":"Create a feed","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","required":["url"],"properties":{"title":{"minLength":1,"description":"Title of the feed configuration","type":"string"},"url":{"minLength":1,"description":"URL of the RSS feed to monitor","type":"string"},"project_id":{"format":"uuid","description":"Project ID to associate generated entities with","type":"string"},"filtering_brief":{"description":"Brief describing how to filter RSS items for relevance","type":"string"},"limit":{"minimum":1,"maximum":50,"default":10,"description":"Maximum number of entities to generate per execution","type":"number"},"frequency":{"enum":["5min","30min","1h","3h","6h","12h","24h","48h","72h"],"default":"24h","description":"Frequency to check the RSS feed","type":"string"},"is_active":{"default":true,"description":"Whether the feed is active","type":"boolean"},"sort_by":{"enum":["newest","oldest","most_relevant"],"default":"most_relevant","description":"When limit is applied, how to select the items ? Newest/oldest : select the most recent/old items according to publish date, most relevant : select the best items according to the filtering brief (since last fetch)","type":"string"},"cost":{"type":"number"},"entity_type":{"enum":["articles","discoverarticles"],"default":"articles","description":"Type of entities to generate from RSS items","type":"string"},"enable_generation":{"default":false,"description":"If false, only create the entity brief, do not generate it","type":"boolean"},"config":{"type":"object","properties":{"length":{"default":400,"description":"Length of the discover article in words","anyOf":[{"maximum":2000,"default":400,"description":"Length of the discover article in words","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"type":{"description":"Type of articles to generate","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"additional_information":{"description":"Additional information template","type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"}}}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":true,"type":"object","required":["url"],"properties":{"title":{"minLength":1,"description":"Title of the feed configuration","type":"string"},"url":{"minLength":1,"description":"URL of the RSS feed to monitor","type":"string"},"project_id":{"format":"uuid","description":"Project ID to associate generated entities with","type":"string"},"filtering_brief":{"description":"Brief describing how to filter RSS items for relevance","type":"string"},"limit":{"minimum":1,"maximum":50,"default":10,"description":"Maximum number of entities to generate per execution","type":"number"},"frequency":{"enum":["5min","30min","1h","3h","6h","12h","24h","48h","72h"],"default":"24h","description":"Frequency to check the RSS feed","type":"string"},"is_active":{"default":true,"description":"Whether the feed is active","type":"boolean"},"sort_by":{"enum":["newest","oldest","most_relevant"],"default":"most_relevant","description":"When limit is applied, how to select the items ? Newest/oldest : select the most recent/old items according to publish date, most relevant : select the best items according to the filtering brief (since last fetch)","type":"string"},"cost":{"type":"number"},"entity_type":{"enum":["articles","discoverarticles"],"default":"articles","description":"Type of entities to generate from RSS items","type":"string"},"enable_generation":{"default":false,"description":"If false, only create the entity brief, do not generate it","type":"boolean"},"config":{"type":"object","properties":{"length":{"default":400,"description":"Length of the discover article in words","anyOf":[{"maximum":2000,"default":400,"description":"Length of the discover article in words","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"type":{"description":"Type of articles to generate","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"additional_information":{"description":"Additional information template","type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"}}}}}},"multipart/form-data":{"schema":{"additionalProperties":true,"type":"object","required":["url"],"properties":{"title":{"minLength":1,"description":"Title of the feed configuration","type":"string"},"url":{"minLength":1,"description":"URL of the RSS feed to monitor","type":"string"},"project_id":{"format":"uuid","description":"Project ID to associate generated entities with","type":"string"},"filtering_brief":{"description":"Brief describing how to filter RSS items for relevance","type":"string"},"limit":{"minimum":1,"maximum":50,"default":10,"description":"Maximum number of entities to generate per execution","type":"number"},"frequency":{"enum":["5min","30min","1h","3h","6h","12h","24h","48h","72h"],"default":"24h","description":"Frequency to check the RSS feed","type":"string"},"is_active":{"default":true,"description":"Whether the feed is active","type":"boolean"},"sort_by":{"enum":["newest","oldest","most_relevant"],"default":"most_relevant","description":"When limit is applied, how to select the items ? Newest/oldest : select the most recent/old items according to publish date, most relevant : select the best items according to the filtering brief (since last fetch)","type":"string"},"cost":{"type":"number"},"entity_type":{"enum":["articles","discoverarticles"],"default":"articles","description":"Type of entities to generate from RSS items","type":"string"},"enable_generation":{"default":false,"description":"If false, only create the entity brief, do not generate it","type":"boolean"},"config":{"type":"object","properties":{"length":{"default":400,"description":"Length of the discover article in words","anyOf":[{"maximum":2000,"default":400,"description":"Length of the discover article in words","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"type":{"description":"Type of articles to generate","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"additional_information":{"description":"Additional information template","type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"}}}}}}}},"responses":{"200":{"description":"The id of the created article","content":{"application/json":{"schema":{"description":"The id of the created article","type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"422":{"description":"The URL cannot become a feed as given (it does not exist, or rss.app refused it). Retrying the same URL is pointless: find the real feed or page URL on the site.","content":{"application/json":{"schema":{"description":"The URL cannot become a feed as given (it does not exist, or rss.app refused it). Retrying the same URL is pointless: find the real feed or page URL on the site.","type":"object","required":["error","retryable","message"],"properties":{"error":{"type":"string","enum":["feed_url_not_found","feed_url_rejected"]},"retryable":{"const":false,"type":"boolean"},"message":{"type":"string"}}}}}},"500":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}},"operationId":"postV1Feeds"}},"/v1/feeds/{id}":{"get":{"tags":["feeds"],"summary":"Get a feeds","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The feeds","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{"id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"},"title":{"type":"string"},"created_at":{"type":"string"},"project_id":{"format":"uuid","type":"string"},"is_active":{"type":"boolean"},"entity_type":{"enum":["articles","discoverarticles"],"type":"string"},"url":{"type":"string"},"frequency":{"type":"string"},"limit":{"type":"number"},"sort_by":{"type":"string"},"filtering_brief":{"type":"string"},"enable_generation":{"type":"boolean"},"last_fetched_at":{"type":"string"},"config":{},"icon":{"type":"string"},"color":{"type":"string"},"error":{"type":"string"}},"description":"The feeds"}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}},"additionalProperties":false}}}}},"operationId":"getV1FeedsById"},"patch":{"tags":["feeds"],"summary":"Update a feeds","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{"title":{"minLength":1,"description":"Title of the feed configuration","type":"string"},"url":{"minLength":1,"description":"URL of the RSS feed to monitor","type":"string"},"project_id":{"format":"uuid","description":"Project ID to associate generated entities with","type":"string"},"filtering_brief":{"description":"Brief describing how to filter RSS items for relevance","type":"string"},"limit":{"minimum":1,"maximum":50,"default":10,"description":"Maximum number of entities to generate per execution","type":"number"},"frequency":{"enum":["5min","30min","1h","3h","6h","12h","24h","48h","72h"],"default":"24h","description":"Frequency to check the RSS feed","type":"string"},"is_active":{"default":true,"description":"Whether the feed is active","type":"boolean"},"sort_by":{"enum":["newest","oldest","most_relevant"],"default":"most_relevant","description":"When limit is applied, how to select the items ? Newest/oldest : select the most recent/old items according to publish date, most relevant : select the best items according to the filtering brief (since last fetch)","type":"string"},"cost":{"type":"number"},"entity_type":{"enum":["articles","discoverarticles"],"default":"articles","description":"Type of entities to generate from RSS items","type":"string"},"enable_generation":{"default":false,"description":"If false, only create the entity brief, do not generate it","type":"boolean"},"config":{"type":"object","properties":{"length":{"default":400,"description":"Length of the discover article in words","anyOf":[{"maximum":2000,"default":400,"description":"Length of the discover article in words","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"type":{"description":"Type of articles to generate","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"additional_information":{"description":"Additional information template","type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"}}}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":true,"type":"object","properties":{"title":{"minLength":1,"description":"Title of the feed configuration","type":"string"},"url":{"minLength":1,"description":"URL of the RSS feed to monitor","type":"string"},"project_id":{"format":"uuid","description":"Project ID to associate generated entities with","type":"string"},"filtering_brief":{"description":"Brief describing how to filter RSS items for relevance","type":"string"},"limit":{"minimum":1,"maximum":50,"default":10,"description":"Maximum number of entities to generate per execution","type":"number"},"frequency":{"enum":["5min","30min","1h","3h","6h","12h","24h","48h","72h"],"default":"24h","description":"Frequency to check the RSS feed","type":"string"},"is_active":{"default":true,"description":"Whether the feed is active","type":"boolean"},"sort_by":{"enum":["newest","oldest","most_relevant"],"default":"most_relevant","description":"When limit is applied, how to select the items ? Newest/oldest : select the most recent/old items according to publish date, most relevant : select the best items according to the filtering brief (since last fetch)","type":"string"},"cost":{"type":"number"},"entity_type":{"enum":["articles","discoverarticles"],"default":"articles","description":"Type of entities to generate from RSS items","type":"string"},"enable_generation":{"default":false,"description":"If false, only create the entity brief, do not generate it","type":"boolean"},"config":{"type":"object","properties":{"length":{"default":400,"description":"Length of the discover article in words","anyOf":[{"maximum":2000,"default":400,"description":"Length of the discover article in words","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"type":{"description":"Type of articles to generate","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"additional_information":{"description":"Additional information template","type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"}}}}}},"multipart/form-data":{"schema":{"additionalProperties":true,"type":"object","properties":{"title":{"minLength":1,"description":"Title of the feed configuration","type":"string"},"url":{"minLength":1,"description":"URL of the RSS feed to monitor","type":"string"},"project_id":{"format":"uuid","description":"Project ID to associate generated entities with","type":"string"},"filtering_brief":{"description":"Brief describing how to filter RSS items for relevance","type":"string"},"limit":{"minimum":1,"maximum":50,"default":10,"description":"Maximum number of entities to generate per execution","type":"number"},"frequency":{"enum":["5min","30min","1h","3h","6h","12h","24h","48h","72h"],"default":"24h","description":"Frequency to check the RSS feed","type":"string"},"is_active":{"default":true,"description":"Whether the feed is active","type":"boolean"},"sort_by":{"enum":["newest","oldest","most_relevant"],"default":"most_relevant","description":"When limit is applied, how to select the items ? Newest/oldest : select the most recent/old items according to publish date, most relevant : select the best items according to the filtering brief (since last fetch)","type":"string"},"cost":{"type":"number"},"entity_type":{"enum":["articles","discoverarticles"],"default":"articles","description":"Type of entities to generate from RSS items","type":"string"},"enable_generation":{"default":false,"description":"If false, only create the entity brief, do not generate it","type":"boolean"},"config":{"type":"object","properties":{"length":{"default":400,"description":"Length of the discover article in words","anyOf":[{"maximum":2000,"default":400,"description":"Length of the discover article in words","type":"number"},{"default":"auto","pattern":"auto","type":"string"}]},"type":{"description":"Type of articles to generate","enum":["blog","news","affiliation-product-review","affiliation-compare-products","affiliation-top-product","affiliation-promo-code-product"],"type":"string","default":"blog"},"additional_information":{"description":"Additional information template","type":"string"},"avoid_information":{"type":"string"},"lang":{"description":"Language code (Google `hl` parameter).","enum":["af","sq","sm","ar","az","eu","be","bn","bh","bs","bg","ca","zh-CN","zh-TW","hr","cs","da","nl","en","eo","et","fo","fi","fr","fy","gl","ka","de","el","gu","iw","hi","hu","is","id","ia","ga","it","ja","jw","kn","ko","la","lv","lt","mk","ms","ml","mt","mr","ne","no","nn","oc","fa","pl","pt","pt-BR","pt-PT","pa","ro","ru","gd","sr","si","sk","sl","es","su","sw","sv","tl","ta","te","th","ti","tr","uk","ur","uz","vi","cy","xh","zu"],"type":"string","default":"fr"},"country":{"description":"Country code (Google `gl` parameter).","enum":["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","cd","ck","cr","ci","hr","cu","cy","cz","dk","dj","dm","do","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","va","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kp","kr","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","ws","sm","st","sa","sn","cs","sc","sl","sg","sk","si","sb","so","za","gs","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tl","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","uk","us","um","uy","uz","vu","ve","vn","vg","vi","wf","eh","ye","zm","zw"],"type":"string","default":"fr"},"writing_style_mode":{"description":"If auto, the writing style will be automatically generated after analyzing the website writing style. If persona, you need to set the persona id.","enum":["auto","persona"],"type":"string","default":"auto"},"persona_id":{"type":"string"},"use_cta":{"default":false,"description":"If true, the CTA will be used in the article.","type":"boolean"},"ctas":{"type":"array","items":{"type":"object","properties":{"anchor":{"type":"string"},"url":{"type":"string"}}}},"cta_position":{"description":"Where the CTA link must appear in the article. 'summary' places it inside the 'en bref' summary box at the top (default). 'first_paragraph' places it in the first body paragraph (after the intro), which is the right choice for sponsored / link-sale CTAs.","enum":["summary","first_paragraph"],"type":"string","default":"summary"},"use_boldkeywords":{"default":false,"description":"If true, relevant keywords will be bolded in the article","type":"boolean"},"use_faq":{"default":false,"description":"If true, a FAQ will be appended at the end of the article","type":"boolean"},"faq_questions":{"description":"List of questions to answer in the FAQ. If you leave this field empty, the list of question will be automatically be written after a SEO analysis","type":"string"},"use_toc":{"default":false,"description":"If true, a table of contents will be appended at the top of the article","type":"boolean"},"use_image":{"default":false,"description":"If true, a cover image will be generated","type":"boolean"},"image_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the image. Other ratios are deprecated and will be removed in the future.","type":"string"},"image_prompt":{"description":"The prompt to generate the image. If not provided, the image will be generated base on the article content. WARNING: Don't use 16:9, 4:3, 1:1 ratio for the image prompt, they are deprecated and will be removed in the future.","type":"string"},"image_use_palette":{"description":"If true, the image will be generated using a palette of colors, using image_primary_color and image_secondary_color","type":"boolean"},"image_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the image","type":"string"},"image_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the image","type":"string"},"use_inlineimages":{"default":false,"description":"If true, inline images will be generated in the article, one image per h2 section. Use inlineimages_count to set the number of inline images to generate.","type":"boolean"},"inlineimages_count":{"description":"The number of inline images to generate, between 1 and 10. The option price is calculated based on the number of inline images.","default":1,"type":"number"},"inline_images_ratio":{"enum":["landscape","portrait","16:9","4:3","1:1"],"default":"landscape","description":"Only use landscape or portrait ratio for the inline images. Other ratios are deprecated and will be removed in the future.","type":"string"},"inline_images_use_palette":{"description":"If true, the inline images will be generated using a palette of colors, using inline_images_primary_color and inline_images_secondary_color","type":"boolean"},"inline_images_primary_color":{"description":"The primary color (hex code, for example #ffffff) to use for the inline images","type":"string"},"inline_images_secondary_color":{"description":"The secondary color (hex code, for example #000000) to use for the inline images","type":"string"},"inline_images_style":{"description":"The printed style of the infographics generated by the V3 engine: riso, screenprint, letterpress, linocut, papercut, gouache, mid_century, bauhaus, swiss or neo_brutalism. The inks are always the palette colors (inline_images_primary_color / inline_images_secondary_color); the style only sets the print technique. When absent, screenprint is used. Ignored by the legacy engine.","enum":["riso","screenprint","letterpress","linocut","papercut","gouache","mid_century","bauhaus","swiss","neo_brutalism"],"type":"string"},"use_webhook":{"default":false,"description":"If true, a webhook will be called after the article is generated","type":"boolean"},"webhook_connection_id":{"description":"The connection ID to use for the webhook","type":"string"},"use_internallinks":{"default":false,"type":"boolean"},"use_indexed_pages_internal_links":{"default":false,"type":"boolean"},"use_wp_internal_links":{"default":false,"type":"boolean"},"use_shopify_internal_links":{"default":false,"type":"boolean"},"use_app_internal_links":{"default":false,"type":"boolean"},"use_list_internal_links":{"default":false,"type":"boolean"},"internal_links_wp_status":{"default":["publish"],"description":"The status of the internal links to use for the article, it can be \"draft\", \"publish\" or/and \"future\"","type":"array","items":{"type":"string"}},"internal_links_list":{"description":"List of internal links to use for the article, if use_list_internal_links is true","type":"string"},"internal_links_wp_connection":{"description":"The connection ID to use for the WordPress internal links","type":"string"},"internal_links_shopify_connection":{"description":"The connection ID to use for the Shopify internal links (products, collections and blog articles)","type":"string"},"use_publishwordpress":{"default":false,"description":"If true, the article will be published on WordPress.","type":"boolean"},"publishwordpress_date":{"format":"date-isISO8601","description":"Date when the article will be published, if the publishwordpress_status is \"future\". It should be in ISO 8601 format.","type":"string"},"publishwordpress_status":{"description":"Post status. 'Publish' means it's directly published when the article is generated. 'Future' means it will be published on the publishwordpress_date date.","enum":["draft","publish","future"],"type":"string","default":"draft"},"publishwordpress_category":{"default":-2,"description":"WordPress category ID.You should get it from your WordPress website. You can also set -2 for an automatic category pick and -1 to keep the category unassigned.","type":"number"},"publishwordpress_author":{"description":"WordPress Author ID. You should get it from your WordPress website.","type":"number"},"publishwordpress_connection":{"description":"Connection ID","type":"string"},"use_publishshopify":{"default":false,"description":"If true, the article will be published on Shopify.","type":"boolean"},"publishshopify_connection_id":{"description":"The connection ID to use for the Shopify","type":"string"},"publishshopify_status":{"description":"Storefront visibility of the article. 'publish' makes it visible right away; 'draft' posts it hidden; 'future' schedules it to go live at publishshopify_date.","enum":["draft","publish","future"],"type":"string","default":"publish"},"publishshopify_date":{"description":"Publish date (ISO 8601) when publishshopify_status is 'future'.","type":"string"},"publishshopify_blog":{"description":"Target blog GID (e.g. \"gid://shopify/Blog/123\"). Defaults to the project blog, then to the store default.","type":"string"},"publishshopify_author":{"description":"Author name shown under every article on the store. Defaults to the store's own name when empty.","type":"string"},"publishshopify_blog_handle":{"description":"Target blog handle. Enough on its own — the GID is resolved from it at publish time.","type":"string"},"use_publishprestashop":{"default":false,"description":"If true, the article will be published on Prestashop.","type":"boolean"},"publishprestashop_connection_id":{"description":"The connection ID to use for the Prestashop","type":"string"},"use_publishwoocommerce":{"default":false,"description":"If true, the article will be published on WooCommerce.","type":"boolean"},"publishwoocommerce_connection_id":{"description":"The connection ID to use for the WooCommerce","type":"string"},"use_infotable":{"default":false,"description":"If true, an information table will be inserted inside the article","type":"boolean"},"use_bulletlist":{"default":false,"description":"If true, a bullet list will be inserted inside the article","type":"boolean"},"use_externalsources":{"default":false,"description":"If true, relevant links to external sources (academic, research, governemental, high authority websites, etc.) will be inserted inside the article","type":"boolean"},"use_audio":{"default":false,"description":"If true, an audio sum-up of the article will be generated","type":"boolean"},"audio_voice_id":{"default":"jSrrwmj13CIlQAXPpk4X","description":"The voice to use for the audio version of the article","type":"string"},"use_social":{"default":false,"description":"If true, the article will generate social networks posts.","type":"boolean"},"social_networks":{"default":["instagram","facebook","x","linkedin"],"anyOf":[{"description":"Social networks to use. You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"array","items":{"type":"string"}},{"description":"Social networks to use as a space-separated string. Example: \"instagram facebook x\". You can use \"instagram\", \"facebook\", \"x\" or \"linkedin\".","type":"string"}]},"use_blockquotes":{"default":false,"description":"If true, add between 2 and 5 blockquotes to the article to emphasize important sentences (between 20 and 30 words)","type":"boolean"},"use_summary":{"default":false,"description":"If true, add a summary of the article","type":"boolean"},"information_search_only_from_subject_sources":{"default":false,"description":"If true, only the sources (links) from the subject will be used to search for information","type":"boolean"}}}}}}}},"responses":{"200":{"description":"The updated feeds","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{"id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"},"title":{"type":"string"},"created_at":{"type":"string"},"project_id":{"format":"uuid","type":"string"},"is_active":{"type":"boolean"},"entity_type":{"enum":["articles","discoverarticles"],"type":"string"},"url":{"type":"string"},"frequency":{"type":"string"},"limit":{"type":"number"},"sort_by":{"type":"string"},"filtering_brief":{"type":"string"},"enable_generation":{"type":"boolean"},"last_fetched_at":{"type":"string"},"config":{},"icon":{"type":"string"},"color":{"type":"string"},"error":{"type":"string"}},"description":"The updated feeds"}}}},"422":{"description":"The URL cannot become a feed as given (it does not exist, or rss.app refused it). Retrying the same URL is pointless: find the real feed or page URL on the site.","content":{"application/json":{"schema":{"description":"The URL cannot become a feed as given (it does not exist, or rss.app refused it). Retrying the same URL is pointless: find the real feed or page URL on the site.","type":"object","required":["error","retryable","message"],"properties":{"error":{"type":"string","enum":["feed_url_not_found","feed_url_rejected"]},"retryable":{"const":false,"type":"boolean"},"message":{"type":"string"}}}}}}},"operationId":"patchV1FeedsById"},"delete":{"tags":["feeds"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"operationId":"deleteV1FeedsById"}},"/v1/transactions/":{"get":{"tags":["transactions"],"summary":"List transactions","description":"Most recent first. Each line carries the project of its entity (project_id null when outside any project).","parameters":[{"name":"start_date","in":"query","required":false,"schema":{"description":"ISO 8601 format","type":"string"}},{"name":"end_date","in":"query","required":false,"schema":{"description":"ISO 8601 format","type":"string"}},{"name":"skip","in":"query","required":false,"schema":{"default":0,"type":"number"}},{"name":"take","in":"query","required":false,"schema":{"default":9,"maximum":50,"type":"number"}},{"name":"reason","in":"query","required":false,"schema":{"description":"Filter by reason(s). Can be a single value or multiple values separated by commas (e.g., \"payment,task_run\")","type":"string"}},{"name":"debits_only","in":"query","required":false,"schema":{"description":"Filter to show only debit transactions (negative credits)","type":"boolean"}},{"name":"project_id","in":"query","required":false,"schema":{"description":"Filter on one project, or \"none\" for the lines outside any project","anyOf":[{"format":"uuid","type":"string"},{"const":"none","type":"string"}]}},{"name":"kind","in":"query","required":false,"schema":{"type":"string","enum":["all","debits","credits"]}}],"responses":{"200":{"description":"The list of transactions","content":{"application/json":{"schema":{"description":"The list of transactions","type":"object","required":["items","count"],"properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"format":"uuid","type":"string"},"credits":{"description":"Can be positive or negative (payment, task_run, feed_item_brief are negative, refund_after_error is positive, other can be positive or negative)","type":"number"},"created_at":{"type":"string"},"reason":{"enum":["payment","task_run","feed_item_brief","refund_after_error","regenerate_image","regenerate_video","refund_regenerate_image","refund_regenerate_video","other"],"description":"Payment : user buy credits, task_run : user run an article, feed_item_brief : an article brief is generated from a feed item, refund_after_error : user get a refund after an article generation error, regenerate_image / regenerate_video : user regenerated one media of an already-generated article, refund_regenerate_image / refund_regenerate_video : that regeneration failed and was refunded, other : other reason","type":"string"},"entity_id":{"description":"The id of the entity (article/content) this credit consumption is associated with, when applicable","type":"string"},"entity_title":{"description":"The title of the associated entity, when available","type":"string"},"entity_collection":{"description":"The collection (entity type) of the associated entity, used to build a link to the content","type":"string"},"project_id":{"description":"The project of the associated entity; null when the line is outside any project (no entity, entity without a project, or entity no longer readable)","format":"uuid","type":["string","null"]},"project_name":{"description":"The title of that project, when readable","type":["string","null"]},"project_deleted":{"description":"True when that project was deleted or is no longer readable","type":"boolean"}}}},"count":{"default":0,"type":"number"}}}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}},"operationId":"getV1Transactions"}},"/v1/transactions/by-project":{"get":{"tags":["transactions"],"summary":"Get debits by project","description":"Debits of the period totalled by project (null = outside any project), each split by reason","parameters":[{"name":"start_date","in":"query","required":false,"schema":{"description":"ISO 8601 format","type":"string"}},{"name":"end_date","in":"query","required":false,"schema":{"description":"ISO 8601 format","type":"string"}}],"responses":{"200":{"description":"Debits of the period, by project then by reason","content":{"application/json":{"schema":{"description":"Debits of the period, by project then by reason","type":"object","required":["total","projects"],"properties":{"total":{"description":"Sum of the debits of the period (negative), equal to the sum of the project totals","type":"number"},"projects":{"description":"One entry per project, biggest spender first","type":"array","items":{"type":"object","required":["project_id","project_name","project_deleted","total","by_reason"],"properties":{"project_id":{"description":"null groups the debits outside any project","format":"uuid","type":["string","null"]},"project_name":{"type":["string","null"]},"project_deleted":{"type":"boolean"},"total":{"description":"Debits of this project (negative)","type":"number"},"by_reason":{"description":"The project total, split by reason","type":"array","items":{"type":"object","required":["name","value"],"properties":{"name":{"description":"Reason type","type":"string"},"value":{"description":"Debits for this reason","type":"number"}}}}}}}}}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}},"operationId":"getV1TransactionsBy-project"}},"/v1/transactions/daily":{"get":{"tags":["transactions"],"summary":"Get daily summary of transactions","description":"Returns a summary of transactions grouped by day with breakdown by reason type","parameters":[{"name":"start_date","in":"query","required":false,"schema":{"description":"ISO 8601 format","type":"string"}},{"name":"end_date","in":"query","required":false,"schema":{"description":"ISO 8601 format","type":"string"}},{"name":"reason","in":"query","required":false,"schema":{"description":"Filter by reason(s). Can be a single value or multiple values separated by commas (e.g., \"payment,task_run\")","type":"string"}},{"name":"debits_only","in":"query","required":false,"schema":{"description":"Filter to show only debit transactions (negative credits)","type":"boolean"}},{"name":"project_id","in":"query","required":false,"schema":{"description":"Filter on one project, or \"none\" for the lines outside any project","anyOf":[{"format":"uuid","type":"string"},{"const":"none","type":"string"}]}},{"name":"kind","in":"query","required":false,"schema":{"type":"string","enum":["all","debits","credits"]}},{"name":"timezone","in":"query","required":false,"schema":{"description":"IANA time zone of the days (e.g. \"Europe/Paris\"); UTC when absent or unknown","type":"string"}}],"responses":{"200":{"description":"Daily summary of transactions grouped by day and reason","content":{"application/json":{"schema":{"description":"Daily summary of transactions grouped by day and reason","type":"array","items":{"type":"object","required":["date","by_reason","total"],"properties":{"date":{"description":"Date in YYYY-MM-DD format","type":"string"},"by_reason":{"description":"Credits grouped by reason","type":"array","items":{"type":"object","required":["name","value"],"properties":{"name":{"description":"Reason type","type":"string"},"value":{"description":"Credits for this reason","type":"number"}}}},"total":{"description":"Total credits for the day","type":"number"}}}}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}},"operationId":"getV1TransactionsDaily"}},"/v1/transactions/export":{"get":{"tags":["transactions"],"summary":"Export transactions as CSV","description":"The lines of the list with the same filters, most recent first, as a CSV for a spreadsheet (UTF-8 BOM, \";\" separator, decimal comma). A period over 25 000 lines is refused (period_too_large).","parameters":[{"name":"start_date","in":"query","required":false,"schema":{"description":"ISO 8601 format","type":"string"}},{"name":"end_date","in":"query","required":false,"schema":{"description":"ISO 8601 format","type":"string"}},{"name":"reason","in":"query","required":false,"schema":{"description":"Filter by reason(s). Can be a single value or multiple values separated by commas (e.g., \"payment,task_run\")","type":"string"}},{"name":"debits_only","in":"query","required":false,"schema":{"description":"Filter to show only debit transactions (negative credits)","type":"boolean"}},{"name":"project_id","in":"query","required":false,"schema":{"description":"Filter on one project, or \"none\" for the lines outside any project","anyOf":[{"format":"uuid","type":"string"},{"const":"none","type":"string"}]}},{"name":"kind","in":"query","required":false,"schema":{"type":"string","enum":["all","debits","credits"]}},{"name":"timezone","in":"query","required":false,"schema":{"description":"IANA time zone of the dates in the file (e.g. \"Europe/Paris\"); UTC when absent or unknown","type":"string"}}],"responses":{"200":{"description":"CSV: Date;Motif;Crédits;Contenu;Projet","content":{"text/plain":{"schema":{"description":"CSV: Date;Motif;Crédits;Contenu;Projet","type":"string"}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}},"operationId":"getV1TransactionsExport"}},"/v1/transactions/balance":{"get":{"tags":["transactions"],"summary":"Get the balance day by day","description":"The balance of the whole account at the end of each day of the period (any project, any kind), rebuilt backwards from the wallet. A period over 25 000 lines is refused (period_too_large); the movements after it are summed without cap.","parameters":[{"name":"start_date","in":"query","required":false,"schema":{"description":"ISO 8601 format","type":"string"}},{"name":"end_date","in":"query","required":false,"schema":{"description":"ISO 8601 format","type":"string"}},{"name":"timezone","in":"query","required":false,"schema":{"description":"IANA time zone of the days (e.g. \"Europe/Paris\"); UTC when absent or unknown","type":"string"}}],"responses":{"200":{"description":"The balance of the account, day by day","content":{"application/json":{"schema":{"description":"The balance of the account, day by day","type":"object","required":["current","start","points","gap"],"properties":{"current":{"description":"The wallet as it stands","type":"number"},"start":{"description":"Balance just before the first day of the period","type":"number"},"points":{"description":"One point per day of the period, up to today","type":"array","items":{"type":"object","required":["date","balance"],"properties":{"date":{"description":"Date in YYYY-MM-DD format","type":"string"},"balance":{"description":"Balance at the end of the day","type":"number"}}}},"gap":{"description":"How far the rebuilt balance goes below zero (0 when the history explains the wallet)","type":"number"}}}}}},"400":{"description":"The error message","content":{"application/json":{"schema":{"description":"The error message","type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}},"operationId":"getV1TransactionsBalance"}},"/v1/jobs/{name}":{"post":{"tags":["jobs"],"summary":"Trigger a job","description":"Creates a job entry in the database and triggers it asynchronously via Trigger.dev","parameters":[{"name":"name","in":"path","required":true,"schema":{"description":"The job name (e.g., generate-image)","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"payload":{"description":"The job payload data","type":"object","patternProperties":{"^(.*)$":{}}},"parameters":{"description":"The job parameters data","type":"object","patternProperties":{"^(.*)$":{}}}},"additionalProperties":false}},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"payload":{"description":"The job payload data","type":"object","patternProperties":{"^(.*)$":{}}},"parameters":{"description":"The job parameters data","type":"object","patternProperties":{"^(.*)$":{}}}},"additionalProperties":false}},"multipart/form-data":{"schema":{"type":"object","properties":{"payload":{"description":"The job payload data","type":"object","patternProperties":{"^(.*)$":{}}},"parameters":{"description":"The job parameters data","type":"object","patternProperties":{"^(.*)$":{}}}},"additionalProperties":false}}}},"responses":{"200":{"description":"Job created and queued successfully","content":{"application/json":{"schema":{"description":"Job created and queued successfully","type":"object","required":["id","name","status"],"properties":{"id":{"description":"The job ID","type":"string"},"name":{"description":"The job name","type":"string"},"status":{"description":"The job status","type":"string"},"step":{"description":"The job step","type":"string"}},"additionalProperties":false}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Bad request","type":"object","required":["error"],"properties":{"error":{"type":"string"}},"additionalProperties":false}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"description":"Internal server error","type":"object","required":["error"],"properties":{"error":{"type":"string"}},"additionalProperties":false}}}}},"operationId":"postV1JobsByName"}},"/v1/jobs/{id}":{"get":{"tags":["jobs"],"summary":"Get job status","description":"Returns the current status and result of a job","parameters":[{"name":"id","in":"path","required":true,"schema":{"description":"The job ID","type":"string"}}],"responses":{"200":{"description":"Job status","content":{"application/json":{"schema":{"description":"Job status","type":"object","required":["id","name","status","result","error","created_at","completed_at"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"},"step":{"type":"string"},"logs":{"type":"string"},"result":{},"error":{},"created_at":{"type":"string"},"completed_at":{"type":["string","null"]}},"additionalProperties":false}}}},"404":{"description":"Job not found","content":{"application/json":{"schema":{"description":"Job not found","type":"object","required":["error"],"properties":{"error":{"type":"string"}},"additionalProperties":false}}}}},"operationId":"getV1JobsById"}}},"components":{"schemas":{}}}