---
title: "Annotation"
description: "one thing a person states about a subject of the record, from any face: the capture panel while a page is captured, the web shell or the desktop shell on an entity's page, the agent in a conversation, or the API."
section: concepts
address: /concepts/annotation
contract: 0476e35e6e275db5
---

# Annotation

one thing a person states about a subject of the record, from any face: the capture panel while a page is captured, the web shell or the desktop shell on an entity's page, the agent in a conversation, or the API.

[figure: Annotation is a value at none scope. The drawing shows its fields and the objects that they point at.]

| property | value |
|---|---|
| kind | value |
| scope | none |
| key | none |
| store | none |
| family | sources |



## Fields


| field | type | required | note |
|---|---|---|---|
| `target` | `one of the page \| an item \| a contact \| a region \| an entity` | yes | an entity when the annotation is made on an entity's page or by the agent, with the entity in subject |
| `subject` | `id` | no | the entity the annotation is about when the target is an entity; absent on a page, whose subject the capture supplies |
| `said_in` | `one of the capture panel \| the web shell \| the desktop shell \| the agent \| the API` | no | the face the person said it in; absent means the capture panel |
| `item_field` | `text` | no | the list field the item belongs to |
| `item_key` | `text` | no | the item's own id, or its index |
| `contact` | `text` | no | the contact's namespace and normalised value, joined by a bar |
| `region_selector` | `text` | no | a selector path to the picked element |
| `region_text` | `text` | no | the picked element's visible text |
| `kind` | `one of a tag \| a relation \| a note \| a rival \| a fit \| a membership \| a kind of thing` | yes | a rival marks the subject as competing with one of the tenant's brands; a fit states it fits a kind of buyer; a membership places it in a facet, a vertical, a segment or a community; a kind of thing says what the subject is |
| `register` | `text` | no | the place of the record the unit was found in (kinds of buyer, brands, offerings, facets, verticals, concepts, segments, communities, entities) |
| `value` | `text` | yes | the tag's name, the relation's kind of connection or the person's own words for it, the note, or the kind of entity |
| `entity` | `id` | no | the unit of the record it points at; absent for a thing the record does not hold yet |
| `entity_name` | `text` | no | the unit's name, or the name of a new thing |
| `entity_kind` | `text` | no | the unit's kind, or the kind of entity the person set for a new thing |
| `role` | `text` | no | for a relation: the role the page's subject takes |
| `stated_at` | `time` | yes |  |



## Routes that use it
- [`/v1/act/annotate`](/reference/act/annotate) takes it as input