Workspace
Orient a session. Who am I, what the plans include, which projects exist, create one.
These tools are free and are where every session starts.
whoami
Identity and credit balance for the connected workspace. Call it first when you need to know whether the workspace can afford a batch of research, or which plan's limits apply.
Arguments: none.
Returns: the workspace, the plan, creditsRemaining, monthlyCredits, topupCredits, and periodEnd (when the monthly allowance resets). The text lane reminds the agent that 1,000 credits is roughly $1 of provider spend. _meta deep-links to the billing page.
get_product_info
Facts about IndexZero itself: each plan's price, monthly credits, and limits; which plan unlocks each gated feature; top-up packs; which tools are free and which spend credits; and the free web tools. The sheet is generated from the same plan catalog and tool registry the product runs on, so an agent that calls it answers pricing and limits questions from the current numbers rather than from memory. SAM uses the same tool.
| Argument | Type | Required | Default | Meaning |
|---|---|---|---|---|
topic | plans, credits, tools, or free_tools | no | every topic | Limit the sheet to one section. |
Returns: the sheet as markdown in the text lane, and the same facts as structured data.
list_projects
The workspace's active projects. Every other tool needs a projectId from here.
Arguments: none.
Returns: one row per project with projectId, name, domain, location, language, and whether it is the default. Archived projects are not listed. Ordered newest first.
create_project
Create a project. Free, but subject to the plan's limit on active projects; the call fails with an upgrade message if that limit is reached.
| Argument | Type | Required | Default | Meaning |
|---|---|---|---|---|
name | string, 1 to 80 chars | yes | Display name. | |
domain | string, up to 255 chars | no | none | Bare domain the project tracks. Required before audits, rank tracking, or own-site backlink tools will work. A URL is accepted and reduced to its hostname. |
locationCode | integer | no | 2840 (United States) | Default location for research. |
languageCode | string, 2 to 10 chars | no | "en" | Default language for research. |
Returns: the new project's id and settings. An invalid domain fails with "<value>" is not a valid domain.