Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Knowledge schemas

A Knowledge Schema is a published, versioned set of types a graph accepts: entity types with a JSON Schema each, and relation types.

A Knowledge Schema is a published, versioned set of types a graph accepts: entity types with a JSON Schema each, and relation types. A type pack (the customer pack) is a schema, not code. The core schema is built in.

Service Sylphx Knowledge · Resource type knowledge.sylphx.com/KnowledgeSchema · Name pattern orgs/{org}/projects/{project}/envs/{env}/knowledge_schemas/{knowledge_schema} · 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}/knowledge_schemas/{knowledge_schema}.
uidstringksch_<26 base32>; never reused. Output only.
metaResourceMetaResource metadata.
specKnowledgeSchemaSpecDesired state. Required.
statusKnowledgeSchemaStatusObserved 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 knowledge schema.
GETlistLists knowledge schemas.
POSTcreateCreates a knowledge schema.
PATCHupdateUpdates a knowledge schema. An accepted update publishes a new revision; a change that would invalidate existing records is refused with INVALID_FIELD.
DELETEdeleteDeletes a knowledge schema. A schema a space still accepts is refused with RESOURCE_IN_USE.

#get

Gets a knowledge schema.

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

#list

Lists knowledge schemas.

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

#create

Creates a knowledge schema.

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

#update

Updates a knowledge schema. An accepted update publishes a new revision; a change that would invalidate existing records is refused with INVALID_FIELD.

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

#delete

Deletes a knowledge schema. A schema a space still accepts is refused with RESOURCE_IN_USE.

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