Update Annotation | Dify Octri Demo

1 parameter · 2 body fields

annotation_idstringrequired

ID of the annotation to update. Get annotation IDs from [List Annotations](/en/api-reference/annotations/list-annotations).

answerstringrequired

New answer text for the annotation.

questionstringrequired

New question text for the annotation.

2 status codes

200Annotation updated successfully.

answerstringoptional

Predefined answer returned when the annotation is matched.

created_atintegeroptional

Creation timestamp (Unix epoch seconds).

hit_countintegeroptional

Number of times this annotation has been matched and returned as a reply.

idstringoptional

Unique annotation identifier.

questionstringoptional

Question text that triggers this annotation.

404`not_found` : Annotation does not exist.

One documented failure

not_found
Annotation not found
not_found

Error handling

A 404 is returned: not_found : Annotation does not exist.

import { Client } from "dify-octri-demo-sdk";

const client = new Client({
  baseUrl: "https://{api_base_url}",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.annotations.update({
  annotationId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  answer: "example",
  question: "example",
});

{
  "answer": "Dify is an open-source LLM application development platform for building AI-powered apps.",
  "created_at": 1705407629,
  "hit_count": 5,
  "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "question": "What is Dify?"
}

Request

Response

Errors