Skip to main content
post/apps/annotations
Request example
Response
post/apps/annotations

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).

Body

application/json
answerstringrequired#
Answer returned when this annotation is matched.
questionstringrequired#
Question text the app matches incoming user input against.

Responses

application/json
201
Annotation created successfully.
answerstring#
Predefined answer returned when the annotation is matched.
created_atinteger#
Creation timestamp (Unix epoch seconds).
hit_countinteger#
Number of times this annotation has been matched and returned as a reply.
idstring#
Unique annotation identifier.
questionstring#
Question text that triggers this annotation.