Docs

Connect your AI to Amaware.

Claude, ChatGPT, Claude Code and Cursor can read what AI says about you, pick what to publish and write it. Connecting takes about two minutes.

MCP is the plug that connects your Claude or ChatGPT to your Amaware workspace. This page shows you how to connect, what each of the 42 tools does, what costs credits and where the limits are.

Connect

Connect in about two minutes.

Three ways in. Pick the one that matches where you work.

Claude.ai and ChatGPT

You sign in to Amaware once, pick the workspace, and it is connected.

  1. 1Open the connector settings in Claude or ChatGPT and add a custom connector.
  2. 2Paste the connector URL.
  3. 3Sign in when asked, pick the workspace, and press Allow.
  4. 4Ask it to plan your week.
Connector URL
https://platform.amaware.ai/api/mcp

It reads your workspace and adds what you approve. It asks before it deletes anything, marks a page as published, or spends credits you didn't ask for.

Claude Code, Claude Desktop, Cursor and OpenClaw

You make a key on the MCP page and paste one block of config.

  1. 1In Amaware, open MCP in the sidebar, pick your AI and press Create my key. The key lands inside the block for you.
  2. 2Paste the block into your client’s MCP config, with your key in place of the placeholder.
  3. 3Restart the client. The Amaware tools show up in its list.
MCP config
{
  "mcpServers": {
    "amaware": {
      "type": "http",
      "url": "https://platform.amaware.ai/api/mcp",
      "headers": { "Authorization": "Bearer <your key>" }
    }
  }
}
Claude Code, one line instead
claude mcp add --transport http amaware https://platform.amaware.ai/api/mcp --header "Authorization: Bearer <your key>"

Scripts and your own code

The REST API is on the Growth plan. It uses the same key and the same tools.

  1. 1In Amaware, open Settings, then API, and press Create my key.
  2. 2Send it as a bearer token to the base URL.
  3. 3Point a client generator at the OpenAPI file: platform.amaware.ai/openapi.json.
Base URL
https://platform.amaware.ai/api/v1
First call
curl https://platform.amaware.ai/api/v1/capabilities \
  -H "Authorization: Bearer <your key>"

Workflows

Four things to ask for.

A workflow is a saved set of steps your AI follows in order. Ask for one by name, or describe what you want and it picks the right one. Each one tells your AI to say the cost and wait for a yes before it spends credits.

Plan my week

plan_my_week

Read where the brand stands, find the biggest gaps, and pick the three things to publish this week.

Write and publish an action

write_and_publish

Take one item on the ranked list from brief to live page: write the piece exactly from the brief, publish it with your own connected tools, save the draft, mark it published.

Takesaction_id (required) The action to do (from list_actions).

Grow the prompt list

grow_the_list

Get suggestions the brand can actually get named for and add the ones the person keeps, under the plan limit.

Takescount (optional) How many suggestions to ask for (5 to 50). Default 10.

Competitor check

competitor_check

See what a competitor wins that the brand does not, and turn it into prompts to track.

Takescompetitor (optional) A competitor domain like competitor.com. Defaults to the tracked one with the highest share of voice.

Tools

Every tool, in seven groups.

42 tools in all. Reading is free, and so is adding, editing and changing a status. Suggestions, briefs, live runs and research cost credits, and each card says how many. Your AI reads the same list, so it knows what it can do and what each call costs.

Read

The workspace

get_workspace
Free

The brand, its plan and limits, how many prompts are tracked and how much room is left, which engines run, the time zone, the last run and the credit balance. Call this first.

Readsthe workspace, brand, engines and counts
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

None. Call it with an empty object.

Returns

  • workspace (slug, timezone, onboarded)
  • brand (name, domain, aliases, owned_domains, market, answer_for)
  • plan (id, label, subscription_status, limits)
  • prompts (active, paused, room_left)
  • competitors
  • engines[] (id, label, enabled, capture)
  • last_run_at
  • credits (left, allowance, resets_at)

Visibility counts

get_visibility
Free

How often the brand is named, cited and named first across the answers in a window, with share of voice against the tracked competitors. With include_trend, the daily line and engine health too.

Readsthe workspace's stored answers; the tracked competitors
PlansEvery paid plan and the trial
Since18 September 2026

