List episodes
Lists a space's episodes, newest first.
This method is not served on the public API.
api.sylphx.comdoes not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.
Lists a space's episodes, newest first. The filter is limited to kind and extraction.
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
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/spaces/space/episodes - Scope
knowledge:read - Effect
read— nothing is written. - Collection episodes
- Query
page_size,page_token,filter - Pagination the answer carries
episodesand, when there is more,next_page_token
Request
| Field | Type | What it is |
|---|---|---|
parent | string | The parent to list in. Required. |
page_size | int32 | 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. |
Response
| Field | Type | What it is |
|---|---|---|
episodes | Episode[] | The page. |
next_page_token | string | The token of the next page; empty on the last page. |
Episode
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/spaces/{space}/episodes/{episode}. |
uid | string | epi_<26 base32>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
kind | EpisodeKind | 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 | struct | 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 | Provenance | Where it came from and who wrote it. |
entities | string[] | The entities the caller says the episode is about, as resource names; extraction adds the ones it finds. At most 50. |
extraction | Extraction | Where extraction stands. Output only. One of pending, done, failed, skipped. |
create_time | timestamp | When the episode was recorded. Output only. |
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. |
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. |
SourceRef
| Field | Type | What it is |
|---|---|---|
uri | string | A URI: a URL, or a URN of a platform record such as a Workflows run step. Required. |
label | string | A short label to show with a citation. |
pinned_version | string | Immutable version of the source observed when this claim was recorded. |
Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.PAGE_TOKEN_MISMATCH— A page token was reused with different parameters.
Every error arrives in the body Errors describes.
Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/spaces/space/episodes" \
-H "Authorization: Bearer $SYLPHX_API_KEY"