Skip to main content
POST
Error

Authorizations

X-API-Key
string
header
required
X-Tenant-Id
string
header
required

Query Parameters

upsert
boolean

Update an existing session with the same name

Body

application/json
type
enum<string>
required

Type identifies a tracing project, Agent tracing project, or experiment.

Available options:
PROJECT,
AGENT,
EXPERIMENT
default_dataset_id
string<uuid>
description
string
end_time
string<date-time>
evaluator_keys
string[]
extra
object
id
string<uuid>
kicked_off_by
string
longlived_ttl_days
integer | null

LonglivedTTLDays overrides long-lived trace retention. Null restores the workspace default.

name
string
num_examples
integer
num_repetitions
integer
reference_dataset_id
string<uuid>
start_time
string<date-time>
tag_value_ids
string[]
trace_tier
enum<string>
Available options:
LONG_LIVED,
SHORT_LIVED

Response

Existing session updated

TracerSession schema.

start_time
string<date-time>
required
name
string
required
id
string<uuid>
required
tenant_id
string<uuid>
required
type
enum<string>
required

PROJECT for a tracing project, AGENT for an Agent's tracing project, or EXPERIMENT for an evaluation run against a dataset.

Available options:
PROJECT,
AGENT,
EXPERIMENT
end_time
string<date-time> | null
extra
Extra · object | null
description
string | null
default_dataset_id
string<uuid> | null
reference_dataset_id
string<uuid> | null
trace_tier
enum<string> | null
Available options:
LONG_LIVED,
SHORT_LIVED
longlived_ttl_days
integer | null

Retention in days for traces while trace_tier is longlived. One of the deployment's allowed values (allowed_longlived_ttl_days in /info), up to the maximum of the deployment. The value is kept while trace_tier is shortlived. Null means the project uses the workspace retention.

run_count
integer | null
latency_p50
number | null
latency_p99
number | null
first_token_p50
number | null
first_token_p99
number | null
total_tokens
integer | null
prompt_tokens
integer | null
completion_tokens
integer | null
total_cost
number | null
prompt_cost
number | null
completion_cost
number | null
last_run_start_time
string<date-time> | null
last_run_start_time_live
string<date-time> | null
feedback_stats
Feedback Stats · object | null

Feedback on the session's runs, by feedback key.

session_feedback_stats
Session Feedback Stats · object | null

Feedback on the session itself, by feedback key.

run_facets
Run Facets · object[] | null
error_rate
number | null
streaming_rate
number | null
test_run_number
integer | null
experiment_progress
ExperimentProgress · object | null