Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Notifications
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
sylphx knowledge spaces
Every sylphx knowledge spaces command: its argument, its flags and a run line.
The spaces commands of Sylphx Knowledge, as the CLI spells them: the same
calls as the spaces API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
Not available yet. Sylphx Knowledge is declared in the registry but no backend serves it: every command answers 501 with the problem code UNIMPLEMENTED.
#get
Gets a space.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx knowledge spaces get orgs/acme/projects/shop/envs/production/spaces/spaceGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/spaces/space · scope knowledge:read · effect read · Request, response and examples
#list
Lists spaces.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx knowledge spaces list orgs/acme/projects/shop/envs/productionGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/spaces · scope knowledge:read · effect read · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--page-size | int | At most this many; default 50, clamped to 1000. |
--page-token | string | next_page_token of the previous page. |
--filter | string | AIP-160 filter over labels and filterable fields. |
--order-by | string | AIP-132 ordering over filterable fields. |
#create
Creates a space.
ID — The id segment of the new Resource's name; the server assigns one when omitted.
CLI
sylphx knowledge spaces create --parent orgs/acme/projects/shop/envs/production --spec.kind workspacePOST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/spaces · scope knowledge:write · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--parent | string | The parent to create in; defaults to the linked project or the key's scope. |
--meta.labels | key=value | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
--meta.annotations | key=value | Caller-writable, unindexed annotations. Repeat the flag for each value. |
--meta.display-name | string | Caller-writable human-readable name. |
--spec.kind | enum | What the space holds. Required. One of workspace, project, team, end_user, agent, shared. |
--spec.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. |
--spec.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. |
--spec.grants | json | Who may read and write the space, beyond owner and what parent grants; at most 200. A repeated grant is stored once. Repeat the flag for each value. |
--spec.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. |
--spec.schemas | string | The Knowledge Schemas whose types the space accepts, as resource names; the core schema is always accepted. At most 20. Repeat the flag for each value. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#update
Updates a space.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx knowledge spaces update orgs/acme/projects/shop/envs/production/spaces/space --spec.kind workspacePATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/spaces/space · scope knowledge:write · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--meta.labels | key=value | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
--meta.annotations | key=value | Caller-writable, unindexed annotations. Repeat the flag for each value. |
--meta.display-name | string | Caller-writable human-readable name. |
--spec.kind | enum | What the space holds. Required. One of workspace, project, team, end_user, agent, shared. |
--spec.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. |
--spec.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. |
--spec.grants | json | Who may read and write the space, beyond owner and what parent grants; at most 200. A repeated grant is stored once. Repeat the flag for each value. |
--spec.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. |
--spec.schemas | string | The Knowledge Schemas whose types the space accepts, as resource names; the core schema is always accepted. At most 20. Repeat the flag for each value. |
--allow-missing | bool | Create the space when it does not exist (declarative upsert). |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#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.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx knowledge spaces delete orgs/acme/projects/shop/envs/production/spaces/space --yesDELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/spaces/space · scope knowledge:write · effect destructive · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--etag | string | Delete only if the current etag matches. |
--allow-missing | bool | Succeed when the space does not exist. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
--force | bool | Also delete the space's episodes and facts; without it, a space that holds records is refused with INVALID_STATE. |
--yes | bool | Do not ask before this destructive call. |