Skip to main content
GET
/
{slug}
/
tuning-sessions
/
{session_id}
Get tuning session by ID
curl --request GET \
  --url https://api.dimred.com/api/v2/{slug}/tuning-sessions/{session_id} \
  --header 'X-API-Key: <api-key>'
{
  "session_id": "<string>",
  "project_id": "<string>",
  "project_name": "<string>",
  "dataset_id": "<string>",
  "dataset_name": "<string>",
  "initial_prompt_id": "<string>",
  "model_name": "<string>",
  "provider": "<string>",
  "target_metric_name": "<string>",
  "target_metric_value": 123,
  "target_metric_id": "<string>",
  "best_metric_value": 123,
  "target_metric": {
    "metric_id": "<string>",
    "metric_name": "<string>",
    "description": "<string>"
  },
  "max_iterations": 123,
  "status": "queued",
  "task_id": "<string>",
  "config": {},
  "metrics": {},
  "error_message": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication

Path Parameters

​
session_id
string
required

ID of the tuning session

Response

200 - application/json

Tuning session retrieved successfully

​
session_id
string
required

Unique identifier for the tuning session

​
project_id
string
required

Identifier for the project the session belongs to

​
model_name
string
required

Name of the model used for tuning

​
provider
string
required

Provider for the model

​
status
enum<string>
required

Current status of the tuning session

Available options:
queued,
pending,
in_progress,
completed,
failed,
cancelled
​
created_at
string<date-time>
required

Timestamp when the session was created

​
updated_at
string<date-time>
required

Timestamp when the session was last updated

​
project_name
string

Name of the project

​
dataset_id
string

Identifier for the dataset used in tuning

​
dataset_name
string

Name of the dataset used in tuning

​
initial_prompt_id
string

Identifier for the initial prompt

​
target_metric_name
string

Name of the target metric

​
target_metric_value
number

Target value for the metric

​
target_metric_id
string

ID of the target metric

​
best_metric_value
number

Best achieved metric value from tuning

​
target_metric
object

Target metric information

​
max_iterations
integer

Maximum number of tuning iterations

​
task_id
string

Celery task identifier for tracking background processing

​
config
object

Configuration parameters used for tuning

​
metrics
object

Results and metrics from the tuning process

​
error_message
string

Error message if the session failed

​
started_at
string<date-time>

Timestamp when processing started

​
completed_at
string<date-time>

Timestamp when processing completed

⌘I