Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Episodes

An Episode is the source of everything in the graph: one write as it happened (a note, a message, a step result, a document chunk, an…

An Episode is the source of everything in the graph: one write as it happened (a note, a message, a step result, a document chunk, an imported row), with its provenance. Creating one is remember; extraction reads it afterwards and proposes entities and relations that cite it.

Service Sylphx Knowledge · Resource type knowledge.sylphx.com/Episode · Name pattern orgs/{org}/projects/{project}/envs/{env}/spaces/{space}/episodes/{episode} · Shape record

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

#Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/spaces/{space}/episodes/{episode}.
uidstringepi_<26 base32>; never reused. Output only.
metaResourceMetaResource metadata.
kindEpisodeKindWhat the episode is. Required. One of note, message, step_result, document_chunk, imported_row, structured.
textstringThe text as written, at most 64 KiB. An episode has text, data, or both.
datastructStructured content, for a caller that already knows the shape (an imported row, a form).
occur_timetimestampWhen it happened in the world; default the time it was recorded.
provenanceProvenanceWhere it came from and who wrote it.
entitiesstring[]The entities the caller says the episode is about, as resource names; extraction adds the ones it finds. At most 50.
extractionExtractionWhere extraction stands. Output only. One of pending, done, failed, skipped.
create_timetimestampWhen the episode was recorded. Output only.

#Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGets an episode.
GETlistLists a space's episodes, newest first. The filter is limited to kind and extraction.
POSTcreateRecords an episode and returns at once (remember); extraction reads it afterwards.
DELETEdeleteDeletes an episode, the facts that cite only it, and its search and embedding entries; facts that also cite other episodes are re-scored.

#get

Gets an episode.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/spaces/space/episodes/episode · scope knowledge:read · effect read · not available yet · Request, response and examples

#list

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

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/spaces/space/episodes · scope knowledge:read · effect read · not available yet · paginated · Request, response and examples

#create

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

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/spaces/space/episodes · scope knowledge:write · effect write · not available yet · Request, response and examples

#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.

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/spaces/space/episodes/episode · scope knowledge:write · effect destructive · not available yet · Request, response and examples