Update document (PATCH)

Update a document without re-indexing.

PATCH/api/v1/documents

Update document fields.

Request body

Parameter	Type	Description
`id`required	`string`	Document ID to update.
`metadata`	`object`	New metadata (replaces existing).
`title`	`string`	New document title.

Example

import { Etoile } from "@etoile-dev/client";

const etoile = new Etoile({
apiKey: process.env.ETOILE_API_KEY,
});

await etoile.patch({
id: "starry-night",
title: "The Starry Night (Featured)",
metadata: {
  artist: "Vincent van Gogh",
  year: 1889,
  featured: true,
},
});

const response = await fetch("https://etoile.dev/api/v1/documents", {
method: "PATCH",
headers: {
  Authorization: `Bearer ${process.env.ETOILE_SECRET_KEY}`,
  "Content-Type": "application/json",
},
body: JSON.stringify({
  id: "starry-night",
  title: "The Starry Night (Featured)",
  metadata: {
    artist: "Vincent van Gogh",
    year: 1889,
    featured: true,
  },
}),
});

curl -X PATCH "https://etoile.dev/api/v1/documents" \
-H "Authorization: Bearer $ETOILE_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{
  "id": "starry-night",
  "title": "The Starry Night (Featured)",
  "metadata": {
    "artist": "Vincent van Gogh",
    "year": 1889,
    "featured": true
  }
}'

Response

{
"message": "Document updated successfully.",
"id": "starry-night"
}

Auth

Requires secret key.