Skip to main content
Opik Documentation

Search documentation

Type to search this documentation.

Get span by id

GET/v1/private/spans/{id}Get span by id

Get span by id

Parameters

idstring · uuidpathrequired
strip_attachmentsbooleanquery

If true, returns attachment references like [file.png]; if false, downloads and reinjects attachment content from S3 (default: false for backward compatibility)

default false

Responses

200Span resourceapplication/json
objectSpan_Public
commentsarray of object
Show child attributes
Show array items
created_atstring · date-time
created_bystring
idstring · uuid
last_updated_atstring · date-time
last_updated_bystring
source_queue_idstring · uuid
textstringrequired

minLength 1

created_atstring · date-time
created_bystring
durationnumber · double

Duration in milliseconds as a decimal number to support sub-millisecond precision

end_timestring · date-time
environmentstring

maxLength 150 · minLength 0

error_infoobject
Show child attributes
exception_typestringrequired

minLength 1

messagestring
tracebackstringrequired

minLength 1

feedback_scoresarray of object
Show child attributes
Show array items

Aggregated feedback scores from all spans in this trace, averaged by score name

category_namestring
created_atstring · date-time
created_bystring
last_updated_atstring · date-time
last_updated_bystring
namestringrequired

minLength 1

reasonstring
sourcestringrequired

one of "ui", "sdk", "online_scoring"

source_queue_idstring · uuid
valuenumberrequired

maximum 1000000000 · minimum -1000000000

value_by_authorobject
idstring · uuid
inputobject
Show child attributes
anyOf · 3 options
Option 1object
Option 2array of object
Option 3string
last_updated_atstring · date-time
last_updated_bystring
metadataobjectJsonListString_Public ↑
modelstring
namestring
outputobjectJsonListString_Public ↑
parent_span_idstring · uuid
project_idstring · uuid
project_namestring

If null, the default project is used

pattern (?s)^\s*(\S.*\S|\S)\s*$

providerstring
sourcestring

one of "sdk", "experiment", "playground", "optimization", "evaluator"

start_timestring · date-timerequired
tagsarray of string

uniqueItems true

Show child attributes

uniqueItems true

total_estimated_costnumber

minimum 0

total_estimated_cost_versionstring
trace_idstring · uuid
ttftnumber · double

Time to first token in milliseconds

typestring

one of "general", "tool", "llm", "guardrail"

usageobject
Example response
{
  "comments": [
    {
      "created_at": "2026-06-09T00:00:00Z",
      "created_by": "string",
      "id": "00000000-0000-0000-0000-000000000000",
      "last_updated_at": "2026-06-09T00:00:00Z",
      "last_updated_by": "string",
      "source_queue_id": "00000000-0000-0000-0000-000000000000",
      "text": "string"
    }
  ],
  "created_at": "2026-06-09T00:00:00Z",
  "created_by": "string",
  "duration": 0,
  "end_time": "2026-06-09T00:00:00Z",
  "environment": "string",
  "error_info": {
    "exception_type": "string",
    "message": "string",
    "traceback": "string"
  },
  "feedback_scores": [
    {
      "category_name": "string",
      "created_at": "2026-06-09T00:00:00Z",
      "created_by": "string",
      "last_updated_at": "2026-06-09T00:00:00Z",
      "last_updated_by": "string",
      "name": "string",
      "reason": "string",
      "source": "online_scoring",
      "source_queue_id": "00000000-0000-0000-0000-000000000000",
      "value": 0,
      "value_by_author": {
        "additionalProp1": {
          "author": "string",
          "category_name": "string",
          "last_updated_at": "2026-06-09T00:00:00Z",
          "reason": "string",
          "source": "online_scoring",
          "source_queue_id": "string",
          "span_id": "string",
          "span_type": "string",
          "value": 0
        }
      }
    }
  ],
  "id": "00000000-0000-0000-0000-000000000000",
  "input": [
    {}
  ],
  "last_updated_at": "2026-06-09T00:00:00Z",
  "last_updated_by": "string",
  "metadata": [
    {}
  ],
  "model": "string",
  "name": "string",
  "output": [
    {}
  ],
  "parent_span_id": "00000000-0000-0000-0000-000000000000",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "project_name": "string",
  "provider": "string",
  "source": "evaluator",
  "start_time": "2026-06-09T00:00:00Z",
  "tags": [
    "string"
  ],
  "total_estimated_cost": 0,
  "total_estimated_cost_version": "string",
  "trace_id": "00000000-0000-0000-0000-000000000000",
  "ttft": 0,
  "type": "general",
  "usage": {
    "additionalProp1": 0
  }
}
404Not foundapplication/json
objectSpan_Public
commentsarray of object
Show child attributes

