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

Authorization

Authorizationstringheaderrequired#

すべてのリクエストは API キーで認証します:Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します(Dify API クイックスタート)。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401(unauthorized)で失敗します。

Body

application/json
answerstringrequired#
このアノテーションが一致したときに返される回答です。
questionstringrequired#
アプリが受信したユーザー入力を照合する質問テキストです。

Responses

application/json
201
アノテーションが正常に作成されました。
answerstring#
アノテーションがマッチした際に返される定義済みの回答です。
created_atinteger#
作成タイムスタンプ(Unix エポック秒)。
hit_countinteger#
このアノテーションがマッチして返信として返された回数です。
idstring#
アノテーションの一意識別子です。
questionstring#
このアノテーションをトリガーする質問テキストです。