Inputs

NameTypeRequiredWhat it is
windownumberNoDays: 7, 28 or 90. Default 28.
include_trendtrue or falseNoAdd the daily trend and engine health.

Returns

  • window
  • named
  • cited
  • named_first (count, total, ratio, delta_vs_prior)
  • share_of_voice[] (brand, you, answers, share)
  • trend[]
  • engine_health[]
  • computed_at

The tracked prompts

list_prompts
Free

Every prompt on the list with its latest result per engine (named, cited, missed, position), the 28-day spark, asks a month on Pro and up, and how many open actions it feeds. Filter by active, stage, engine or a search word.

Readsthe workspace's prompts and latest answers
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
windownumberNoDays: 7, 28 or 90. Default 28.
activetrue or falseNo
stagechoiceNoOne of problem, solution, comparison, alternatives, use-case.
enginetextNoAn engine id from get_workspace.
searchtextNo
limitnumber, 1 to 400NoRows to return, up to 400.
offsetnumber, 0 or moreNo

Returns

  • prompts[] (id, text, stage, active, asks_a_month, open_actions, named_on, of_engines, latest{engine: result, position, run_date}, spark_28d[])
  • total
  • engines[]
  • computed_at

One prompt in full

get_prompt
Free

One prompt with the latest answer per engine: whether the brand was named, its position, every brand the answer named, the sources it cited with their channel, what the engine searched for, and an excerpt of the answer. Plus the 28-day history per engine.

Readsone prompt and its answers
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
prompt_ididYes
windownumberNoDays: 7, 28 or 90. Default 28.

Returns

  • prompt (id, text, stage, active, source, asks_a_month, seed, why_suggested)
  • open_actions
  • latest_answers[] (engine, run_date, named, cited, position, named_brands[], sources[] (url, title, domain, channel), searched_for[], answer_excerpt)
  • history_28d{engine: [day, mark]}
  • computed_at

Prompts the brand misses

list_gaps
Free

Prompts where at least one engine did not name the brand in its latest answer, with who was named instead. The shortest route to what to fix.

Readsthe workspace's prompts and latest answers
PlansEvery paid plan and the trial
Since18 September 2026

Inputs

NameTypeRequiredWhat it is
enginetextNoOne engine id to filter by.
limitnumber, 1 to 200NoRows to return, up to 200.

Returns

  • gaps[] (prompt_id, prompt, stage, missed_on[], named_instead[])
  • total
  • as_of
  • computed_at

Where the engines look

list_sources
Free

The domains and pages the engines cite on your prompts, classified by channel (owned, competitor, listicle, review site, community, video, editorial), and which of your own pages get cited, with the 28-day movement.

Readsthe workspace's stored answers and their citations
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
windownumberNoDays: 7, 28 or 90. Default 28.
limitnumber, 1 to 60NoRows to return, up to 60.

Returns

  • where_engines_look (domains[], pages[], channels[], answers_with_sources)
  • what_of_yours_is_cited (pages[], cited_answers, cited_answers_prior, named_without_a_link, unattributed)
  • window
  • computed_at

The tracked competitors

list_competitors
Free

Every competitor with its domain, aliases, chart colour and share of voice in the window, next to yours.

Readsthe tracked competitors; the workspace's stored answers
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
windownumberNoDays: 7, 28 or 90. Default 28.

Returns

  • you (name, domain, answers_named, share)
  • competitors[] (id, name, domain, aliases, color, series, answers_named, share)
  • limit
  • computed_at

The ranked list

list_actions
Free

What to publish next, highest leverage first: each row says what to make (a page, a video, a reply, an email), where it goes, why the engines will pick it up and how many prompts it covers. Defaults to open items; pass a status for completed or skipped ones.

Readsthe workspace's ranked list
PlansEvery paid plan and the trial
Since18 September 2026

Inputs

NameTypeRequiredWhat it is
statuschoiceNoOne of new, in_progress, completed, skipped.
limitnumber, 1 to 100NoRows to return, up to 100.

Returns

  • actions[] (id, type, format, channel, title, leverage, status, why, prompts_affected, has_brief, published_url, first_cited_at)
  • computed_at

One action in full

get_action
Free

