---
# @generated by sylphx-gen 0.1.0 from contracts@fb95f0c42a0ec5d8e3cb694c0054b529c0b24b184112c65ef60c9044b4ce61f9. Do not edit.
title: "sylphx knowledge episodes"
description: "The sylphx knowledge episodes commands of Sylphx Knowledge: every verb, with its argument, its flags and a run line."
type: reference
product: knowledge
summary: "Every sylphx knowledge episodes command: its argument, its flags and a run line."
updated: 2026-09-28
nav: false
---

The `episodes` commands of Sylphx Knowledge, as the CLI spells them: the same
calls as [the `episodes` API page](/docs/api/episodes), typed for the
shell. [Install, sign in and the grammar](/docs/cli) are on the CLI index.

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

## get

Gets an episode.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx knowledge episodes get orgs/acme/projects/shop/envs/production/spaces/space/episodes/episode
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/spaces/space/episodes/episode` · scope `knowledge:read` · effect `read` · [Request, response and examples](/docs/api/episodes/get)

## list

Lists a space's episodes, newest first. The filter is limited to `kind` and `extraction`.

**`PARENT`** — optional: the CLI fills it from the linked project or the
key's scope when it is left out.

**CLI**

```bash
sylphx knowledge episodes list orgs/acme/projects/shop/envs/production/spaces/space
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/spaces/space/episodes` · scope `knowledge:read` · effect `read` · [Request, response and examples](/docs/api/episodes/list)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--page-size` | `int` | At most this many; default 50, clamped to 1000. |
| `--page-token` | `string` | `next_page_token` of the previous page. |
| `--filter` | `string` | AIP-160 filter, limited to `kind` and `extraction`; for example `kind = EPISODE_KIND_NOTE AND extraction = EXTRACTION_DONE`. |

## create

Records an episode and returns at once (`remember`); extraction reads it afterwards.

**`ID`** — The id segment of the new Resource's name; the server assigns one when omitted.

**CLI**

```bash
sylphx knowledge episodes create --parent orgs/acme/projects/shop/envs/production/spaces/space --kind note
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/spaces/space/episodes` · scope `knowledge:write` · effect `write` · [Request, response and examples](/docs/api/episodes/create)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--parent` | `string` | The parent to create in; defaults to the linked project or the key's scope. |
| `--meta.labels` | `key=value` | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
| `--meta.annotations` | `key=value` | Caller-writable, unindexed annotations. Repeat the flag for each value. |
| `--meta.display-name` | `string` | Caller-writable human-readable name. |
| `--kind` | `enum` | What the episode is. Required. One of `note`, `message`, `step_result`, `document_chunk`, `imported_row`, `structured`. |
| `--text` | `string` | The text as written, at most 64 KiB. An episode has `text`, `data`, or both. |
| `--data` | `json` | Structured content, for a caller that already knows the shape (an imported row, a form). |
| `--occur-time` | `timestamp` | When it happened in the world; default the time it was recorded. |
| `--provenance.method` | `enum` | How the content was produced; default `SOURCE_METHOD_STATED`. Only the service writes `SOURCE_METHOD_EXTRACTED`. One of `stated`, `extracted`, `imported`. |
| `--provenance.references` | `json` | References to where the content came from: a run and step, a work item, a message, a URL. At most 20. Repeat the flag for each value. |
| `--entities` | `string` | The entities the caller says the episode is about, as resource names; extraction adds the ones it finds. At most 50. Repeat the flag for each value. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--skip-extraction` | `bool` | Record the episode without extraction, for content that is already structured or must not be read by a model. |

## delete

Deletes an episode, the facts that cite only it, and its search and embedding entries; facts that also cite other episodes are re-scored.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx knowledge episodes delete orgs/acme/projects/shop/envs/production/spaces/space/episodes/episode --yes
```

`DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/spaces/space/episodes/episode` · scope `knowledge:write` · effect `destructive` · [Request, response and examples](/docs/api/episodes/delete)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--etag` | `string` | Delete only if the current etag matches. |
| `--allow-missing` | `bool` | Succeed when the episode does not exist. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--yes` | `bool` | Do not ask before this destructive call. |
