Get all comments

curl --request GET \
  --url https://api.example.com/api/public/comments/{commentId}

const options = {method: 'GET'};

fetch('https://api.example.com/api/public/comments/{commentId}', 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/api/public/comments/{commentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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.example.com/api/public/comments/{commentId}"

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

	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.example.com/api/public/comments/{commentId}")

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

request = Net::HTTP::Get.new(url)

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

{
  "data": [
    {
      "id": "<string>",
      "projectId": "<string>",
      "createdAt": {},
      "updatedAt": {},
      "objectType": "<string>",
      "objectId": "<string>",
      "content": "<string>",
      "authorUserId": "<string>"
    }
  ],
  "meta": {
    "page": 123,
    "limit": 123,
    "totalItems": 123,
    "totalPages": 123
  }
}

GET

api

public

comments

{commentId}

Get all comments

curl --request GET \
  --url https://api.example.com/api/public/comments/{commentId}

const options = {method: 'GET'};

fetch('https://api.example.com/api/public/comments/{commentId}', 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/api/public/comments/{commentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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.example.com/api/public/comments/{commentId}"

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

	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.example.com/api/public/comments/{commentId}")

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

request = Net::HTTP::Get.new(url)

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

{
  "data": [
    {
      "id": "<string>",
      "projectId": "<string>",
      "createdAt": {},
      "updatedAt": {},
      "objectType": "<string>",
      "objectId": "<string>",
      "content": "<string>",
      "authorUserId": "<string>"
    }
  ],
  "meta": {
    "page": 123,
    "limit": 123,
    "totalItems": 123,
    "totalPages": 123
  }
}

Request Description

integer | null

Page number, starts at 1. Nullable if no pagination is required.

integer | null

Limit of items per page. Reduce size if API issues occur. Nullable if no limit is specified.

string | null

Filter comments by object type (e.g., trace, observation, session, prompt). Nullable if no filtering by object type is needed.

string | null

Filter comments by object ID. Required if objectType is provided; nullable otherwise.

string | null

Filter comments by the author user ID. Nullable if no filtering by author is needed.

Response Description

Below you will see the description of the get a list score response

array

Array of comment objects.

Show Comment Object

string

required

Unique identifier of the comment.

string

required

ID of the associated project.

date-time

required

Timestamp of when the comment was created (ISO 8601 format).

date-time

required

Timestamp of when the comment was last updated (ISO 8601 format).

string

required

Type of object the comment is associated with (e.g., TRACE, OBSERVATION).

string

required

ID of the object the comment is associated with.

string

required

The content of the comment.

string

required

ID of the user who authored the comment.

object

Metadata for pagination.

Show Meta Object

integer

required

Current page number.

integer

required

Number of items per page.

integer

required

Total number of items available.

integer

required

Total number of pages available.

Code Response

Exemples of Response Code

200 Successful Response Code
400 Error Response Code

​Response Description

​Code Response

Response Description

Code Response