Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Spaces

A Space is the permission container of the graph: a workspace, a project, a team, one end user's private space, one agent's private space.

A Space is the permission container of the graph: a workspace, a project, a team, one end user's private space, one agent's private space. Every Episode and Relation lives in exactly one space, and a principal sees a record only through a space it may read. Read and write are the share relations reader, writer and owner on the space, inherited through parent.

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

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}.
uidstringspc_<26 base32>; never reused. Output only.
metaResourceMetaResource metadata.
specSpaceSpecDesired state. Required.
statusSpaceStatusObserved state. 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 a space.
GETlistLists spaces.
POSTcreateCreates a space.
PATCHupdateUpdates a space.
DELETEdeleteDeletes a space. A space that still holds records is refused with INVALID_STATE unless force is set, which deletes its episodes and facts too.

#get

Gets a space.

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

#list

Lists spaces.

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

#create

Creates a space.

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

#update

Updates a space.

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

#delete

Deletes a space. A space that still holds records is refused with INVALID_STATE unless force is set, which deletes its episodes and facts too.

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