Skip to main content
POST
/
{slug}
/
prompts
/
prompt_tuning_v2
Start parallelized prompt tuning v2
curl --request POST \
  --url https://api.dimred.com/api/v2/{slug}/prompts/prompt_tuning_v2 \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "project_id": "<string>",
  "dataset_id": "<string>",
  "initial_prompt_id": "<string>",
  "model_name": "<string>",
  "provider": "openai",
  "target_metric_value": 0.5,
  "target_metric": {
    "metric_id": "<string>",
    "metric_name": "<string>",
    "description": "<string>"
  },
  "max_iterations": 123,
  "config": {},
  "org_id": "<string>",
  "target_customer_org_id": "<string>",
  "project_name": "<string>",
  "dataset_size": 123
}'
{
  "tuning_session_id": "<string>",
  "task_id": "<string>",
  "status": "pending",
  "workflow_type": "<string>"
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

slug
string
required

Organization slug

Body

application/json
project_id
string
required

Project identifier

initial_prompt_id
string
required

Prompt to start tuning from

model_name
string
required

LLM model name

provider
enum<string>
required

LLM provider name

Available options:
openai,
anthropic,
openrouter
target_metric_value
number
required

Desired threshold for metric

Required range: 0 <= x <= 1
target_metric
object
required

Target metric information

max_iterations
integer
required

Maximum tuning iterations

dataset_id
string

Dataset to evaluate against

config
object

Additional configuration data for tuning

org_id
string

Organization ID

target_customer_org_id
string

Customer org ID (admin only)

project_name
string

Project name (optional)

dataset_size
integer

Number of data points in the dataset

Response

202 - application/json

Prompt tuning workflow started successfully

tuning_session_id
string
required

Tracking ID for tuning session

task_id
string
required

Celery task ID for monitoring

status
enum<string>
default:pending
required

Job status

Available options:
pending,
queued
workflow_type
string

Type of workflow used

I