Settings
Change the image source mode or the cover settings
Saves the image source mode (image_mode) and the article cover settings
(covers: enabled, default_preset) like the Sorank settings pages;
omitted cover fields keep their value. A gallery mode (gallery_then_ai,
products_gallery_then_ai, gallery_only) needs a valid subscription
(subscription_required) and activates the staged gallery uploads; the
analysis of the gallery images is queued, declared as
image_gallery_analysis_queued in effects. On a deployment where the
image gallery is disabled, image_mode is not_found. A custom cover
preset must belong to this site; another site’s preset is not_found.
PATCH
/
profiles
/
{profile_id}
/
settings
/
visuals
Error
A valid request URL is required to generate request examples{
"data": {
"settings": {
"site": {
"website_url": "<string>",
"business_name": "<string>",
"brand_color": "<string>",
"market": {
"language": "<string>",
"country": "<string>",
"scope": "city",
"city": "<string>"
}
},
"business_brief": {
"status": "pending",
"revision": 1,
"document": {
"schema_version": 123,
"sections": [
{
"id": "identity",
"text": "<string>"
}
],
"offers": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>"
}
]
}
},
"competitors": {
"domains": [
"<string>"
],
"max_selections": 1
},
"articles": {
"calendar_exists": true,
"timezone": "<string>",
"local_time": "<string>",
"publish_as_draft": true,
"default_instructions": "<string>",
"expert_settings": {
"tone": "<string>",
"formality": "<string>",
"generate_images": true,
"image_source_mode": "ai_only",
"image_tone": "<string>",
"image_style": "<string>",
"ethnicity": "<string>",
"image_instructions": "<string>",
"conclusion_enabled": true,
"cta_enabled": true,
"cta_title": "<string>",
"include_homepage_screenshot": true,
"include_youtube_videos": true
}
},
"visuals": {
"image_mode": "ai_only",
"covers": {
"enabled": true,
"default_preset": {
"kind": "builtin",
"key": "sketch",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
},
"youtube": {
"connected": true,
"channel_title": "<string>",
"canonical_url": "<string>",
"enabled": true,
"sync_status": "syncing",
"last_synced_at": "2023-11-07T05:31:56Z",
"video_count": 1
}
},
"effects": [
"geo_questions_regeneration_queued"
],
"receipt": {
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "accepted",
"resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"meta": {
"request_id": "<string>",
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "insufficient_quota",
"message": "The current article generation quota is exhausted.",
"request_id": "33333333-3333-4333-8333-333333333333",
"retryable": false
}
}{
"error": {
"code": "insufficient_quota",
"message": "The current article generation quota is exhausted.",
"request_id": "33333333-3333-4333-8333-333333333333",
"retryable": false
}
}Authorizations
OAuth2PersonalAPIKey
Authorization-code grant with PKCE S256, exact scopes, explicit resource audience and a persisted consent grant. Obtain endpoint URLs from server discovery in the target environment. Refresh tokens remain client-bound.
FlowAuthorization Code
- Authorization URL
- /oauth/authorize
- Token URL
- /oauth/token
- Refresh URL
- /oauth/token
Scopes1
settings:write
Change site, business, competitor, article, visual and YouTube settings. Some changes queue asynchronous regeneration or synchronization.
Headers
Opaque client command key of 1 to 128 visible ASCII characters. UUID recommended; reuse only for the same command.
Required string length:
1 - 128Pattern:
^[!-~]+$Path Parameters
Profile UUID; must be in the grant allowlist and currently accessible to the actor.
Body
application/json
⌘I
Error
A valid request URL is required to generate request examples{
"data": {
"settings": {
"site": {
"website_url": "<string>",
"business_name": "<string>",
"brand_color": "<string>",
"market": {
"language": "<string>",
"country": "<string>",
"scope": "city",
"city": "<string>"
}
},
"business_brief": {
"status": "pending",
"revision": 1,
"document": {
"schema_version": 123,
"sections": [
{
"id": "identity",
"text": "<string>"
}
],
"offers": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>"
}
]
}
},
"competitors": {
"domains": [
"<string>"
],
"max_selections": 1
},
"articles": {
"calendar_exists": true,
"timezone": "<string>",
"local_time": "<string>",
"publish_as_draft": true,
"default_instructions": "<string>",
"expert_settings": {
"tone": "<string>",
"formality": "<string>",
"generate_images": true,
"image_source_mode": "ai_only",
"image_tone": "<string>",
"image_style": "<string>",
"ethnicity": "<string>",
"image_instructions": "<string>",
"conclusion_enabled": true,
"cta_enabled": true,
"cta_title": "<string>",
"include_homepage_screenshot": true,
"include_youtube_videos": true
}
},
"visuals": {
"image_mode": "ai_only",
"covers": {
"enabled": true,
"default_preset": {
"kind": "builtin",
"key": "sketch",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
},
"youtube": {
"connected": true,
"channel_title": "<string>",
"canonical_url": "<string>",
"enabled": true,
"sync_status": "syncing",
"last_synced_at": "2023-11-07T05:31:56Z",
"video_count": 1
}
},
"effects": [
"geo_questions_regeneration_queued"
],
"receipt": {
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "accepted",
"resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"meta": {
"request_id": "<string>",
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "insufficient_quota",
"message": "The current article generation quota is exhausted.",
"request_id": "33333333-3333-4333-8333-333333333333",
"retryable": false
}
}{
"error": {
"code": "insufficient_quota",
"message": "The current article generation quota is exhausted.",
"request_id": "33333333-3333-4333-8333-333333333333",
"retryable": false
}
}