Create Annotation

Creates a new annotation. Annotations provide predefined question-answer pairs that the app can match and return directly instead of generating a response.

POST /apps/annotations

Error

A valid request URL is required to generate request examples

201

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

Authorizations

Authorization · string · header · required

API Key authentication. For all API requests, include your API Key in the Authorization HTTP Header, prefixed with Bearer. Example: Authorization: Bearer {API_KEY}. Strongly recommend storing your API Key on the server-side, not shared or stored on the client-side, to avoid possible API-Key leakage that can lead to serious consequences.

Body

application/json

Request body for creating a new annotation.

question · string · required

Annotation question.

answer · string · required

Annotation answer.

Response

201 - application/json

Annotation created successfully.

id · string<uuid>

Unique annotation identifier.

question · string | null

Question text that triggers this annotation.

answer · string | null

Predefined answer returned when the annotation is matched.

hit_count · integer | null

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

created_at · integer<int64> | null

Creation timestamp (Unix epoch seconds).