Skip to main content
POST
/
apps
/
annotation-reply
/
{action}
Error
A valid request URL is required to generate request examples
{
  "job_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "job_status": "waiting"
}

Documentation Index

Fetch the complete documentation index at: https://docs.dify.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API Key authentication. For all API requests, include your API Key in the Authorization HTTP Header, prefixed with Bearer . Example: Authorization: Bearer {API_KEY}. Strongly recommend storing your API Key on the server-side, not shared or stored on the client-side, to avoid possible API-Key leakage that can lead to serious consequences.

Path Parameters

​
action
enum<string>
required

Action to perform.

Available options:
enable,
disable

Body

application/json

Request body for configuring annotation reply settings.

​
embedding_provider_name
string
required

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

​
embedding_model_name
string
required

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

​
score_threshold
number<float>
required

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

Required range: 0 <= x <= 1

Response

200 - application/json

Annotation reply settings task initiated.

​
job_id
string<uuid>

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

​
job_status
string

Current job status. waiting for queued, processing for in progress, completed when finished, error if failed.