One item on the list with everything behind it: the prompts it covers, the engines that miss, the pages cited instead, the competitors involved, the leverage factors, and whether a brief, a draft or a published URL exists.

Readsone action and its evidence
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
action_ididYes

Returns

  • action (id, type, format, channel, title, status, leverage, leverage_factors, target)
  • evidence (line, prompts[], engines[], source_urls[], competitors[])
  • brief (generated_at, edited_at, has_brief)
  • draft (saved_at, saved_by, url, has_draft)
  • published (url, at, first_cited_at, indexing: google and bing, each with state, reason, due_at, sent_at, indexed_at)

What agents did here

get_agent_activity
Free

The last calls made on this workspace through any key or connection: the tool, when, whether it worked, and the credits it used. Read it before repeating work another agent already did.

Readsthe workspace's agent call log
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
limitnumber, 1 to 200NoRows to return, up to 200.

Returns

  • calls[] (tool, source, ok, code, ms, credits, client, created_at)
  • computed_at

What you can do here

list_capabilities
Free

This manifest: every tool, what it reads and writes, its inputs, its credits and whether it is available on the caller's plan and balance, plus what an agent cannot do here and why.

ReadsNothing of yours
PlansEvery plan
Since20 September 2026

Inputs

None. Call it with an empty object.

Returns

  • capabilities[]
  • excluded[] (action, why)
  • plan
  • credits_left

Prompts

Add prompts

add_prompts
Free

Adds prompts to the list and starts tracking them on the next run. Dedupes against what is already tracked and stops at the plan's prompt limit with the exact line the app shows, so a 50-prompt plan never gets a 51st.

Readsthe workspace's prompts; the plan limit
Writesthe workspace's prompt list
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
promptslist of objects, up to 50YesEach has text (required) and stage.

Returns

  • added[] (id, text)
  • skipped (already tracked)
  • room_left

Edit a prompt

edit_prompt
Free

Changes a prompt's text or stage. The old row is paused and linked so its history stays on the chart; the new one runs on the next scoped run.

Readsone prompt
Writesthe workspace's prompt list
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
prompt_ididYes
texttextNo
stagechoiceNoOne of problem, solution, comparison, alternatives, use-case.

Returns

  • prompt (id, text, stage)
  • replaced
  • changed

Pause or resume a prompt

set_prompt_active
Free

Pauses a prompt (it keeps its history and stops counting against the plan) or tracks it again.

Readsone prompt
Writesthe prompt's active flag
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
prompt_ididYes
activetrue or falseYes

Returns

  • prompt (id, text, active)

Delete a prompt

delete_prompt
FreeDestructive: ask first

Removes a prompt for good. Pass a reason (not our buyer, wrong product, too broad, wrong competitor, we already rank) and the next suggestions steer away from it. Ask the person before calling this.

Readsone prompt
Writesthe workspace's prompt list; the Train your AI feedback
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
prompt_ididYes
reasonchoiceNoOne of not_our_buyer, wrong_product, too_broad, wrong_competitor, already_rank.
notetextNo

Returns

  • deleted (id, text)
  • reason

Run a prompt now

run_prompt
5 credits

Runs one prompt on the workspace's engines right now and returns whether the brand was named and cited and the sources each answer used. Pass a prompt id, or text to add and run a new prompt (the plan's limit applies).

Readsthe workspace's prompts and engines
Writesa new prompt when text is given; today's answers for it
PlansEvery paid plan and the trial
Since20 September 2026

Twenty manual runs a day per workspace.

Inputs

NameTypeRequiredWhat it is
prompt_ididNo
texttextNo

Returns

  • prompt (id, text)
  • answers[] (engine, named, cited, position, sources[])
  • pending
  • credits_spent
  • credits_left

Suggest prompts

suggest_prompts
4 credits a prompt

Prompts the brand can get named for, built from its site, the market's measured demand and what competitors already win, each with a reason sentence. Nothing is added; pass the ones the person keeps to add_prompts.

Readsthe workspace brand, competitors and prompts; public search demand
PlansEvery paid plan and the trial
Since20 September 2026

Charged per prompt returned; the shortfall is refunded.

Inputs

