Skip to main content
POST
Configure Annotation Reply

Authorizations

Authorization
string
header
required

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

action
enum<string>
required

Whether to enable or disable annotation reply.

Available options:
enable,
disable

Body

application/json

Request body for configuring annotation reply settings.

embedding_provider_name
string
required

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

embedding_model_name
string
required

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

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 (queued) or processing (in progress). completed and error are returned only by Get Annotation Reply Job Status.