On this page
Update a space
Updates a space.
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.
Updates 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
PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/spaces/space - Scope
knowledge:write - Effect
write— a successful call changes state. - Collection spaces
- Query
update_mask,allow_missing,validate_only
Request
| Field | Type | What it is |
|---|---|---|
space | Space | The space to update; name identifies it. Required. |
update_mask | field_mask | The fields to write; unset writes every populated field. |
allow_missing | bool | Create the space when it does not exist (declarative upsert). |
validate_only | bool | Validate and return the result without writing anything. |
Space
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/spaces/{space}. |
meta | ResourceMeta | Resource metadata. |
spec | SpaceSpec | Desired state. Required. |
ResourceMeta
| Field | Type | What it is |
|---|---|---|
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. |
SpaceSpec
| Field | Type | What it is |
|---|---|---|
kind | SpaceKind | What the space holds. Required. One of workspace, project, team, end_user, agent, shared. |
parent | string | The space this one inherits grants from, for example a project space under its workspace space. A reader of the parent reads this space. |
owner | string | The 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. |
grants | SpaceGrant[] | Who may read and write the space, beyond owner and what parent grants; at most 200. A repeated grant is stored once. |
sensitive | bool | The 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. |
schemas | string[] | The Knowledge Schemas whose types the space accepts, as resource names; the core schema is always accepted. At most 20. |
SpaceGrant
| Field | Type | What it is |
|---|---|---|
role | SpaceRole | The role granted. Required. One of reader, writer, owner. |
subject | string | The share subject: user:<id>, end_user:<id>, agent:<id>, or a userset such as workspace:<id>#member. Required. |
Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/spaces/{space}. |
uid | string | spc_<26 base32>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | SpaceSpec | Desired state. Required. |
status | SpaceStatus | Observed state. 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. |
SpaceSpec
| Field | Type | What it is |
|---|---|---|
kind | SpaceKind | What the space holds. Required. One of workspace, project, team, end_user, agent, shared. |
parent | string | The space this one inherits grants from, for example a project space under its workspace space. A reader of the parent reads this space. |
owner | string | The 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. |
grants | SpaceGrant[] | Who may read and write the space, beyond owner and what parent grants; at most 200. A repeated grant is stored once. |
sensitive | bool | The 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. |
schemas | string[] | The Knowledge Schemas whose types the space accepts, as resource names; the core schema is always accepted. At most 20. |
SpaceStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready, Reconciling, Stalled. Output only. |
episode_count | int64 | The number of episodes in the space. Output only. |
fact_count | int64 | The number of current facts in the space. Output only. |
last_write_time | timestamp | When a record of the space was last written. Output only. |
SpaceGrant
| Field | Type | What it is |
|---|---|---|
role | SpaceRole | The role granted. Required. One of reader, writer, owner. |
subject | string | The share subject: user:<id>, end_user:<id>, agent:<id>, or a userset such as workspace:<id>#member. Required. |
Condition
| Field | Type | What it is |
|---|---|---|
type | string | The condition type, for example Ready. |
status | ConditionStatus | Whether the condition holds. One of true, false, unknown. |
observed_generation | int64 | The generation this observation was made against. |
reason | string | A machine-readable UpperCamelCase reason. |
message | string | A customer-safe human-readable message. |
severity | Severity | How severe a FALSE condition is. One of info, warning, error. |
transition_time | timestamp | When status last changed. |
Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.UNKNOWN_FIELD— The request has a field the schema does not know.INVALID_FIELD— A field failed validation.ETAG_MISMATCH— The etag sent does not match the Resource's current etag.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.
Every error arrives in the body Errors describes.
Examples
curl -X PATCH "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/spaces/space" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"orgs/acme/projects/shop/envs/production/spaces/space","spec":{"kind":"workspace"}}'