NameTypeRequiredWhat it is
countnumber, 1 to 50NoHow many, up to 50. Default 10.
contexttextNoCustomer language, call notes, anything that sharpens the read.

Returns

  • prompts[] (text, stage, play, seed, google_volume, ai_volume, difficulty, score, reason)
  • credits_spent
  • credits_left

Competitors

Add a competitor

add_competitor
Free

Tracks a competitor by name and domain, with optional aliases and a chart colour. Takes the lowest free chart slot; twelve is the cap.

Readsthe tracked competitors
Writesthe competitor list
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
nametextYes
domaintextYesA bare domain like competitor.com.
aliaseslist of text, up to 8No
colortext, or nullNoA hex colour like #1D4ED8.

Returns

  • competitor (id, name, domain, aliases, color, series)
  • tracked
  • limit

Update a competitor

update_competitor
Free

Changes a competitor's name, domain, aliases or chart colour. Pass color null to go back to the series colour.

Readsone competitor
Writesthe competitor list
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
competitor_ididYes
nametextNo
domaintextNoA bare domain like competitor.com.
aliaseslist of text, up to 8No
colortext, or nullNoA hex colour like #1D4ED8.

Returns

  • competitor (id, name, domain, aliases, color, series)
  • changed

Remove a competitor

remove_competitor
FreeDestructive: ask first

Stops tracking a competitor. Its past mentions stay in the stored answers. Ask the person before calling this.

Readsone competitor
Writesthe competitor list
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
competitor_ididYes

Returns

  • removed (id, name, domain)
  • tracked

Brand and engines

Update the brand

update_brand
Free

Changes the brand's name, the aliases the engines might use for it, the domains you own (the main domain always stays), the voice rules briefs follow, the five phrases you want to be the answer for, and the market.

Readsthe brand
Writesthe brand
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
nametextNo
aliaseslist of text, up to 12No
owned_domainslist of text, up to 8NoA bare domain like competitor.com.
voice_rulestext, or nullNo
answer_forlist of text, up to 5No
marketchoiceNoOne of US, UK, CA, AU, IE, NZ, DE, FR, NL, ES.

Returns

  • brand (name, domain, aliases, owned_domains, voice_rules, answer_for, market)
  • changed

The brand voice

get_voice
Free

The voice every brief is written in: the one-line pitch, tone words, first person, sentence length, words to use and avoid, sample lines from the site, the two asks and the disclosure line for replies.

Readsthe brand voice
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

None. Call it with an empty object.

Returns

  • voice (oneLiner, tone[], person, sentenceLength, useWords[], avoidWords[], sampleLines[], directAsk, transitionalAsk, disclosure)
  • generated
  • generated_at
  • voice_rules

Edit the brand voice

update_voice
Free

Changes any of the voice fields. Send only the fields to change; the rest stay. Every brief from then on uses the new voice.

Readsthe brand voice
Writesthe brand voice
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
oneLinertextNo
tonelist of text, up to 3No
personchoiceNoOne of we, I.
sentenceLengthchoiceNoOne of short, mixed.
useWordslist of text, up to 12No
avoidWordslist of text, up to 12No
sampleLineslist of text, up to 3No
directAsktextNo
transitionalAsktextNo
disclosuretextNo

Returns

  • voice
  • changed

Read the voice from the site again

refresh_voice
Free

Reads the brand's site again and rewrites the voice fields from it. Three reads a day; free of credits.

Readsthe brand's site
Writesthe brand voice
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

None. Call it with an empty object.

Returns

  • voice
  • generated_at

Choose the engines

set_engines
Free

Sets which engines run daily. Every paid plan runs three of the five; pass the full list you want on.

Readsthe workspace's engines
Writesthe workspace's engine settings
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
enabledlist of text, up to 5YesEngine ids from get_workspace.

Returns

  • enabled[] (id, label)
  • limit

Actions, briefs and drafts

Refresh the ranked list

refresh_actions
Free

Recomputes the ranked list from the stored answers (the Refresh button). Free; refuses while a run is still going.

Readsthe workspace's stored answers
Writesthe ranked list
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

None. Call it with an empty object.

Returns

  • inserted
  • updated
  • note

Set an action's status

set_action_status
Free

Moves an item to new, in progress, completed or skipped (with a reason: not relevant, already exists, no capacity).

