Get image settings
Returns the project's image settings: the style added to every image prompt, whether the logo and the character are used, their reference images, and the brand notes. Read them before writing image prompts so your scenes fit the style and the brand notes.
Returns the project's image settings: the style added to every image prompt, whether the logo and the character are used, their reference images, and the brand notes. Read them before writing image prompts so your scenes fit the style and the brand notes.
Authorization
ApiKeyAuth ArticlesQ API key sent as Authorization: Bearer aq_live_.... Each key is scoped to a single project.
In: header
Response Body
application/json
application/json
application/json
import ArticlesQ from "@articlesq/sdk";const articlesq = new ArticlesQ({ apiKey: process.env.ARTICLESQ_API_KEY });// See SDK docs: https://articlesq.com/docs/sdk{
"imageSettings": {
"imageStyle": "editorial-photo",
"imageStyleDescription": "string",
"stylePresets": [
{
"id": "editorial-photo",
"label": "Editorial photo",
"description": "Editorial photography style — clean, realistic, sharp focus, natural lighting, magazine-quality composition."
}
],
"logoEnabled": true,
"logoImageUrl": "string",
"characterEnabled": true,
"characterImageUrl": "string",
"instructions": "The character always wears the black hoodie with the logo on the chest."
}
}{
"error": {
"title": "Unauthorized",
"status": 401,
"code": "missing_auth",
"message": "Missing Authorization header",
"instance": "/api/v1/articles"
}
}{
"error": {
"title": "Forbidden",
"status": 403,
"code": "insufficient_scope",
"message": "Missing required scope: images:read",
"instance": "/api/v1/image-settings"
}
}Update an article PATCH
Update editable fields on an article — currently `content` and `metaDescription`. Send only the fields you want to change. Returns the full updated article.
Update image settings PATCH
Update the project's image style, turn the logo or the character on or off, or edit the brand notes. Send only the fields you want to change. Returns the full image settings.