Update image settings

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.

PATCH
/image-settings

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.

Authorization

ApiKeyAuth
AuthorizationBearer <token>

ArticlesQ API key sent as Authorization: Bearer aq_live_.... Each key is scoped to a single project.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

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",
    "details": {
      "property1": {},
      "property2": {}
    }
  }
}

{
  "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:write",
    "instance": "/api/v1/image-settings"
  }
}