Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Create a space

Creates a space.

Creates a space.

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/spaces
  • Scope knowledge:write
  • Effect write — a successful call changes state.
  • Collection spaces
  • Query space_id, validate_only

#Request

FieldTypeWhat it is
parentstringThe parent to create in. Required.
space_idstringThe space id, the final name segment; the server assigns one when empty.
spaceSpaceThe space to create; only caller-writable fields are read. Required.
validate_onlyboolValidate and return the result without writing anything.

#Space

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/spaces/{space}.
metaResourceMetaResource metadata.
specSpaceSpecDesired state. Required.

#ResourceMeta

FieldTypeWhat it is
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.

#SpaceSpec

FieldTypeWhat it is
kindSpaceKindWhat the space holds. Required. One of workspace, project, team, end_user, agent, shared.
parentstringThe space this one inherits grants from, for example a project space under its workspace space. A reader of the parent reads this space.
ownerstringThe principal a private space belongs to, as a share subject: end_user:<id> for SPACE_KIND_END_USER, agent:<id> or agent:<id>/end_user:<id> for SPACE_KIND_AGENT. Empty for a shared space. The owner is granted owner on the space.
grantsSpaceGrant[]Who may read and write the space, beyond owner and what parent grants; at most 200. A repeated grant is stored once.
sensitiveboolThe space holds customer personal data. Its records are never sent in embeddings outside the cell's model routes, and enter a context pack or an answer that spans spaces only for a reader that holds reader on this space directly. Only deterministic entity matches apply to it.
schemasstring[]The Knowledge Schemas whose types the space accepts, as resource names; the core schema is always accepted. At most 20.

#SpaceGrant

FieldTypeWhat it is
roleSpaceRoleThe role granted. Required. One of reader, writer, owner.
subjectstringThe share subject: user:<id>, end_user:<id>, agent:<id>, or a userset such as workspace:<id>#member. Required.

#Response

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.

#ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong 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_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

#SpaceSpec

FieldTypeWhat it is
kindSpaceKindWhat the space holds. Required. One of workspace, project, team, end_user, agent, shared.
parentstringThe space this one inherits grants from, for example a project space under its workspace space. A reader of the parent reads this space.
ownerstringThe principal a private space belongs to, as a share subject: end_user:<id> for SPACE_KIND_END_USER, agent:<id> or agent:<id>/end_user:<id> for SPACE_KIND_AGENT. Empty for a shared space. The owner is granted owner on the space.
grantsSpaceGrant[]Who may read and write the space, beyond owner and what parent grants; at most 200. A repeated grant is stored once.
sensitiveboolThe space holds customer personal data. Its records are never sent in embeddings outside the cell's model routes, and enter a context pack or an answer that spans spaces only for a reader that holds reader on this space directly. Only deterministic entity matches apply to it.
schemasstring[]The Knowledge Schemas whose types the space accepts, as resource names; the core schema is always accepted. At most 20.

#SpaceStatus

FieldTypeWhat it is
observed_generationint64The generation this status was computed from. Output only.
conditionsCondition[]Ready, Reconciling, Stalled. Output only.
episode_countint64The number of episodes in the space. Output only.
fact_countint64The number of current facts in the space. Output only.
last_write_timetimestampWhen a record of the space was last written. Output only.

#SpaceGrant

FieldTypeWhat it is
roleSpaceRoleThe role granted. Required. One of reader, writer, owner.
subjectstringThe share subject: user:<id>, end_user:<id>, agent:<id>, or a userset such as workspace:<id>#member. Required.

#Condition

FieldTypeWhat it is
typestringThe condition type, for example Ready.
statusConditionStatusWhether the condition holds. One of true, false, unknown.
observed_generationint64The generation this observation was made against.
reasonstringA machine-readable UpperCamelCase reason.
messagestringA customer-safe human-readable message.
severitySeverityHow severe a FALSE condition is. One of info, warning, error.
transition_timetimestampWhen status last changed.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/spaces" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"spec":{"kind":"workspace"}}'