Readsone action
Writesthe action's status
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
action_ididYes
statuschoiceYesOne of new, in_progress, completed, skipped.
skip_reasonchoiceNoOne of not_relevant, already_exists, no_capacity.

Returns

  • action (id, title, status, skip_reason)

Mark an action published

mark_published
Free

Records that the page for an action is live at a URL. Amaware widens your owned domains for a new subdomain, queues the affected prompts, and watches the daily answers for the first citation. With Google Search Console or Bing Webmaster Tools connected, the page is sent to them two hours later and checked daily until it is indexed. Ask the person before calling it.

Readsone action
Writesthe action's status and published URL; owned domains when the URL is a new subdomain
PlansEvery paid plan and the trial
Since18 September 2026

Inputs

NameTypeRequiredWhat it is
action_ididYes
urlURLYes

Returns

  • action (id, title, status, published_url, published_at)
  • prompts_queued
  • note

The brief for an action

get_brief
25 credits

The finished kit for one action: the exact title tag, meta description, URL, headings, FAQ and schema for a page; the script, title, description and chapters for a video; the reply and disclosure for a thread; the email for a list owner or a writer. Returned as Markdown and as fields, in the brand's own voice. The first request starts writing it (about a minute) and returns status "writing" with retry_in seconds; call again after that and the kit comes back, cached from then on. Write the piece from it exactly, then ask the person to publish and call mark_published.

Readsone action and its evidence; the brand voice
Writesthe cached brief on the action
PlansEvery paid plan and the trial
Since18 September 2026

Credits are charged on the first generation only; reading a cached brief is free. While status is "writing", wait retry_in seconds and call again.

Inputs

NameTypeRequiredWhat it is
action_ididYes

Returns

  • status ("writing") and retry_in while it is being written, else:
  • action (id, title, type, format, channel, leverage, status)
  • evidence
  • brief_markdown
  • kit
  • how_to_use
  • brief_generated_at
  • brief_edited_at
  • has_draft

Write the brief again

write_brief
25 credits

Throws the cached brief away and starts a fresh one, charged like a first brief. Returns status "writing" with retry_in; call get_brief after that many seconds for the new kit. Use it when the evidence changed or the person asked for a different angle.

Readsone action and its evidence; the brand voice
Writesthe cached brief on the action
PlansEvery paid plan and the trial
Since20 September 2026

Two briefs a day for one action.

Inputs

NameTypeRequiredWhat it is
action_ididYes

Returns

  • status ("writing")
  • retry_in
  • rewritten

Edit the brief

update_brief
Free

Edits an existing brief: send kit fields to merge over the stored kit (the Markdown is re-rendered), or brief_markdown to replace the text as is. Use it after the person asks for a different title, angle or FAQ.

Readsone action and its brief
Writesthe brief on the action
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
action_ididYes
kitobjectNoKit fields to merge, in the shape get_brief returns under kit.
brief_markdowntextNo

Returns

  • action (id, title)
  • edited_at
  • kit
  • brief_markdown
  • note

Save the written piece

save_draft
Free

Stores the article, post, script, reply or email you wrote from the brief on the action, with the URL once it is live, so the person sees it in the app and other agents do not write it twice. Publishing stays with your own connected tools.

Readsone action
Writesthe draft on the action
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
action_ididYes
draft_markdowntextYes
urlURLNo

Returns

  • action (id, title)
  • saved_at
  • characters
  • note

Read the saved piece

get_draft
Free

The draft saved on an action, who saved it and when, and its URL if it was published.

Readsone action
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
action_ididYes

Returns

  • action (id, title)
  • draft_markdown
  • saved_at
  • saved_by
  • url

Credits

Credit balance

get_credits
Free

What is left in the workspace's credit pool, the allowance, the reset date, what used credits this period, the last twenty ledger rows and the packs on sale.

Readsthe workspace's credit ledger
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

None. Call it with an empty object.

Returns

  • left
  • allowance
  • resets_at
  • used_by_action{}
  • recent[]
  • packs[]

Buy credits

buy_credits
Free

A Stripe Checkout link for a top-up pack (small, medium or large). Nothing is charged until the person finishes paying; the credits land the moment they do and never expire. Give the link to the person; never pretend the purchase happened.

