Skip to main content
post/apps/annotation-reply/{action}
Request example
Response
post/apps/annotation-reply/{action}

Authorization

Authorizationstringheaderrequired#

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

actionenum<string>required#
Whether to enable or disable annotation reply.
Options:enabledisable

Body

application/json
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.
score_thresholdnumberrequired#
Minimum similarity score for an annotation to be considered a match. Higher values require closer matches.

Responses

application/json
200
Annotation reply settings task initiated.
job_idstring#
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.