Onboard Brand
onboard_brandCreate or onboard a brand from user-selected website, Instagram, or file sources. This starts asynchronous Brand Skill creation in the selected workspace and stores supplied files in private brand storage. If a website or Instagram source matches an existing brand, the tool returns that match instead unless the user explicitly allows a duplicate. Returns the new Brand session ID and brand URL with status analyzing, or the matching brands with status duplicate.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"sources": "<sources>"
},
"name": "onboard_brand"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sources | Yes | Required ordered Brand evidence: up to one website, one Instagram account, and files. File sources accept either a public HTTPS URL or a completed temporary upload ID. | |
| llm_model | No | The model identifier you are running as, for example "claude-opus-4-8" or "gpt-5.2". Omit it or pass "unknown" if you are not certain; the tool runs the same either way. Recorded only for the server developer's analytics. | |
| instructions | No | Guidance for how the Brand Agent should interpret the supplied evidence during this creation run. | |
| workspace_id | No | Workspace ID. Omit (or pass null) to default to the caller's personal workspace. | |
| allow_duplicate | No | Allow creation when a website or Instagram source matches an existing brand in the selected workspace. Set to true only after explicit user intent to create another brand. Defaults to false. | |
| idempotency_key | No | Retry key for recovering the original Brand creation after an uncertain response. Reuse it with the same request; choose a new key when intentionally creating another Brand. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | analyzing when creation started. duplicate when an existing brand matched and no brand was created. | |
| matches | No | Existing brands that matched. Present when status is duplicate. | |
| brand_url | No | Link to the new brand. Present when status is analyzing. | |
| brand_session_id | No | Brand session ID of the new brand. Present when status is analyzing. | |
| message_for_assistant | No | Context, explanations, or actionable guidance for the calling assistant. Hosts may display it, but it is not copy that must be shown to the user verbatim. |