Get Trace

GET /v2/projects/{project_id}/traces/{trace_id}

Get Trace

cURL

curl --request GET \
  --url https://api.galileo.ai/v2/projects/{project_id}/traces/{trace_id} \
  --header 'Galileo-API-Key: <api-key>'

import requests

url = "https://api.galileo.ai/v2/projects/{project_id}/traces/{trace_id}"

headers = {"Galileo-API-Key": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'Galileo-API-Key': '<api-key>'}};

fetch('https://api.galileo.ai/v2/projects/{project_id}/traces/{trace_id}', 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.galileo.ai/v2/projects/{project_id}/traces/{trace_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Galileo-API-Key: <api-key>"
  ],
]);

$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.galileo.ai/v2/projects/{project_id}/traces/{trace_id}"

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

	req.Header.Add("Galileo-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.galileo.ai/v2/projects/{project_id}/traces/{trace_id}")
  .header("Galileo-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.galileo.ai/v2/projects/{project_id}/traces/{trace_id}")

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

request = Net::HTTP::Get.new(url)
request["Galileo-API-Key"] = '<api-key>'

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

200

{
  "id": "<string>",
  "session_id": "<string>",
  "trace_id": "<string>",
  "project_id": "<string>",
  "run_id": "<string>",
  "spans": [
    {
      "id": "<string>",
      "session_id": "<string>",
      "project_id": "<string>",
      "run_id": "<string>",
      "parent_id": "<string>",
      "spans": "<array>",
      "type": "agent",
      "input": "",
      "redacted_input": "<string>",
      "output": "<string>",
      "redacted_output": "<string>",
      "name": "",
      "created_at": "2023-11-07T05:31:56Z",
      "user_metadata": {},
      "tags": [
        "<string>"
      ],
      "status_code": 123,
      "metrics": {
        "duration_ns": 123
      },
      "external_id": "<string>",
      "dataset_input": "<string>",
      "dataset_output": "<string>",
      "dataset_metadata": {},
      "trace_id": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "has_children": true,
      "metrics_batch_id": "<string>",
      "session_batch_id": "<string>",
      "feedback_rating_info": {},
      "annotations": {},
      "file_ids": [
        "<string>"
      ],
      "file_modalities": [],
      "annotation_aggregates": {},
      "annotation_agreement": {},
      "overall_annotation_agreement": 123,
      "annotation_queue_ids": [
        "<string>"
      ],
      "fully_annotated": true,
      "progress_message": "",
      "error_message": "",
      "metric_info": {},
      "files": {},
      "is_complete": true,
      "step_number": 123,
      "agent_type": "default"
    }
  ],
  "type": "trace",
  "input": "",
  "redacted_input": "<string>",
  "output": "<string>",
  "redacted_output": "<string>",
  "name": "",
  "created_at": "2023-11-07T05:31:56Z",
  "user_metadata": {},
  "tags": [
    "<string>"
  ],
  "status_code": 123,
  "metrics": {
    "duration_ns": 123
  },
  "external_id": "<string>",
  "dataset_input": "<string>",
  "dataset_output": "<string>",
  "dataset_metadata": {},
  "updated_at": "2023-11-07T05:31:56Z",
  "has_children": true,
  "metrics_batch_id": "<string>",
  "session_batch_id": "<string>",
  "feedback_rating_info": {},
  "annotations": {},
  "file_ids": [
    "<string>"
  ],
  "file_modalities": [],
  "annotation_aggregates": {},
  "annotation_agreement": {},
  "overall_annotation_agreement": 123,
  "annotation_queue_ids": [
    "<string>"
  ],
  "fully_annotated": true,
  "progress_message": "",
  "error_message": "",
  "metric_info": {},
  "files": {},
  "is_complete": true,
  "num_spans": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

ClassicAPIKeyHeaderAPIKeyHeaderOAuth2PasswordBearerHTTPBasic

Galileo-API-Key · string · header · required

Path Parameters

trace_id · string<uuid4> · required

project_id · string<uuid4> · required

Query Parameters

include_presigned_urls · boolean · default: false

Response

200

application/json

Successful Response

ExtendedTraceRecordWithChildren

StubTraceRecord

id · string<uuid4> · required

Galileo ID of the trace

session_id · string<uuid4> · required

Galileo ID of the session containing the trace (or the same value as id for a trace)

trace_id · string<uuid4> · required

Galileo ID of the trace containing the span (or the same value as id for a trace)

project_id · string<uuid4> · required

Galileo ID of the project associated with this trace or span

run_id · string<uuid4> · required

Galileo ID of the run (log stream or experiment) associated with this trace or span

spans · (ExtendedAgentSpanRecordWithChildren · object | ExtendedWorkflowSpanRecordWithChildren · object | ExtendedLlmSpanRecord · object | ExtendedToolSpanRecordWithChildren · object | ExtendedRetrieverSpanRecordWithChildren · object | ExtendedControlSpanRecord · object)[]

ExtendedAgentSpanRecordWithChildren

ExtendedWorkflowSpanRecordWithChildren

ExtendedLlmSpanRecord

ExtendedToolSpanRecordWithChildren

ExtendedRetrieverSpanRecordWithChildren

ExtendedControlSpanRecord

Show child attributes

type · string · default: trace

Type of the trace, span or session.

Allowed value: "trace"

input · string (TextContentPart · object | FileContentPart · object)[] · default: ""

Input to the trace or span.

redacted_input · string (TextContentPart · object | FileContentPart · object)[]

Redacted input of the trace or span.

output · string (TextContentPart · object | FileContentPart · object)[]

Output of the trace or span.

redacted_output · string (TextContentPart · object | FileContentPart · object)[]

Redacted output of the trace or span.

name · string · default: ""

Name of the trace, span or session.

created_at · string<date-time>

Timestamp of the trace or span's creation.

user_metadata · User Metadata · object

Metadata associated with this trace or span.

Show child attributes

tags · string[]

Tags associated with this trace or span.

status_code · integer | null

Status code of the trace or span. Used for logging failure or error states.

metrics · Metrics · object

Metrics associated with this trace or span.

Show child attributes

external_id · string | null

A user-provided session, trace or span ID.

dataset_input · string | null

Input to the dataset associated with this trace

dataset_output · string | null

Output from the dataset associated with this trace

dataset_metadata · Dataset Metadata · object

Metadata from the dataset associated with this trace

Show child attributes

updated_at · string<date-time> | null

Timestamp of the session or trace or span's last update

has_children · boolean | null

Whether or not this trace or span has child spans

metrics_batch_id · string<uuid4> | null

Galileo ID of the metrics batch associated with this trace or span

session_batch_id · string<uuid4> | null

Galileo ID of the metrics batch associated with this trace or span

feedback_rating_info · Feedback Rating Info · object

Feedback information related to the record

Show child attributes

annotations · Annotations · object

Annotations keyed by template ID and annotator ID

Show child attributes

file_ids · string<uuid4>[]

IDs of files associated with this record

file_modalities · enum<string>[]

Modalities of files associated with this record

Classification of content modality

Available options: text, document, image, audio, video

annotation_aggregates · Annotation Aggregates · object

Annotation aggregate information keyed by template ID

Show child attributes

annotation_agreement · Annotation Agreement · object

Annotation agreement scores keyed by template ID

Show child attributes

overall_annotation_agreement · number | null

Average annotation agreement across all templates in the queue

annotation_queue_ids · string<uuid4>[]

IDs of annotation queues this record is in

fully_annotated · boolean | null

Whether every field is annotated by every annotator in the queue

progress_message · string · default: ""

Runner progress text written directly to CH span

error_message · string · default: ""

Runner error text written directly to CH span

metric_info · Metric Info · object | null

Detailed information about the metrics associated with this trace or span

Show child attributes

files · Files · object | null

File metadata keyed by file ID for files associated with this record

Show child attributes

is_complete · boolean · default: true

Whether the trace is complete or not

num_spans · integer | null