Attachments list for entity | Opik Documentation

GET/v1/private/attachment/listAttachments list for entity

Attachments list for entity

Parameters

pageinteger · int32query

default 1 · minimum 1

sizeinteger · int32query

default 100 · minimum 1

project_idstring · uuidqueryrequired

entity_typestringqueryrequired

one of "trace", "span"

entity_idstring · uuidqueryrequired

pathstringqueryrequired

minLength 1

Responses

objectAttachmentPage

contentarray of object

Show child attributes

Show array items

file_namestringrequired

file_sizeinteger · int64required

linkstring

mime_typestringrequired

pageinteger · int32

sizeinteger · int32

sortableByarray of string

Show child attributes

totalinteger · int64

Example response

{
  "content": [
    {
      "file_name": "string",
      "file_size": 0,
      "link": "string",
      "mime_type": "string"
    }
  ],
  "page": 0,
  "size": 0,
  "sortableBy": [
    "string"
  ],
  "total": 0
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

Examples

pagequery parameter

sizequery parameter

project_idrequiredquery parameter

entity_typerequiredquery parameter

entity_idrequiredquery parameter

pathrequiredquery parameter

curl -X GET 'http://localhost:5173/api/v1/private/attachment/list?entity_id=00000000-0000-0000-0000-000000000000&entity_type=span&page=1&path=string&project_id=00000000-0000-0000-0000-000000000000&size=100'

const response = await fetch('http://localhost:5173/api/v1/private/attachment/list?entity_id=00000000-0000-0000-0000-000000000000&entity_type=span&page=1&path=string&project_id=00000000-0000-0000-0000-000000000000&size=100', { method: 'GET' });
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/attachment/list?entity_id=00000000-0000-0000-0000-000000000000&entity_type=span&page=1&path=string&project_id=00000000-0000-0000-0000-000000000000&size=100', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "http://localhost:5173/api/v1/private/attachment/list?entity_id=00000000-0000-0000-0000-000000000000&entity_type=span&page=1&path=string&project_id=00000000-0000-0000-0000-000000000000&size=100")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "http://localhost:5173/api/v1/private/attachment/list?entity_id=00000000-0000-0000-0000-000000000000&entity_type=span&page=1&path=string&project_id=00000000-0000-0000-0000-000000000000&size=100", nil)
	if err != nil {
		panic(err)
	}
	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/attachment/list?entity_id=00000000-0000-0000-0000-000000000000&entity_type=span&page=1&path=string&project_id=00000000-0000-0000-0000-000000000000&size=100");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/attachment/list?entity_id=00000000-0000-0000-0000-000000000000&entity_type=span&page=1&path=string&project_id=00000000-0000-0000-0000-000000000000&size=100"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/attachment/list?entity_id=00000000-0000-0000-0000-000000000000&entity_type=span&page=1&path=string&project_id=00000000-0000-0000-0000-000000000000&size=100")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
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.Get, "http://localhost:5173/api/v1/private/attachment/list?entity_id=00000000-0000-0000-0000-000000000000&entity_type=span&page=1&path=string&project_id=00000000-0000-0000-0000-000000000000&size=100");
using var response = await client.SendAsync(request);

{
  "content": [
    {
      "file_name": "string",
      "file_size": 0,
      "link": "string",
      "mime_type": "string"
    }
  ],
  "page": 0,
  "size": 0,
  "sortableBy": [
    "string"
  ],
  "total": 0
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}