Read a conversation transcript

Read the transcript

curl --request GET \
  --url https://api.onecli.sh/v1/conversations/{conversationId}/events \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.onecli.sh/v1/conversations/{conversationId}/events"

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

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

print(response.text)

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

fetch('https://api.onecli.sh/v1/conversations/{conversationId}/events', 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.onecli.sh/v1/conversations/{conversationId}/events",
  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.onecli.sh/v1/conversations/{conversationId}/events"

	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://api.onecli.sh/v1/conversations/{conversationId}/events")

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

{
  "events": [
    {
      "seq": 123,
      "turnId": "<string>",
      "type": "<string>",
      "payload": {}
    }
  ],
  "nextSince": 123,
  "hasMore": true
}

{
  "error": "<string>"
}

GET

conversations

{conversationId}

events

Read the transcript

curl --request GET \
  --url https://api.onecli.sh/v1/conversations/{conversationId}/events \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.onecli.sh/v1/conversations/{conversationId}/events"

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

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

print(response.text)

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

fetch('https://api.onecli.sh/v1/conversations/{conversationId}/events', 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.onecli.sh/v1/conversations/{conversationId}/events",
  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.onecli.sh/v1/conversations/{conversationId}/events"

	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://api.onecli.sh/v1/conversations/{conversationId}/events")

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

{
  "events": [
    {
      "seq": 123,
      "turnId": "<string>",
      "type": "<string>",
      "payload": {}
    }
  ],
  "nextSince": 123,
  "hasMore": true
}

{
  "error": "<string>"
}

Returns the conversation’s events by sequence number. Use it to rebuild a thread from scratch or catch up after a dropped stream, then continue from the cursor it returns. Related guide: Agent access: grant credentials to agents. The conversation’s event log — the source of truth every live stream reconciles against. Read since < seq <= until, at most limit events, and continue from nextSince.

Availability: Cloud · Community (self-hosted) · Enterprise (self-hosted)

Authorizations

Authorization

string

header

required

A workspace API key (oc_…) or organization API key (oc_org_…). Workspace-scoped endpoints called with an organization key also need X-Workspace-Id.

Path Parameters

conversationId

string

required

Query Parameters

since

integer

Required range: x >= 0

until

integer

Required range: x >= 0

limit

integer

default:200

Required range: 1 <= x <= 500

Response

A transcript page

events

object[]

Show child attributes

nextSince

integer

Pass as since to continue reading.

hasMore

boolean

Workspace

Organization

Enterprise

Platform

Read a conversation transcript

Authorizations

Path Parameters

Query Parameters

Response