# Workspace

> Orient a session. Who am I, which projects exist, create one.

Source: https://docs.indexzero.site/tools/workspace



These three tools are free and are where every session starts.

## `whoami` [#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.

## `list_projects` [#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_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.`