Annotations

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.

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

post/apps/annotation-reply/{action}

Request

  • Base URL
    https://api.dify.ai/v1
  • URL
    https://api.dify.ai/v1/apps/annotation-reply/{action}
  • Auth
    HTTP bearer

Path parameters

action'enable' | 'disable' required

Whether to enable or disable annotation reply.

Request body

embedding_model_namestring required

Embedding model used to vectorize annotations for matching (for example, text-embedding-3-small).

embedding_provider_namestring required

Embedding model provider (for example, openai). Get available providers from Get Available Models.

score_thresholdnumber float required

Minimum similarity score for an annotation to be considered a match. Higher values require closer matches.

Response

Annotation reply settings task initiated.

job_idstring uuid

Asynchronous job ID. Use with Get Annotation Reply Job Status to track progress.

job_statusstring

Current job status: waiting (queued) or processing (in progress). completed and error are returned only by Get Annotation Reply Job Status.

Changes

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