Update segments¶

Updates a segment in the current snapshot. Use its ETag to avoid overwriting another caller’s changes.

PATCH https://api.moi.matrixorigin.cn/v5/semantic-models/{model_id}/sources/{source_row_id}/segments/{segment_id}

Preparation before calling¶

First query document details to obtain data.etag and the segment ID. Prepare a personal access token with access to the target workspace and its workspace ID.

The source must be a file source with kb_file_id and an available vector index; table sources do not support segment writes.

The example below uses:

$AI_STUDIO_API_KEY: The actual personal access token, passed through the X-API-Key Header.
$WORKSPACE_ID: Target workspace ID, passed through X-Workspace-ID Header.
$MODEL_ID: Knowledge Base ID.
$SOURCE_ROW_ID: Source record ID.
$SEGMENT_ID: Segment ID to update.

Request example¶

curl -X PATCH "https://api.moi.matrixorigin.cn/v5/semantic-models/$MODEL_ID/sources/$SOURCE_ROW_ID/segments/$SEGMENT_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "if_match": "<DOCUMENT_ETAG>",
    "content": "<SEGMENT_CONTENT>"
  }'

Path parameters¶

Parameters	Type	Description
`model_id`	integer	Knowledge base ID.
`source_row_id`	string	Source record ID.
`segment_id`	string	The segment ID to update.

Request body¶

Submit the current snapshot’s ETag and the text, OCR text, or image description to update. If the body does not provide a nonempty if_match, pass the ETag in the If-Match header. At least one is required; a nonempty body value takes precedence.

Field	Type	Required	Description
`if_match`	string	Conditionally required	The `data.etag` read before this call; may be omitted when using the `If-Match` header.
`content`	string	No	The updated text content.
`ocr_text`	string	No	Updated OCR text.
`image_description`	string	No	Updated image description.

Successful response¶

Returns 200 and the complete updated source document snapshot on success. The example below is a response excerpt.

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "document": {
      "source": {
        "row_id": "src_01",
        "model_id": 401
      },
      "segment_status": {
        "available": true,
        "total": 2
      },
      "etag": "<NEW_DOCUMENT_ETAG>",
      "segments": [
        {
          "segment_id": "seg_01",
          "level": "chunk",
          "content": "更新后的文本",
          "enabled": true
        }
      ]
    }
  }
}

The response fields are as follows.

Field	Type	Description
`code`	string	`OK` on success.
`msg`	string	`OK` on success.
`data.document`	object	Snapshot of the updated source document.
`data.document.source.row_id`	string	Source record ID.
`data.document.segment_status`	object	Current segment availability status and total number.
`data.document.etag`	string	Current snapshot ETag; returned when nonempty, for subsequent conditional writes.
`data.document.segments[].segment_id`	string	Segment ID.
`data.document.segments[].content`	string	Updated segmented text; may be omitted if content is not returned.
`data.document.segments[].enabled`	boolean	Whether the segment participates in retrieval.

In field paths, [] means each item in an array. See document details for the complete source, preview, file information, status, and segment fields. Optional segment fields are omitted when unset.

Error response¶

A missing or blank ETag returns 400 with ErrParamInvalid. An ETag that differs from the current snapshot returns 409 with ErrConflict. Error messages depend on the request language.

{
  "code": "ErrConflict",
  "msg": "<ERROR_MESSAGE>",
  "data": null
}

Common HTTP errors¶

HTTP status code	error code	Common causes	Recommended actions
`400`	`ErrParamInvalid`	The path ID, request body, or ETag is invalid.	Read document details and submit the current ETag.
`401`	`ErrUnauthorized`	The API Key is invalid or has expired.	Check API Key.
`403`	`ErrForbidden`	The caller does not have permission to update this source.	Check workspace and object authorization.
`404`	`ErrNotFound`	The knowledge base, source, or segment does not exist or is not visible to the current caller.	Reread document confirmation ID.
`409`	`ErrConflict`	The supplied ETag differs from the current snapshot.	Read the latest snapshot, review the intended change, and submit again.
`500`	`ErrServer`	The service failed to update the segment.	Keep the desensitized response information and try again.

Follow-up operations¶

Query document details to confirm the update. Use data.document.etag for the next write; on conflict, reread the snapshot and review the intended change before submitting again.

Last updated on Oct 19, 2026