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.
Authorizations
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).
Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).
Path Parameters
Whether to enable or disable annotation reply.
enable, disable Body
Request body for configuring annotation reply settings.
Embedding model provider (for example, openai). Get available providers from Get Available Models.
Embedding model used to vectorize annotations for matching (for example, text-embedding-3-small).
Minimum similarity score for an annotation to be considered a match. Higher values require closer matches.
Response
Annotation reply settings task initiated.
Asynchronous job ID. Use with Get Annotation Reply Job Status to track progress.
Current job status: waiting (queued) or processing (in progress). completed and error are returned only by Get Annotation Reply Job Status.