# Keyword

URL: /business/nouns/keyword · Id: `noun:keyword`

> A Keyword is a search phrase or AI prompt that Pages target, with its rank and citations observed over time.

A Keyword is a search phrase or AI prompt that [Pages](/business/nouns/page) target, with its rank and citations observed over time.

## Properties
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `phrase` | `string` | Yes | The words searched or asked. |
| `form` | `string` | No | One of `search` or `question`. |

## Object
```json
{
  "$id": "https://api.sb/routewise.dev/keywords/keyword_1",
  "$type": "Keyword",
  "phrase": "Example phrase",
  "form": "search"
}
```

## Relationships
- <a id="rel-targeted-by"></a>A Keyword **is targeted by** many [Pages](/business/nouns/page): a [Page](/business/nouns/page) is written to rank for, or be cited on, its Keywords. `targetedBy`, inverse [`targets`](/business/nouns/page#rel-targets).

## Verbs
| Verb | Description | Subject | Event | Class |
| --- | --- | --- | --- | --- |
| [Keyword.measure](/business/nouns/keyword/measure) | Measure records a Keyword’s monthly search volume, difficulty, cost per click and trend in one locale. | [Analyst](/agents/marketing/analyst) | [`Keyword.measured`](/business/events/Keyword.measured) | Two-way: `try`, `send`, `do` |
| <a id="create"></a>[Keyword.create](/business/nouns/keyword/create) | Creates a Keyword. Inherited from [Noun](/business/nouns/noun). | None. | `Keyword.created` | Two-way: `try`, `send`, `do` |
| <a id="get"></a>[Keyword.get](/business/nouns/keyword/get) | Returns one Keyword by id. Inherited from [Noun](/business/nouns/noun). | None. | None. | Read: `try`, `do` |
| <a id="list"></a>[Keyword.list](/business/nouns/keyword/list) | Returns Keywords, newest first, one page at a time. Inherited from [Noun](/business/nouns/noun). | None. | None. | Read: `try`, `do` |
| <a id="update"></a>[Keyword.update](/business/nouns/keyword/update) | Changes the given properties of a Keyword. Inherited from [Noun](/business/nouns/noun). | None. | `Keyword.updated` | Two-way: `try`, `send`, `do` |
| <a id="delete"></a>[Keyword.delete](/business/nouns/keyword/delete) | Deletes a Keyword; its history is kept. Inherited from [Noun](/business/nouns/noun). | None. | `Keyword.deleted` | One-way: `send`, `do` |

## Permissions
Which Access level may call each Verb. One-way Verbs wait their delay window.

| Operation | `owner` | `admin` | `member` | `viewer` |
| --- | --- | --- | --- | --- |
| `Keyword.create` | Yes | Yes | Yes | No |
| `Keyword.get` | Yes | Yes | Yes | Yes |
| `Keyword.list` | Yes | Yes | Yes | Yes |
| `Keyword.update` | Yes | Yes | Yes | No |
| `Keyword.delete` | Yes | Yes | Yes | No |
| `Keyword.measure` | Yes | Yes | Yes | No |

## Call it

**Ask**

```text
Measure the latest keyword.
```

**API**

```bash
curl -X POST https://api.sb/ledgerlark.com/keywords/keyword_1/measure \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/ledgerlark.com",
  "keyword": {
    "$id": "https://api.sb/ledgerlark.com/keywords/keyword_1",
    "$type": "Keyword",
    "phrase": "Example phrase"
  },
  "action": {
    "$id": "https://api.sb/ledgerlark.com/actions/action_1",
    "operation": "Keyword.measure",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/ledgerlark.com/actions/action_1"
  }
}
```

**SDK**

```ts
import { $ } from 'startup-builder'

const keyword = await $.Keyword.measure({ keyword: 'keyword_1' })
```

**CLI**

```bash
npx startup-builder do Keyword.measure --json '{"keyword":"keyword_1"}'
```

**MCP**

```json
{
  "name": "do",
  "arguments": {
    "code": "return await $.Keyword.measure({ keyword: 'keyword_1' })"
  }
}
```

## Example
The Keyword "home inspector near me" is targeted by the city [Pages](/business/nouns/page) of an inspector directory. Its largest city Page ranks third and is cited in one AI answer this week.