Readsthe workspace's billing customer
Writesa pending Checkout session
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
packchoiceYessmall (2,000), medium (5,000) or large (15,000).

Returns

  • checkout_url
  • pack
  • credits
  • usd
  • expires_in_hours
  • note

Research

Search volume

search_volume
2 credits a phrase, 10 at least

How many people search each phrase a month on Google and ask it of AI assistants, with difficulty, intent and a twelve-month trend.

Readspublic search demand
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
phraseslist of text, up to 100Yes
marketchoiceNoMarket to measure in. Defaults to the workspace market (US).

Returns

  • rows[] (phrase, google_volume, ai_volume, difficulty, intent, trend[])
  • credits_spent
  • credits_left

Discover phrases

discover_phrases
40 credits

The phrases buyers in a category actually search, grown from a few seeds, each with volume, AI volume, difficulty and intent.

Readspublic search demand
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
seedslist of text, up to 20Yes
limitnumber, 1 to 200NoRows to return, up to 200.
marketchoiceNoMarket to measure in. Defaults to the workspace market (US).

Returns

  • rows[] (phrase, google_volume, ai_volume, difficulty, intent)
  • credits_spent
  • credits_left

Competitor keywords

competitor_keywords
40 credits

The phrases a domain ranks for on Google, with its position, the ranking page and the demand behind each.

Readspublic rankings for the domain
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
domaintextYesA bare domain like competitor.com.
limitnumber, 1 to 200NoRows to return, up to 200.
marketchoiceNoMarket to measure in. Defaults to the workspace market (US).

Returns

  • domain
  • rows[] (phrase, position, url, google_volume, ai_volume, difficulty, intent)
  • credits_spent
  • credits_left

Keyword gap

keyword_gap
50 credits

The phrases a competitor ranks for and your brand does not, with their position and the demand.

Readspublic rankings for both domains; the workspace brand domain
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
competitortextYesA bare domain like competitor.com.
limitnumber, 1 to 200NoRows to return, up to 200.
marketchoiceNoMarket to measure in. Defaults to the workspace market (US).

Returns

  • competitor
  • you
  • rows[] (phrase, position, url, google_volume, ai_volume, difficulty, intent)
  • credits_spent
  • credits_left

AI Overview citations

aio_citations
40 credits

The phrases where Google's AI Overview cites a page on a domain, with the cited page. Defaults to your brand.

Readspublic AI Overview citations; the workspace brand domain
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
domaintextNoA bare domain like competitor.com.
limitnumber, 1 to 200NoRows to return, up to 200.
marketchoiceNoMarket to measure in. Defaults to the workspace market (US).

Returns

  • domain
  • rows[] (phrase, url, google_volume, ai_volume)
  • credits_spent
  • credits_left

Who AI mentions

ai_mentions
100 credits

The domains and brands that AI answers mention for a topic or a brand, with how often, from a large sample of real prompts on ChatGPT and Google's AI Overview.

Readspublic AI answer samples
PlansEvery paid plan and the trial
Since20 September 2026

Samples cover ChatGPT and Google AI Overview, US and English.

Inputs

NameTypeRequiredWhat it is
topictextNo
brandtextNo
platformchoiceNoOne of google, chatgpt.
limitnumber, 1 to 100NoRows to return, up to 100.

Returns

  • query
  • platform
  • domains[] (name, mentions, ai_volume)
  • brands[] (name, mentions, ai_volume)
  • credits_spent
  • credits_left

Prompts naming a brand

ai_answers
100 credits

The real prompts whose AI answers name a brand, each with the sources the answer cited. Sources and counts only, never the answer text.

Readspublic AI answer samples
PlansEvery paid plan and the trial
Since20 September 2026

Inputs

NameTypeRequiredWhat it is
brandtextYes
platformchoiceNoOne of google, chatgpt.
limitnumber, 1 to 50NoRows to return, up to 50.

Returns

  • brand
  • platform
  • rows[] (prompt, platform, ai_volume, sources[] (url, domain, title))
  • credits_spent
  • credits_left

Credits

What costs credits, and what never does.

Daily tracking never costs credits. The tools that ask an engine or the market for something new do. One credit is about one cent. Every plan comes with a monthly allowance, and you can top up when a big week needs more.

