Annotations

Update Annotation

Available for: Chatflow, Chatbot, Legacy Agent apps.

Updates an annotation's question and answer.

put/apps/annotations/{annotation_id}

Request

  • Base URL
    https://api.dify.ai/v1
  • URL
    https://api.dify.ai/v1/apps/annotations/{annotation_id}
  • Auth
    HTTP bearer

Path parameters

annotation_idstring uuid required

ID of the annotation to update. Get annotation IDs from List Annotations.

Request body

answerstring required

New answer text for the annotation.

questionstring required

New question text for the annotation.

Response

Annotation updated successfully.

answerstring nullable

Predefined answer returned when the annotation is matched.

created_atinteger nullable

Creation timestamp (Unix epoch seconds).

hit_countinteger nullable

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

idstring uuid

Unique annotation identifier.

questionstring nullable

Question text that triggers this annotation.

Changes

No recorded changes to this operation across all 17 revisions of this API.