Correct a knowledge document in place

The write result; the document was re-embedded in place.

PATCH /api/v1/knowledge/{id}

cURL

curl --request PATCH \
  --url 'https://response.stateset.com/api/v1/knowledge/{id}' \
  --header "Authorization: Bearer $RESPONSECX_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "knowledge": "string",
  "metadata": {}
}'

200

{
  "object": "knowledge.write_result",
  "action": "updated",
  "point_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "embedding_model": "string"
}

Path parameters

id · string · required

Request body

object

knowledge · string · required

metadata · object

Response

object

object · string · required

action · string · required

point_id · string (uuid) · required

The knowledge document id (a Qdrant point id).

embedding_model · string · required

The embedding model used to (re)embed the text.

Status codes

Code	Meaning
200	The write result; the document was re-embedded in place.
400	Invalid request. issues names the offending field(s).
401	Missing, invalid, or expired API key.
403	The key lacks a required scope.
404	Not found, or not in the organization that owns the key.
429	Rate limit exceeded.

Access

Required scope	knowledge:write
Rate limit	10 requests per minute

cURL

curl --request PATCH \
  --url 'https://response.stateset.com/api/v1/knowledge/{id}' \
  --header "Authorization: Bearer $RESPONSECX_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "knowledge": "string",
  "metadata": {}
}'

200

{
  "object": "knowledge.write_result",
  "action": "updated",
  "point_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "embedding_model": "string"
}