Add span comment | Opik Documentation

POST/v1/private/spans/{id}/commentsAdd span comment

Add span comment

Parameters

idstring · uuidpathrequired

Request body

application/json

objectComment

created_atstring · date-time

created_bystring

idstring · uuid

last_updated_atstring · date-time

last_updated_bystring

source_queue_idstring · uuid

textstringrequired

minLength 1

Example request

{
  "source_queue_id": "00000000-0000-0000-0000-000000000000",
  "text": "string"
}

Responses

Headers

Location

Examples

idrequiredpath parameter

curl -X POST 'http://localhost:5173/api/v1/private/spans/00000000-0000-0000-0000-000000000000/comments' \
  -H 'Content-Type: application/json' \
  -d '{"source_queue_id":"00000000-0000-0000-0000-000000000000","text":"string"}'

const response = await fetch('http://localhost:5173/api/v1/private/spans/00000000-0000-0000-0000-000000000000/comments', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"source_queue_id":"00000000-0000-0000-0000-000000000000","text":"string"}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/spans/00000000-0000-0000-0000-000000000000/comments', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"source_queue_id\":\"00000000-0000-0000-0000-000000000000\",\"text\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/spans/00000000-0000-0000-0000-000000000000/comments",
    headers={"Content-Type": "application/json"},
    data='{"source_queue_id":"00000000-0000-0000-0000-000000000000","text":"string"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"source_queue_id":"00000000-0000-0000-0000-000000000000","text":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/spans/00000000-0000-0000-0000-000000000000/comments", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/spans/00000000-0000-0000-0000-000000000000/comments");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"source_queue_id\":\"00000000-0000-0000-0000-000000000000\",\"text\":\"string\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/spans/00000000-0000-0000-0000-000000000000/comments"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"source_queue_id\":\"00000000-0000-0000-0000-000000000000\",\"text\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/spans/00000000-0000-0000-0000-000000000000/comments")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"source_queue_id\":\"00000000-0000-0000-0000-000000000000\",\"text\":\"string\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:5173/api/v1/private/spans/00000000-0000-0000-0000-000000000000/comments");
request.Content = new StringContent("{\"source_queue_id\":\"00000000-0000-0000-0000-000000000000\",\"text\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 201)