Sign in
Annotations

Configure Annotation Reply

Available for: Chatflow, Chatbot, Agent apps.

Enables or disables the annotation reply feature. The request body is validated before the action runs, so embedding_provider_name, embedding_model_name, and score_threshold are required for both enable and disable. Executes asynchronously; use Get Annotation Reply Job Status to track progress.

post/apps/annotation-reply/{action}

Path parameters

action'enable' | 'disable' required

Action to perform.

Request body

embedding_provider_namestring required

Name of the embedding model provider (e.g., openai, cohere).

embedding_model_namestring required

Name of the embedding model to use for annotation matching (e.g., text-embedding-3-small).

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