会話履歴メッセージ一覧を取得

curl --request GET \
  --url https://{deployed_api_base_url}/v2/messages \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{deployed_api_base_url}/v2/messages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{deployed_api_base_url}/v2/messages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{deployed_api_base_url}/v2/messages"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{deployed_api_base_url}/v2/messages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "limit": 20,
  "has_more": false,
  "data": [
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "conversation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "parent_message_id": "00000000-0000-0000-0000-000000000000",
      "inputs": {
        "order_id": "ORDER-1001"
      },
      "query": "Where is my refund now?",
      "answer": "Your refund is being processed by the bank.",
      "feedback": null,
      "retriever_resources": [],
      "created_at": 1787788860,
      "agent_thoughts": [],
      "message_files": [
        {
          "id": "a8098c1a-f86e-51da-bd1e-66d42f3f323a",
          "filename": "receipt.pdf",
          "type": "document",
          "url": "/v2/files/16fd2706-8baf-433b-82eb-8c7fada847da/preview?user=customer-001",
          "mime_type": "application/pdf",
          "size": 48231,
          "transfer_method": "local_file",
          "belongs_to": "user",
          "upload_file_id": "16fd2706-8baf-433b-82eb-8c7fada847da"
        }
      ],
      "message_tokens": 28,
      "answer_tokens": 19,
      "total_tokens": 47,
      "provider_response_latency": 0,
      "total_price": "0.0012",
      "currency": "USD",
      "status": "normal",
      "error": null,
      "extra_contents": []
    }
  ]
}

デプロイ環境

会話履歴メッセージ一覧を取得

対象アプリ：Chatflow。

会話の履歴をスクロール読み込み向けの形式で返します。first_id を指定しない場合は、最新の limit 件を古い順に返します。first_id を指定すると、そのメッセージより前の履歴を返します。

標準 API の対応する操作：会話履歴メッセージ一覧を取得。相違点は次のとおりです。

user が必須です。
次のレスポンスフィールドは値が固定です。
- feedback は常に null です。
- retriever_resources は常に空です。
- agent_thoughts は常に空です。
- parent_message_id は常にすべて 0 の UUID です。
エラーコードが異なります。

GET

messages

会話履歴メッセージ一覧を取得

curl --request GET \
  --url https://{deployed_api_base_url}/v2/messages \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{deployed_api_base_url}/v2/messages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{deployed_api_base_url}/v2/messages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{deployed_api_base_url}/v2/messages"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{deployed_api_base_url}/v2/messages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "limit": 20,
  "has_more": false,
  "data": [
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "conversation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "parent_message_id": "00000000-0000-0000-0000-000000000000",
      "inputs": {
        "order_id": "ORDER-1001"
      },
      "query": "Where is my refund now?",
      "answer": "Your refund is being processed by the bank.",
      "feedback": null,
      "retriever_resources": [],
      "created_at": 1787788860,
      "agent_thoughts": [],
      "message_files": [
        {
          "id": "a8098c1a-f86e-51da-bd1e-66d42f3f323a",
          "filename": "receipt.pdf",
          "type": "document",
          "url": "/v2/files/16fd2706-8baf-433b-82eb-8c7fada847da/preview?user=customer-001",
          "mime_type": "application/pdf",
          "size": 48231,
          "transfer_method": "local_file",
          "belongs_to": "user",
          "upload_file_id": "16fd2706-8baf-433b-82eb-8c7fada847da"
        }
      ],
      "message_tokens": 28,
      "answer_tokens": 19,
      "total_tokens": 47,
      "provider_response_latency": 0,
      "total_price": "0.0012",
      "currency": "USD",
      "status": "normal",
      "error": null,
      "extra_contents": []
    }
  ]
}

承認

Authorization

string

header

必須

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

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

クエリパラメータ

user

string

必須

エンドユーザーの識別子。アプリ側で定義し、アプリ内で一意にします。会話はアプリ、環境、この user の組み合わせに属します。後から読み取りや変更を行うときは、同じ値を送信してください。エンドユーザーの識別を参照してください。

Required string length: 1 - 255

conversation_id

string<uuid>

必須

読み取る会話の ID です。会話 ID は会話一覧を取得で取得します。

first_id

string<uuid>

ページネーションカーソルです。現在のページの最初のメッセージの id を指定します。渡すと前（より古い）ページを取得し、省略すると最新のメッセージを取得します。

limit

integer

デフォルト:20

リクエストごとに返すチャット履歴メッセージの数です。

必須範囲: 1 <= x <= 100

レスポンス

この会話のメッセージの 1 ページ分です。古い順に並びます。

limit

integer

このページに適用されたページサイズです。

has_more

boolean

さらに古いメッセージがあるかどうかです。

data

object[]

メッセージです。古いものから順に並びます。

Show child attributes

ガイド

アプリ API

ナレッジ API

会話履歴メッセージ一覧を取得

承認

クエリパラメータ

レスポンス