会話一覧を取得

対象アプリ：Chatflow、新しい Agent、チャットボット、Agent。

エンドユーザーの会話を、最近アクティブな順に一覧表示します。

GET /conversations

会話一覧を取得

cURL

curl --request GET \
  --url https://{api_base_url}/conversations \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/conversations"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://{api_base_url}/conversations', 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://{api_base_url}/conversations",
  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://{api_base_url}/conversations"

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

}

HttpResponse<String> response = Unirest.get("https://{api_base_url}/conversations")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/conversations")

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

200

{
  "limit": 20,
  "has_more": false,
  "data": [
    {
      "id": "45701982-8118-4bc5-8e9b-64562b4555f2",
      "name": "iPhone Specs Chat",
      "inputs": {
        "city": "San Francisco"
      },
      "status": "normal",
      "introduction": "Welcome! How can I help you today?",
      "created_at": 1705407629,
      "updated_at": 1705411229
    }
  ]
}

{
  "status": 400,
  "code": "not_chat_app",
  "message": "Please check if your app mode matches the right API route."
}

{
  "status": 404,
  "code": "not_found",
  "message": "Last Conversation Not Exists."
}

Authorizations

Authorization · string · header · required

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

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

Query Parameters

user · string

エンドユーザーの識別子。アプリ側で定義し、アプリ内で一意にします。エンドユーザーの識別 を参照してください。

last_id · string

ページネーションカーソルです。現在のページの最後の会話の id を指定します。省略すると最初のページを取得します。

limit · integer · default: 20

返すレコード数です。

Required range: 1 <= x <= 100

sort_by · enum<string> · default: -updated_at

並べ替えるフィールドです。降順にするには - を先頭に付けます。

Available options: created_at, -created_at, updated_at, -updated_at

Response

200

application/json

会話リストの取得に成功しました。

limit · integer

1 ページあたりの件数です。

has_more · boolean

さらに会話があるかどうかです。

data · object[]

会話のリストです。

Show child attributes