Genai Conversation Chat

POST /agents/conversations/chat

Genai Conversation Chat

cURL

curl --request POST \
  --url https://api.example.com/agents/conversations/chat \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "conversation_id": "<string>",
  "limit": 50,
  "offset": 0,
  "include_feedback": false
}
'

import requests

url = "https://api.example.com/agents/conversations/chat"

payload = {
    "project_id": "<string>",
    "conversation_id": "<string>",
    "limit": 50,
    "offset": 0,
    "include_feedback": False
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    project_id: '<string>',
    conversation_id: '<string>',
    limit: 50,
    offset: 0,
    include_feedback: false
  })
};

fetch('https://api.example.com/agents/conversations/chat', 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.example.com/agents/conversations/chat",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'project_id' => '<string>',
    'conversation_id' => '<string>',
    'limit' => 50,
    'offset' => 0,
    'include_feedback' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.example.com/agents/conversations/chat"

	payload := strings.NewReader("{\n  \"project_id\": \"<string>\",\n  \"conversation_id\": \"<string>\",\n  \"limit\": 50,\n  \"offset\": 0,\n  \"include_feedback\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/agents/conversations/chat")
  .header("Content-Type", "application/json")
  .body("{\n  \"project_id\": \"<string>\",\n  \"conversation_id\": \"<string>\",\n  \"limit\": 50,\n  \"offset\": 0,\n  \"include_feedback\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/agents/conversations/chat")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"project_id\": \"<string>\",\n  \"conversation_id\": \"<string>\",\n  \"limit\": 50,\n  \"offset\": 0,\n  \"include_feedback\": false\n}"

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

200

{
  "conversation_id": "<string>",
  "turns": [
    {
      "trace_id": "<string>",
      "root_span_name": "<string>",
      "agent_name": "<string>",
      "agent_version": "<string>",
      "provider": "<string>",
      "total_duration_ms": 123,
      "total_cost_usd": 123,
      "messages": [
        {
          "span_id": "<string>",
          "agent_name": "<string>",
          "agent_version": "<string>",
          "started_at": "2023-11-07T05:31:56Z",
          "user_message": {
            "text": "<string>",
            "content_refs": [
              "<string>"
            ]
          },
          "assistant_message": {
            "text": "<string>",
            "model": "<string>",
            "reasoning_content": "<string>",
            "reasoning_tokens": 123,
            "input_tokens": 123,
            "output_tokens": 123,
            "input_cost_usd": 123,
            "output_cost_usd": 123,
            "total_cost_usd": 123,
            "duration_ms": 123,
            "content_refs": [
              "<string>"
            ]
          },
          "tool_call": {
            "tool_name": "<string>",
            "tool_arguments": "<string>",
            "tool_result": "<string>",
            "duration_ms": 123,
            "content_refs": [
              "<string>"
            ]
          },
          "agent_start": {
            "model": "<string>",
            "system_instructions": "<string>",
            "tool_definitions": "<string>"
          },
          "agent_handoff": {},
          "context_compacted": {
            "compaction_summary": "<string>",
            "compaction_items_before": 123,
            "compaction_items_after": 123
          },
          "feedback": [
            {}
          ]
        }
      ],
      "feedback": [
        {}
      ]
    }
  ],
  "total_turns": 0,
  "has_more": false,
  "limit": 50,
  "offset": 0,
  "total_cost_usd": 123,
  "feedback": [
    {}
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Body

application/json

Request to get the multi-turn chat view for a conversation.

project_id · string · required

conversation_id · string · required

limit · integer · default: 50

Maximum number of conversation turns to return.

Required range: 0 <= x <= 50

offset · integer · default: 0

Number of most-recent turns to skip. Results are returned in chronological order within the selected page.

Required range: x >= 0

include_feedback · boolean · default: false

Response

200

application/json

Successful Response

Multi-turn chat view: an ordered list of per-turn chat responses.

Each entry in turns corresponds to one trace_id, which Weave treats as one conversation turn. This is not necessarily one invoke_agent span: a turn can contain zero, one, or many agent invocations. The frontend can render turn-number dividers between entries and still reuse AgentTraceChatRes rendering for each individual turn.

conversation_id · string · required

turns · AgentTraceChatRes · object[]

Show child attributes

total_turns · integer · default: 0

has_more · boolean · default: false

limit · integer · default: 50

offset · integer · default: 0

total_cost_usd · number | null

feedback · Feedback · object[] | null