Settings
Get the site settings
Aggregates the settings the Sorank application reads for the same user
(owner or active agency collaborator): the read-only website URL,
business name, brand color and market; the editable business brief
document with its revision (send it as expected_revision when
replacing the document) and generation status; the selected competitor
domains; the calendar article defaults (local_time in HH:MM, only
when a calendar exists); the image source mode and cover settings; and
the connected YouTube channel. Never starts an analysis, a sync or a
generation and consumes no quota.
GET
/
profiles
/
{profile_id}
/
settings
Error
A valid request URL is required to generate request examples{
"data": {
"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
}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pagination": {
"limit": 50,
"has_more": true,
"next_cursor": "<string>"
},
"catalog": {
"available_count": 1,
"enriched_count": 1,
"truncated": true
}
}
}{
"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:read
Read site, article, visual and YouTube settings.
Path Parameters
Profile UUID; must be in the grant allowlist and currently accessible to the actor.
⌘I
Error
A valid request URL is required to generate request examples{
"data": {
"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
}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pagination": {
"limit": 50,
"has_more": true,
"next_cursor": "<string>"
},
"catalog": {
"available_count": 1,
"enriched_count": 1,
"truncated": true
}
}
}{
"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
}
}