> ## Documentation Index
> Fetch the complete documentation index at: https://dify-6c0370d8-fix-template-upload-size-guidance.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Annotation

> **Available for**: Chatflow, Chatbot, Legacy Agent apps.

Creates an annotation. Annotations are predefined question-answer pairs the app returns directly on a match, instead of generating a fresh response.



## OpenAPI

````yaml /en/api-reference/openapi_service.json post /apps/annotations
openapi: 3.0.1
info:
  description: >-
    REST API for Dify applications and knowledge bases. Application endpoints
    authenticate with an app API key; knowledge endpoints authenticate with a
    dataset API key.
  title: Dify Service API
  version: 1.0.0
servers:
  - description: >-
      Base URL of the Dify Service API. For self-hosted deployments, replace it
      with your own API base URL.
    url: https://{api_base_url}
    variables:
      api_base_url:
        default: api.dify.ai/v1
        description: Host and path of the API base URL, without the `https://` prefix.
security:
  - ApiKeyAuth: []
tags:
  - description: Operations related to chat messages and interactions.
    name: Chat Messages
  - description: File upload and preview operations.
    name: Files
  - description: Operations related to end user information.
    name: End Users
  - description: User feedback operations.
    name: Feedback
  - description: Operations related to managing conversations.
    name: Conversations
  - description: Text-to-Speech and Speech-to-Text operations.
    name: Audio
  - description: Operations to retrieve application settings and information.
    name: Applications
  - description: Operations related to managing annotations for direct replies.
    name: Annotations
  - description: Endpoints for resuming paused workflows that require human input.
    name: Human Input
  - description: Operations for executing and managing workflows.
    name: Workflow Runs
  - description: Operations related to text generation and completion.
    name: Completion Messages
  - description: >-
      Operations for managing knowledge bases, including creation,
      configuration, and retrieval.
    name: Knowledge Bases
  - description: >-
      Operations for creating, updating, and managing documents within a
      knowledge base.
    name: Documents
  - description: Operations for managing document chunks and child chunks.
    name: Chunks
  - description: >-
      Operations for managing knowledge base metadata fields and document
      metadata values.
    name: Metadata
  - description: Operations for managing knowledge base tags and tag bindings.
    name: Tags
  - description: Operations for retrieving available models.
    name: Models
  - description: >-
      Operations for managing and running knowledge pipelines, including
      datasource plugins and pipeline execution.
    name: Knowledge Pipeline
paths:
  /apps/annotations:
    post:
      tags:
        - Annotations
      summary: Create Annotation
      description: >-
        **Available for**: Chatflow, Chatbot, Legacy Agent apps.


        Creates an annotation. Annotations are predefined question-answer pairs
        the app returns directly on a match, instead of generating a fresh
        response.
      operationId: createAnnotation
      requestBody:
        content:
          application/json:
            examples:
              createAnnotation:
                summary: Request Example
                value:
                  answer: Dify is an open-source LLM application development platform.
                  question: What is Dify?
            schema:
              $ref: '#/components/schemas/CreateAnnotationRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              examples:
                createdAnnotation:
                  summary: Response Example
                  value:
                    answer: >-
                      Dify is an open-source LLM application development
                      platform.
                    created_at: 1705407629
                    hit_count: 0
                    id: a1b2c3d4-5678-90ab-cdef-1234567890ab
                    question: What is Dify?
              schema:
                $ref: '#/components/schemas/AnnotationItem'
          description: Annotation created successfully.
components:
  schemas:
    CreateAnnotationRequest:
      description: Request body for creating a new annotation.
      properties:
        answer:
          description: Answer returned when this annotation is matched.
          type: string
        question:
          description: Question text the app matches incoming user input against.
          type: string
      required:
        - question
        - answer
      type: object
    AnnotationItem:
      properties:
        answer:
          description: Predefined answer returned when the annotation is matched.
          nullable: true
          type: string
        created_at:
          description: Creation timestamp (Unix epoch seconds).
          format: int64
          nullable: true
          type: integer
        hit_count:
          description: >-
            Number of times this annotation has been matched and returned as a
            reply.
          nullable: true
          type: integer
        id:
          description: Unique annotation identifier.
          format: uuid
          type: string
        question:
          description: Question text that triggers this annotation.
          nullable: true
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      bearerFormat: API_KEY
      description: >-
        Every request authenticates with an API key: `Authorization: Bearer
        {API_KEY}`. App endpoints take an app API key; knowledge endpoints take
        a knowledge base API key ([Get
        Started](/en/api-reference/guides/get-started)).


        Keep keys server-side; never embed them in client code. Requests with a
        missing or invalid key fail with HTTP `401` (`unauthorized`).
      scheme: bearer
      type: http

````