Get workspace brand terms
The tool returns the brand terms a workspace uses to match queries and AI answers. brandTerms is the list that is actually used: the workspace title plus the confirmed aliases. analyze_branded_vs_nonbranded and find_low_hanging_keywords use that list. aliases is the editable set behind it. Each alias is tagged derived if workspace analysis proposed it and someone confirmed it, or user if someone typed it. candidates are proposals still waiting for confirmation. They are not matched until set_workspace_brand_terms promotes them. Pass a workspaceId from list_workspaces or list_sites. A domain is not a workspace id.
get_workspace_brand_termsThe tool returns the brand terms a workspace uses to match queries and AI answers.
brandTerms is the list that is actually used: the workspace title plus the confirmed aliases. analyze_branded_vs_nonbranded and find_low_hanging_keywords use that list. aliases is the editable set behind it. Each alias is tagged derived if workspace analysis proposed it and someone confirmed it, or user if someone typed it. candidates are proposals still waiting for confirmation. They are not matched until set_workspace_brand_terms promotes them.
Pass a workspaceId from list_workspaces or list_sites. A domain is not a workspace id.
Parameters
| Parameter | Type | Required | Notes |
|---|---|---|---|
workspaceId | string (uuid) | Yes | — |
Full input JSON SchemaTypes, defaults and validation rules
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "workspaceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "workspaceId" ]}Response
Full output JSON SchemaEvery field the response can contain
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "workspaceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "title": { "type": "string" }, "brandTerms": { "type": "array", "items": { "type": "string" } }, "aliases": { "type": "array", "items": { "type": "object", "properties": { "alias": { "type": "string" }, "origin": { "type": "string" } }, "required": [ "alias", "origin" ], "additionalProperties": {} } }, "candidates": { "type": "array", "items": { "type": "string" } }, "rejected": { "type": "array", "items": { "type": "object", "properties": { "alias": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "alias", "reason" ], "additionalProperties": {} } } }, "required": [ "workspaceId", "title", "brandTerms", "aliases", "candidates", "rejected" ], "additionalProperties": false}