Dify Octri Demo
POST/apps/annotation-reply/{action}

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.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 3 body fields
actionstringrequired
Whether to enable or disable annotation reply.
Allowed:enabledisable
embedding_model_namestringrequired
Embedding model used to vectorize annotations for matching (for example, `text-embedding-3-small`).
embedding_provider_namestringrequired
Embedding model provider (for example, `openai`). Get available providers from [Get Available Models](/en/api-reference/models/get-available-models).
score_thresholdnumberrequired
Minimum similarity score for an annotation to be considered a match. Higher values require closer matches.

1 status code
200Annotation reply settings task initiated.
job_idstringoptional
Asynchronous job ID. Use with [Get Annotation Reply Job Status](/en/api-reference/annotations/get-annotation-reply-job-status) to track progress.
job_statusstringoptional
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).