Items: Comment_Public ↑

created_atstring · date-time
created_bystring
durationnumber · double

Duration in milliseconds as a decimal number to support sub-millisecond precision

end_timestring · date-time
environmentstring

maxLength 150 · minLength 0

error_infoobjectErrorInfo_Public ↑
feedback_scoresarray of object
Show child attributes

Items: FeedbackScore_Public ↑

idstring · uuid
inputobjectJsonListString_Public ↑
last_updated_atstring · date-time
last_updated_bystring
metadataobjectJsonListString_Public ↑
modelstring
namestring
outputobjectJsonListString_Public ↑
parent_span_idstring · uuid
project_idstring · uuid
project_namestring

If null, the default project is used

pattern (?s)^\s*(\S.*\S|\S)\s*$

providerstring
sourcestring

one of "sdk", "experiment", "playground", "optimization", "evaluator"

start_timestring · date-timerequired
tagsarray of string

uniqueItems true

Show child attributes

uniqueItems true

total_estimated_costnumber

minimum 0

total_estimated_cost_versionstring
trace_idstring · uuid
ttftnumber · double

Time to first token in milliseconds

typestring

one of "general", "tool", "llm", "guardrail"

usageobject
Example response
{
  "comments": [
    {
      "created_at": "2026-06-09T00:00:00Z",
      "created_by": "string",
      "id": "00000000-0000-0000-0000-000000000000",
      "last_updated_at": "2026-06-09T00:00:00Z",
      "last_updated_by": "string",
      "source_queue_id": "00000000-0000-0000-0000-000000000000",
      "text": "string"
    }
  ],
  "created_at": "2026-06-09T00:00:00Z",
  "created_by": "string",
  "duration": 0,
  "end_time": "2026-06-09T00:00:00Z",
  "environment": "string",
  "error_info": {
    "exception_type": "string",
    "message": "string",
    "traceback": "string"
  },
  "feedback_scores": [
    {
      "category_name": "string",
      "created_at": "2026-06-09T00:00:00Z",
      "created_by": "string",
      "last_updated_at": "2026-06-09T00:00:00Z",
      "last_updated_by": "string",
      "name": "string",
      "reason": "string",
      "source": "online_scoring",
      "source_queue_id": "00000000-0000-0000-0000-000000000000",
      "value": 0,
      "value_by_author": {
        "additionalProp1": {
          "author": "string",
          "category_name": "string",
          "last_updated_at": "2026-06-09T00:00:00Z",
          "reason": "string",
          "source": "online_scoring",
          "source_queue_id": "string",
          "span_id": "string",
          "span_type": "string",
          "value": 0
        }
      }
    }
  ],
  "id": "00000000-0000-0000-0000-000000000000",
  "input": [
    {}
  ],
  "last_updated_at": "2026-06-09T00:00:00Z",
  "last_updated_by": "string",
  "metadata": [
    {}
  ],
  "model": "string",
  "name": "string",
  "output": [
    {}
  ],
  "parent_span_id": "00000000-0000-0000-0000-000000000000",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "project_name": "string",
  "provider": "string",
  "source": "evaluator",
  "start_time": "2026-06-09T00:00:00Z",
  "tags": [
    "string"
  ],
  "total_estimated_cost": 0,
  "total_estimated_cost_version": "string",
  "trace_id": "00000000-0000-0000-0000-000000000000",
  "ttft": 0,
  "type": "general",
  "usage": {
    "additionalProp1": 0
  }
}
Documentation menu