---
# @generated by sylphx-gen 0.1.0 from contracts@fb95f0c42a0ec5d8e3cb694c0054b529c0b24b184112c65ef60c9044b4ce61f9. Do not edit.
title: "Recall an entity"
description: "`knowledge.entities.recall` (POST /v1/{parent}/entities:recall): Searches the graph (`recall`): hybrid lexical and semantic search over episodes and facts, fused by reciprocal rank, then at most two hops of expansion from the top entities."
type: reference
product: knowledge
summary: "Searches the graph (`recall`): hybrid lexical and semantic search over episodes and facts, fused by reciprocal rank, then at most two hops…"
updated: 2026-09-28
nav: false
---

Searches the graph (`recall`): hybrid lexical and semantic search over episodes and facts, fused by reciprocal rank, then at most two hops of expansion from the top entities. Returns a context pack with citations, built only from records the caller may see.

**Not available yet.** Sylphx Knowledge is declared in the registry but no backend serves it: every call answers `501` with the problem code `UNIMPLEMENTED`.

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/entities:recall`
- **Scope** `knowledge:read`
- **Effect** `read` — nothing is written.
- **Collection** [entities](/docs/api/entities)

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `parent` | `string` | The environment whose graph to search. Required. |
| `query` | `string` | What to recall, in natural language; 1 to 4000 characters. Required. |
| `spaces` | `string[]` | The spaces to search, as resource names; default every space the caller may read. At most 50. |
| `entity_types` | `string[]` | Only entities of these types; default every type. |
| `valid_time` | `timestamp` | Recall the graph as it was valid at this time; default now. |
| `max_hops` | `int32` | How many hops to expand from the top entities, 0 to 2; default 2. |
| `max_facts` | `int32` | At most this many facts in the pack; default 30, clamped to 200. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `context` | `ContextPack` | The context pack. |

### ContextPack

| Field | Type | What it is |
| --- | --- | --- |
| `entities` | `Entity[]` | The entities, most relevant first. |
| `facts` | `Relation[]` | The facts, most relevant first, with their valid and recorded time. |
| `citations` | `Citation[]` | The episodes the facts and entities come from. |

### Entity

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/entities/{entity}`. |
| `uid` | `string` | `ken_<26 base32>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `entity_type` | `string` | The type: a core type (`person`, `organisation`, `customer`, `contact`, `product`, `project`, `document`, `decision`, `playbook`, `case`, `topic`) or a type of an accepted Knowledge Schema, `<schema>.<type>`. Required. |
| `title` | `string` | The name people use for it. Required. |
| `aliases` | `string[]` | Other names it is known by; at most 50. |
| `properties` | `struct` | Properties, valid against the type's JSON Schema. |
| `external_ids` | `ExternalId[]` | Identifiers in other systems. Two writes with the same external id in one graph are the same entity (deterministic resolution). At most 50. |
| `space` | `string` | The space the entity was first stated in. Required. |
| `provenance` | `Provenance` | Where it came from and who wrote it. Output only. |
| `lifecycle` | `EntityLifecycle` | Whether the entity stands on its own or was merged into another. Output only. One of `active`, `merged`. |
| `survivor` | `string` | The entity this one was merged into, while `lifecycle` is `ENTITY_LIFECYCLE_MERGED`. Output only. |
| `merged_entities` | `string[]` | The entities merged into this one; each can be split back out. Output only. |
| `create_time` | `timestamp` | When the entity was first recorded. Output only. |
| `update_time` | `timestamp` | When the entity last changed. Output only. |

### Relation

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/spaces/{space}/relations/{relation}`. |
| `uid` | `string` | `krel_<26 base32>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `subject` | `string` | The entity the fact is about. Required. |
| `predicate` | `string` | The relation type, snake_case, for example `works_at` or `prefers`; a core predicate or one of an accepted Knowledge Schema. Required. |
| `object` | `string` | The other entity, for an edge. A fact has `object`, `value`, or both. |
| `value` | `value` | The value, for a fact about one entity. |
| `statement` | `string` | The fact as one sentence, used for search and shown with citations. |
| `valid_start_time` | `timestamp` | When the fact starts to hold in the world; default when it was recorded. |
| `valid_end_time` | `timestamp` | When the fact stopped holding in the world; unset while it holds. |
| `episodes` | `string[]` | The episodes the fact comes from. A structured write with none records its own episode and cites it; an extracted fact cites the episodes it was read from. |
| `provenance` | `Provenance` | Where it came from and who wrote it. Output only. |
| `successor` | `string` | The fact that replaced this one, once it is superseded. Output only. |
| `create_time` | `timestamp` | When the fact was recorded. Output only. |
| `supersede_time` | `timestamp` | When the fact was replaced by a newer record; unset while current. Output only. |

### Citation

| Field | Type | What it is |
| --- | --- | --- |
| `episode` | `string` | The episode. |
| `space` | `string` | The episode's space. |
| `snippet` | `string` | The passage of the episode that supports the result. |
| `score` | `double` | The fused relevance score, higher is more relevant. |
| `occur_time` | `timestamp` | When the episode happened. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only. |
| `create_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |
| `creator` | `string` | The principal that created the Resource. Output only. |

### ExternalId

| Field | Type | What it is |
| --- | --- | --- |
| `kind` | `string` | The kind of identifier: `email`, `phone`, `auth_subject`, `channel_user`, `account`, or a caller's own kind. Required. |
| `value` | `string` | The identifier, normalised (a lowercase email, an E.164 phone number). Required. |

### Provenance

| Field | Type | What it is |
| --- | --- | --- |
| `principal` | `string` | The principal the write is attributed to, as a share subject (`user:<id>`, `end_user:<id>`): the member or end user an agent or app acts for. Set by the server from the caller's credential. Output only. |
| `actor` | `string` | The caller that made the write when it is not the principal: an agent (`agent:<id>`), an app key (`api_key:<id>`) or a connector. Output only. |
| `channel` | `Channel` | The path the write took. Output only. One of `api`, `tool`, `import`, `extraction`. |
| `method` | `SourceMethod` | How the content was produced; default `SOURCE_METHOD_STATED`. Only the service writes `SOURCE_METHOD_EXTRACTED`. One of `stated`, `extracted`, `imported`. |
| `references` | `SourceRef[]` | References to where the content came from: a run and step, a work item, a message, a URL. At most 20. |
| `model` | `string` | For an extracted record, the model id that extracted it. Output only. |
| `confidence` | `double` | For an extracted record, the extractor's confidence, 0 to 1. Output only. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`RATE_LIMITED`](/docs/api/errors/RATE_LIMITED) — The rate limit is reached; see Retry-After.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/entities:recall" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"…"}'
```

**TypeScript**

```ts
const response = await sylphx.knowledge.entities.recall({ parent: 'orgs/acme/projects/shop/envs/production', query: '…' })
```

**Rust**

```rust
let mut req = sylphx::knowledge::RecallEntitiesRequest::default();
req.parent = "orgs/acme/projects/shop/envs/production".to_string();
req.query = "…".to_string();
let response = sx.knowledge().entities().recall(req).await?;
```

**CLI**

```bash
sylphx knowledge entities recall orgs/acme/projects/shop/envs/production
```

**MCP**

```json
{ "method_id": "knowledge.entities.recall", "args": {"parent":"orgs/acme/projects/shop/envs/production","query":"…"} }
```