---
# @generated by sylphx-gen 0.1.0 from contracts@fb95f0c42a0ec5d8e3cb694c0054b529c0b24b184112c65ef60c9044b4ce61f9. Do not edit.
title: "Update a knowledge schema"
description: "`knowledge.knowledge_schemas.update` (PATCH /v1/{knowledge_schema.name}): Updates a knowledge schema."
type: reference
product: knowledge
summary: "Updates a knowledge schema."
updated: 2026-09-28
nav: false
---

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

**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/knowledge_schemas/knowledge-schema`
- **Scope** `knowledge:write`
- **Effect** `write` — a successful call changes state.
- **Collection** [knowledge_schemas](/docs/api/knowledge_schemas)
- **Query** `update_mask`, `allow_missing`, `validate_only`

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `knowledge_schema` | `KnowledgeSchema` | The knowledge schema to update; `name` identifies it. Required. |
| `update_mask` | `field_mask` | The fields to write; unset writes every populated field. |
| `allow_missing` | `bool` | Create the knowledge schema when it does not exist (declarative upsert). |
| `validate_only` | `bool` | Validate and return the result without writing anything. |

### KnowledgeSchema

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/knowledge_schemas/{knowledge_schema}`. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `KnowledgeSchemaSpec` | 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. |

### KnowledgeSchemaSpec

| Field | Type | What it is |
| --- | --- | --- |
| `entity_types` | `EntityTypeDefinition[]` | The entity types; at most 200. |
| `relation_types` | `RelationTypeDefinition[]` | The relation types; at most 500. |

### EntityTypeDefinition

| Field | Type | What it is |
| --- | --- | --- |
| `type_id` | `string` | The type id within the schema, snake_case; entities name it `<schema>.<type>`. Required. |
| `description` | `string` | What the type is, for people and for extraction; at most 1000 characters. |
| `properties_schema` | `struct` | The JSON Schema (2020-12) an entity's `properties` must satisfy. |
| `match_kinds` | `string[]` | The external id kinds that resolve entities of this type deterministically, for example `email` and `phone` for a contact. |

### RelationTypeDefinition

| Field | Type | What it is |
| --- | --- | --- |
| `predicate` | `string` | The predicate within the schema, snake_case; relations name it `<schema>.<predicate>`. Required. |
| `description` | `string` | What the relation means; at most 1000 characters. |
| `subject_types` | `string[]` | The entity types the subject may have; empty is any. |
| `object_types` | `string[]` | The entity types the object may have; empty is a value fact or any. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/knowledge_schemas/{knowledge_schema}`. |
| `uid` | `string` | `ksch_<26 base32>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `KnowledgeSchemaSpec` | Desired state. Required. |
| `status` | `KnowledgeSchemaStatus` | 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. |

### KnowledgeSchemaSpec

| Field | Type | What it is |
| --- | --- | --- |
| `entity_types` | `EntityTypeDefinition[]` | The entity types; at most 200. |
| `relation_types` | `RelationTypeDefinition[]` | The relation types; at most 500. |

### KnowledgeSchemaStatus

| Field | Type | What it is |
| --- | --- | --- |
| `observed_generation` | `int64` | The generation this status was computed from. Output only. |
| `conditions` | `Condition[]` | Ready, Reconciling, Stalled. Output only. |
| `revision` | `int64` | The published revision; each accepted update adds one. A record keeps the revision it was validated against. Output only. |

### EntityTypeDefinition

| Field | Type | What it is |
| --- | --- | --- |
| `type_id` | `string` | The type id within the schema, snake_case; entities name it `<schema>.<type>`. Required. |
| `description` | `string` | What the type is, for people and for extraction; at most 1000 characters. |
| `properties_schema` | `struct` | The JSON Schema (2020-12) an entity's `properties` must satisfy. |
| `match_kinds` | `string[]` | The external id kinds that resolve entities of this type deterministically, for example `email` and `phone` for a contact. |

### RelationTypeDefinition

| Field | Type | What it is |
| --- | --- | --- |
| `predicate` | `string` | The predicate within the schema, snake_case; relations name it `<schema>.<predicate>`. Required. |
| `description` | `string` | What the relation means; at most 1000 characters. |
| `subject_types` | `string[]` | The entity types the subject may have; empty is any. |
| `object_types` | `string[]` | The entity types the object may have; empty is a value fact or any. |

### 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`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.
- [`UNKNOWN_FIELD`](/docs/api/errors/UNKNOWN_FIELD) — The request has a field the schema does not know.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`ETAG_MISMATCH`](/docs/api/errors/ETAG_MISMATCH) — The etag sent does not match the Resource's current etag.
- [`IDEMPOTENCY_KEY_REUSED`](/docs/api/errors/IDEMPOTENCY_KEY_REUSED) — An Idempotency-Key was reused with another body.
- [`IDEMPOTENCY_IN_PROGRESS`](/docs/api/errors/IDEMPOTENCY_IN_PROGRESS) — The first call with this Idempotency-Key is still running.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl -X PATCH "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/knowledge_schemas/knowledge-schema" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"orgs/acme/projects/shop/envs/production/knowledge_schemas/knowledge-schema","spec":{}}'
```

**TypeScript**

```ts
const response = await sylphx.knowledge.knowledgeSchemas.update({ knowledgeSchema: { name: 'orgs/acme/projects/shop/envs/production/knowledge_schemas/knowledge-schema', spec: {} } })
```

**Rust**

```rust
let mut req = sylphx::knowledge::UpdateKnowledgeSchemaRequest::default();
req.knowledge_schema = Some(sylphx::knowledge::KnowledgeSchema {
    name: "orgs/acme/projects/shop/envs/production/knowledge_schemas/knowledge-schema".to_string(),
    spec: Some(Default::default()),
    ..Default::default()
});
let response = sx.knowledge().knowledge_schemas().update(req).await?;
```

**CLI**

```bash
sylphx knowledge knowledge-schemas update orgs/acme/projects/shop/envs/production/knowledge_schemas/knowledge-schema
```

**MCP**

```json
{ "method_id": "knowledge.knowledge_schemas.update", "args": {"knowledge_schema":{"name":"orgs/acme/projects/shop/envs/production/knowledge_schemas/knowledge-schema","spec":{}}} }
```