Set and manage business goals
Read, create, generate, edit, and delete the brand's strategic business goals.
Business goals are the strategic objectives a brand is pursuing — they give content work its "why." Reach for these tools when you need to understand what a brand is trying to accomplish, or to curate its goal list before generating content or recommendations.
When to use
Read goals before writing content so each piece maps to a real objective. Create or generate goals when a brand's priorities aren't yet captured. Goals are informed by AI visibility scan data plus the brand's own priorities.
Typical sequence
get_goals— see the existing list (and avoid duplicates).create_goal(you write the title + description) orgenerate_goal_from_prompt(an LLM drafts it from a freeform prompt).update_goalto refine,delete_goalto remove.
Tools
get_goals
Get the brand's business goals — strategic objectives informed by AI visibility scan data and the brand's own priorities.
Authentication: Required.
| Parameter | Type | Required | Description |
|---|---|---|---|
syntheticId | integer | Yes | The agent ID to get goals for. |
Returns goalCount plus a goals[] array; each goal has an id, a title (a concrete objective in plain language), and a description (why it matters and how content / AI visibility helps achieve it).
create_goal
Add a business goal you've already worded yourself. Synchronous — no LLM call, no credit cost. Call get_goals first to avoid duplicates.
Authentication: Required.
| Parameter | Type | Required | Description |
|---|---|---|---|
syntheticId | integer | Yes | The agent to add the goal to. |
title | string | Yes | Short goal title (e.g. "Grow organic signups"). |
description | string | Yes | What the goal means and why it matters — a sentence or two. |
Returns the created goal with its new id. Edit or remove it later with update_goal / delete_goal.
generate_goal_from_prompt
Draft and save a business goal from a freeform description. An LLM turns your prompt into a structured title + description, grounded in the brand's company profile and voice, then persists it. The goal is created immediately — this is not a suggestion you confirm later; adjust it afterward with update_goal / delete_goal.
Authentication: Paid — requires a Starter or Pro plan (runs an LLM generation).
| Parameter | Type | Required | Description |
|---|---|---|---|
syntheticId | integer | Yes | The agent to generate and save a goal for. |
userPrompt | string | Yes | What the goal should be about, in your own words. |
Returns the generated goal with its new id. To add a goal you've already worded yourself with no plan requirement, use create_goal.
update_goal
Edit an existing goal's title and/or description. Pass goalId plus whichever fields to change — at least one is required. Synchronous, no LLM call, no credit cost. Use get_goals to find the goalId.
Authentication: Required. The goal must belong to one of your agents.
| Parameter | Type | Required | Description |
|---|---|---|---|
goalId | integer | Yes | The goal to edit (from get_goals). |
title | string | No | New goal title (omit to keep current). |
description | string | No | New goal description (omit to keep current). |
Returns the updated goal.
delete_goal
Permanently remove a goal. Destructive and irreversible — anyone with access to the agent, including shared team members, can delete one. Synchronous, no LLM call. Use get_goals to find the goalId.
Authentication: Required.
| Parameter | Type | Required | Description |
|---|---|---|---|
goalId | integer | Yes | The goal to delete (from get_goals). |
Returns deletedGoalId on success.