POST/apps/annotations

Create Annotation

Available for: Chatflow, Chatbot, Legacy Agent apps.

Creates an annotation. Annotations are predefined question-answer pairs the app returns directly on a match, instead of generating a fresh response.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 body fields
answerstringrequired
Answer returned when this annotation is matched.
questionstringrequired
Question text the app matches incoming user input against.

1 status code
201Annotation created successfully.
answerstringoptional
Predefined answer returned when the annotation is matched.
created_atintegeroptional
Creation timestamp (Unix epoch seconds).
hit_countintegeroptional
Number of times this annotation has been matched and returned as a reply.
idstringoptional
Unique annotation identifier.
questionstringoptional
Question text that triggers this annotation.