Skip to main content
POST
/
apps
/
annotations
Error
A valid request URL is required to generate request examples
{
  "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "question": "What is Dify?",
  "answer": "Dify is an open-source LLM application development platform.",
  "hit_count": 0,
  "created_at": 1705407629
}

Authorizations

​
Authorization
string
header
required

API Key 認証です。すべての API リクエストにおいて、Authorization HTTP ヘッダーに Bearer プレフィックスを付けた API Key を含めてください。例：Authorization: Bearer {API_KEY}。API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。

Body

application/json

新しいアノテーションを作成するためのリクエストボディです。

​
question
string
required

アノテーションの質問です。

​
answer
string
required

アノテーションの回答です。

Response

201 - application/json

アノテーションが正常に作成されました。

​
id
string<uuid>

アノテーションの一意識別子です。

​
question
string | null

このアノテーションをトリガーする質問テキストです。

​
answer
string | null

アノテーションがマッチした際に返される定義済みの回答です。

​
hit_count
integer | null

このアノテーションがマッチして返信として返された回数です。

​
created_at
integer<int64> | null

作成タイムスタンプ（Unix エポック秒）。