Your allowance

It resets on your billing date.

PlanCredits
Starter5,000
Pro15,000
Growth35,000
Free trial (7 days)1,500

Top-up packs

Buy one from Settings, or ask your AI to call buy_credits. Packs never expire.

PackPrice
2,000 credits$25
5,000 credits$55
15,000 credits$150

What each tool costs

What each priced tool costs. A tool that returns fewer rows than it charged for gives the difference back.

CreditsWhat you get
4 credits a prompt
one suggested prompt
suggest_prompts
100 credits
a fresh read of your market
In the app
25 credits
one brief
get_brief, write_brief
5 credits
one prompt run now on your engines
run_prompt
2 credits a phrase, 10 at least
search volume, per phrase
search_volume
40 credits
up to 200 phrases in a category
discover_phrases
40 credits
up to 200 phrases a competitor ranks for
competitor_keywords
50 credits
up to 200 phrases they rank for and you do not
keyword_gap
40 credits
up to 200 phrases where Google's AI cites a site
aio_citations
100 credits
who AI answers mention for a topic or brand
ai_mentions
100 credits
the prompts and sources naming a brand
ai_answers

Rollover

Unused credits carry into the next month, up to twice your allowance in total. Purchased packs sit outside that cap and never expire.

Never costs credits

  • Daily tracking on your engines
  • Every read tool, from the workspace to the ranked list
  • Adding, editing, pausing and deleting prompts
  • Competitor, brand and engine changes
  • Action statuses and refreshing the ranked list
  • Saving and reading drafts
  • Reading a brief that already exists

Limits

The limits.

Past a limit the call gets a 429 and a line that says when to try again. A refused call costs nothing. The daily ones count every key and connection on the workspace together.
LimitWhat it covers
120 calls a minuteMCP, for one key or connection.
60 calls a minuteAPI, for one key.
300 research calls a dayThe research tools, for one workspace.
500 changes a dayEverything agents add, edit or delete on one workspace.
20 manual runs a dayrun_prompt, for one workspace. The daily run is separate and never counts.
2 briefs a dayFor one action, counting get_brief on first generation and write_brief.
30 daysHow long a Claude.ai or ChatGPT connection’s token lives. It refreshes on its own. You sign in again only if you revoke it.

API

The API.

The API is on the Growth plan. One bearer key, three routes, JSON in and out. Call it from a server. There are no CORS headers, on purpose, so a key never sits in a web page. The machine-readable version is the OpenAPI 3.1 file at platform.amaware.ai/openapi.json.

Routes

Base URL https://platform.amaware.ai/api/v1

MethodPathWhat it does
GET/capabilitiesEvery tool your plan and balance can call right now, with its inputs and credits.
GET/creditsYour balance, the allowance, the reset date, what used credits this period and the packs on sale.
POST/tools/{key}Run one tool. The body is the tool’s inputs as a JSON object. An empty body is fine for a tool with none.

One call

Request
curl -X POST https://platform.amaware.ai/api/v1/tools/list_gaps \
  -H "Authorization: Bearer <your key>" \
  -H "Content-Type: application/json" \
  -d '{ "limit": 20 }'
Answers
{ "ok": true, "gaps": [ ... ], "total": 14, "as_of": "2026-09-20", "computed_at": "..." }

{ "ok": false, "error": "credits", "message": "..." }

Status codes

Every failure is a JSON object with ok: false, a short error code and a message you can show a person.

CodeWhen
200It worked. The body carries ok: true and the tool’s fields.
400The input did not match the tool. The message names the field.
401No key, or a key that is not live any more.
402Not enough credits. Buy a pack or wait for the reset.
403The API is on the Growth plan. The MCP works on every plan.
404No tool with that name. GET /capabilities lists them.
409Refused as asked. The plan is full, a run is still going, or the item cannot take that change yet.
429Over a limit. The message says which one and when to try again.
503An engine or a data source did not answer. Nothing was charged. Try again in a minute.
500Something on our side. We have been told. Try again in a minute.

Start showing up in AI search results.

About ten minutes to set up. Today you see what AI says about you. This week you get your first easy steps.

Free for 7 days with a card on file.