Sign in

v6

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-0182128753.1 KB
Annotations

Configure Annotation Reply

Available for: Chatflow, Chatbot, 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}

Path parameters

action'enable' | 'disable' required

Whether to enable or disable annotation reply.

Request body

embedding_provider_namestring required

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

embedding_model_namestring required

Embedding model used to vectorize annotations for matching (for example, 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.