> ## 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.

# Configure Annotation Reply

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

Enables or disables annotation reply for the app. Runs asynchronously; track progress with [Get Annotation Reply Job Status](/en/api-reference/annotations/get-annotation-reply-job-status).

The body is validated before the action runs, so `score_threshold`, `embedding_provider_name`, and `embedding_model_name` are required even for `disable`.



## OpenAPI

````yaml /en/api-reference/openapi_service.json post /apps/annotation-reply/{action}
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/annotation-reply/{action}:
    post:
      tags:
        - Annotations
      summary: Configure Annotation Reply
      description: >-
        **Available for**: Chatflow, Chatbot, Legacy Agent apps.


        Enables or disables annotation reply for the app. Runs asynchronously;
        track progress with [Get Annotation Reply Job
        Status](/en/api-reference/annotations/get-annotation-reply-job-status).


        The body is validated before the action runs, so `score_threshold`,
        `embedding_provider_name`, and `embedding_model_name` are required even
        for `disable`.
      operationId: initialAnnotationReplySettings
      parameters:
        - description: Whether to enable or disable annotation reply.
          in: path
          name: action
          required: true
          schema:
            enum:
              - enable
              - disable
            type: string
      requestBody:
        content:
          application/json:
            examples:
              enableAnnotationReply:
                summary: Request Example
                value:
                  embedding_model_name: text-embedding-3-small
                  embedding_provider_name: openai
                  score_threshold: 0.9
            schema:
              $ref: '#/components/schemas/InitialAnnotationReplySettingsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                annotationReplyResponse:
                  summary: Response Example
                  value:
                    job_id: a1b2c3d4-5678-90ab-cdef-1234567890ab
                    job_status: waiting
              schema:
                $ref: '#/components/schemas/InitialAnnotationReplySettingsResponse'
          description: Annotation reply settings task initiated.
components:
  schemas:
    InitialAnnotationReplySettingsRequest:
      description: Request body for configuring annotation reply settings.
      properties:
        embedding_model_name:
          description: >-
            Embedding model used to vectorize annotations for matching (for
            example, `text-embedding-3-small`).
          type: string
        embedding_provider_name:
          description: >-
            Embedding model provider (for example, `openai`). Get available
            providers from [Get Available
            Models](/en/api-reference/models/get-available-models).
          type: string
        score_threshold:
          description: >-
            Minimum similarity score for an annotation to be considered a match.
            Higher values require closer matches.
          format: float
          type: number
      required:
        - score_threshold
        - embedding_provider_name
        - embedding_model_name
      type: object
    InitialAnnotationReplySettingsResponse:
      properties:
        job_id:
          description: >-
            Asynchronous job ID. Use with [Get Annotation Reply Job
            Status](/en/api-reference/annotations/get-annotation-reply-job-status)
            to track progress.
          format: uuid
          type: string
        job_status:
          description: >-
            Current job status: `waiting` (queued) or `processing` (in
            progress). `completed` and `error` are returned only by [Get
            Annotation Reply Job
            Status](/en/api-reference/annotations/get-annotation-reply-job-status).
          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

````