widgets

Get a widget conversation

One visitor conversation with its messages, citations, cost, duration and the visitor's thumb and comment on each answer: the same as GET /v1/logs/conversations/{conversation_id}, for a conversation of this widget.

GET/v1/widgets/{widget_id}/conversations/{conversation_id}

Request

curl --request GET \
  --url 'https://api.lookio.app/v1/widgets/<widget_id>/conversations/<conversation_id>' \
  --header 'Authorization: <api-key>'

import json
import requests

url = "https://api.lookio.app/v1/widgets/<widget_id>/conversations/<conversation_id>"
headers = {
  "Authorization": "<api-key>"
}

response = requests.request("GET", url, headers=headers)
print(response.json())

const response = await fetch("https://api.lookio.app/v1/widgets/<widget_id>/conversations/<conversation_id>", {
  method: "GET",
  headers: {
    "Authorization": "<api-key>"
  },
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://api.lookio.app/v1/widgets/<widget_id>/conversations/<conversation_id>");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
]);
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

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

func main() {
  req, _ := http.NewRequest("GET", "https://api.lookio.app/v1/widgets/<widget_id>/conversations/<conversation_id>", nil)
  req.Header.Set("Authorization", "<api-key>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://api.lookio.app/v1/widgets/<widget_id>/conversations/<conversation_id>"))
    .header("Authorization", "<api-key>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://api.lookio.app/v1/widgets/<widget_id>/conversations/<conversation_id>")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "<api-key>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "id": "<string>",
    "channel": "widget",
    "title": "<string>",
    "assistant": {
      "id": "<string>",
      "name": null
    },
    "widget": {
      "id": "<string>",
      "name": "<string>"
    },
    "api_key": {
      "id": "<string>",
      "name": null
    },
    "end_user": null,
    "message_count": 123,
    "credits": 123,
    "thumbs_up": 123,
    "thumbs_down": 123,
    "created_at": "<string>",
    "updated_at": "<string>",
    "locked": true,
    "messages": [
      {
        "id": "<string>",
        "role": "user",
        "content": "<string>",
        "citations": [
          {
            "resource_id": "<string>",
            "title": "<string>",
            "text": "<string>",
            "n": 123,
            "section": [
              "<string>"
            ],
            "page": 123,
            "url": "<string>",
            "source": "<string>"
          }
        ],
        "credit_cost": 123,
        "mode": null,
        "duration_ms": 123,
        "rating": "up",
        "rating_comment": null,
        "created_at": "<string>"
      }
    ]
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

Requires assistants:write.

This is Retrieve a logged conversation for a conversation of this widget. Each answer carries the citations it relied on, what it cost, the visitor’s thumb and their comment, whatever the widget’s sources mode: the mode only decides what visitors see, not what you can review here.

Find a conversation’s id with List a widget’s conversations.

Authorizations

Authorizationbearerin headerrequired

Path parameters

widget_idstringrequiredpattern: ^wdg_[abcdefghjkmnpqrstuvwxyz23456789]{12}$

conversation_idstringrequiredpattern: ^cnv_[abcdefghjkmnpqrstuvwxyz23456789]{12}$

Response

application/json

Retrieve a widget conversation

dataobjectrequired

Show child attributes

data.idstringrequiredpattern: ^cnv_[abcdefghjkmnpqrstuvwxyz23456789]{12}$

data.channelenum<string>requiredone of: widget, api, mcp

widget: a visitor on your website. api: an API key through REST, the CLI or the SDK. mcp: an API key through the MCP server.

data.titlestringrequired

The first question.

data.assistantobjectrequired

Show child attributes

data.assistant.idstringrequired

data.assistant.namestringnullrequired

Null when the assistant was deleted.

data.widgetobject | nullrequired

The widget, for the widget channel.

Show child attributes

data.widget.idstringrequired

data.widget.namestringrequired

data.api_keyobject | nullrequired

The API key, for the api and mcp channels.

Show child attributes

data.api_key.idstringrequired

data.api_key.namestringnullrequired

Null once the key is deleted.

data.end_userstringnullrequired

Who was asking: a widget visitor's random id, or the end_user the product sent. Null when an API key sent none.

data.message_countintegerrequired

Questions and answers together.

data.creditsintegerrequired

What this conversation's answers cost.

data.thumbs_upintegerrequired

data.thumbs_downintegerrequired

data.created_atstringrequired

data.updated_atstringrequired

The last activity. Conversations are listed by it, latest first.

data.lockedbooleanrequired

Older than the plan keeps conversations readable (7 days on Free, 90 on Starter, 1 year on Pro, from the last activity). Its text is hidden, not yet deleted: title is then a date and messages is empty, and a higher plan shows it again.

data.messagesobject[]required

Show child attributes

data.messages.idstringrequired

data.messages.roleenum<string>requiredone of: user, assistant

data.messages.contentstringrequired

data.messages.citationsobject[]required

The passages the answer relied on.

Show child attributes

data.messages.citations.resource_idstringrequired

The cited resource. Empty for a public assistant of another workspace: its resources stay its own.

data.messages.citations.titlestringrequired

data.messages.citations.textstringrequired

The passage the answer relies on.

data.messages.citations.ninteger

The number the answer cites it by, as [1].

data.messages.citations.sectionstring[]

data.messages.citations.pageinteger

data.messages.citations.urlstring

data.messages.citations.sourcestring

The cited resource's source, when it has one.

data.messages.credit_costinteger | nullrequired

Answers only: what it cost.

data.messages.modestringnullrequired

Answers only: the query mode.

data.messages.duration_msinteger | nullrequired

Answers only: how long it took to write.

data.messages.ratingenum<string> | nullrequired

The thumb on an answer, from the visitor or forwarded by your product.

data.messages.rating_commentstringnullrequired

data.messages.created_atstringrequired

request_idstringrequired

Get a widget conversation

Authorizations

Path parameters

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown