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 knowledge_schemas
Every sylphx knowledge knowledge_schemas command: its argument, its flags and a run line.
The knowledge_schemas commands of Sylphx Knowledge, as the CLI spells them: the same
calls as the knowledge_schemas 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 knowledge schema.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx knowledge knowledge-schemas get orgs/acme/projects/shop/envs/production/knowledge_schemas/knowledge-schemaGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/knowledge_schemas/knowledge-schema · scope knowledge:read · effect read · Request, response and examples
#list
Lists knowledge schemas.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx knowledge knowledge-schemas list orgs/acme/projects/shop/envs/productionGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/knowledge_schemas · 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 knowledge schema.
ID — The id segment of the new Resource's name; the server assigns one when omitted.
CLI
sylphx knowledge knowledge-schemas create --parent orgs/acme/projects/shop/envs/productionPOST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/knowledge_schemas · 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.entity-types | json | The entity types; at most 200. Repeat the flag for each value. |
--spec.relation-types | json | The relation types; at most 500. Repeat the flag for each value. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#update
Updates a knowledge schema. An accepted update publishes a new revision; a change that would invalidate existing records is refused with INVALID_FIELD.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx knowledge knowledge-schemas update orgs/acme/projects/shop/envs/production/knowledge_schemas/knowledge-schemaPATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/knowledge_schemas/knowledge-schema · 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.entity-types | json | The entity types; at most 200. Repeat the flag for each value. |
--spec.relation-types | json | The relation types; at most 500. Repeat the flag for each value. |
--allow-missing | bool | Create the knowledge schema when it does not exist (declarative upsert). |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#delete
Deletes a knowledge schema. A schema a space still accepts is refused with RESOURCE_IN_USE.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx knowledge knowledge-schemas delete orgs/acme/projects/shop/envs/production/knowledge_schemas/knowledge-schema --yesDELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/knowledge_schemas/knowledge-schema · 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 knowledge schema does not exist. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
--yes | bool | Do not ask before this destructive call. |