Skip to main content
POST
/
v2
/
projects
/
{project_id}
/
experiments
Create Experiment
curl --request POST \
  --url https://api.galileo.ai/v2/projects/{project_id}/experiments \
  --header 'Content-Type: application/json' \
  --header 'Galileo-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "task_type": 16,
  "playground_id": "<string>",
  "prompt_template_version_id": "<string>",
  "dataset": {
    "dataset_id": "<string>",
    "version_index": 123
  },
  "playground_prompt_id": "<string>",
  "prompt_settings": {
    "logprobs": true,
    "top_logprobs": 5,
    "echo": false,
    "n": 1,
    "reasoning_effort": "medium",
    "verbosity": "medium",
    "deployment_name": "<string>",
    "model_alias": "GPT-4o",
    "temperature": 1,
    "max_tokens": 4096,
    "stop_sequences": [
      "<string>"
    ],
    "top_p": 1,
    "top_k": 40,
    "frequency_penalty": 0,
    "presence_penalty": 0,
    "tools": [
      {}
    ],
    "tool_choice": "<string>",
    "response_format": {},
    "known_models": [
      {
        "name": "<string>",
        "alias": "<string>",
        "integration": "openai",
        "user_role": "<string>",
        "assistant_role": "<string>",
        "system_supported": false,
        "alternative_names": [
          "<string>"
        ],
        "input_token_limit": 123,
        "output_token_limit": 123,
        "token_limit": 123,
        "output_price": 0,
        "input_price": 0,
        "cost_by": "tokens",
        "is_chat": false,
        "provides_log_probs": false,
        "formatting_tokens": 0,
        "response_prefix_tokens": 0,
        "api_version": "<string>",
        "params_map": {
          "model": "<string>",
          "temperature": "<string>",
          "max_tokens": "<string>",
          "stop_sequences": "<string>",
          "top_p": "<string>",
          "top_k": "<string>",
          "frequency_penalty": "<string>",
          "presence_penalty": "<string>",
          "echo": "<string>",
          "logprobs": "<string>",
          "top_logprobs": "<string>",
          "n": "<string>",
          "api_version": "<string>",
          "tools": "<string>",
          "tool_choice": "<string>",
          "response_format": "<string>",
          "reasoning_effort": "<string>",
          "verbosity": "<string>",
          "deployment_name": "<string>"
        },
        "output_map": {
          "response": "<string>",
          "token_count": "<string>",
          "input_token_count": "<string>",
          "output_token_count": "<string>",
          "completion_reason": "<string>"
        },
        "input_map": {
          "prompt": "<string>",
          "prefix": "",
          "suffix": ""
        }
      }
    ]
  },
  "scorers": [
    {
      "id": "<string>",
      "scorer_type": "llm",
      "model_name": "<string>",
      "num_judges": 123,
      "filters": [
        {
          "value": "<string>",
          "operator": "eq",
          "name": "node_name",
          "filter_type": "string",
          "case_sensitive": true
        }
      ],
      "scoreable_node_types": [
        "<string>"
      ],
      "cot_enabled": true,
      "output_type": "boolean",
      "input_type": "basic",
      "name": "<string>",
      "model_type": "slm",
      "scorer_version": {
        "id": "<string>",
        "version": 123,
        "scorer_id": "<string>",
        "generated_scorer": {
          "id": "<string>",
          "name": "<string>",
          "chain_poll_template": {
            "template": "<string>",
            "metric_system_prompt": "<string>",
            "metric_description": "<string>",
            "value_field_name": "rating",
            "explanation_field_name": "explanation",
            "metric_few_shot_examples": [
              {
                "generation_prompt_and_response": "<string>",
                "evaluating_response": "<string>"
              }
            ],
            "response_schema": {}
          },
          "instructions": "<string>",
          "user_prompt": "<string>"
        },
        "registered_scorer": {
          "id": "<string>",
          "name": "<string>",
          "score_type": "<string>"
        },
        "finetuned_scorer": {
          "id": "<string>",
          "name": "<string>",
          "lora_task_id": 123,
          "prompt": "<string>",
          "luna_input_type": "span",
          "luna_output_type": "float",
          "class_name_to_vocab_ix": {},
          "executor": "action_completion_luna"
        },
        "model_name": "<string>",
        "num_judges": 123,
        "scoreable_node_types": [
          "<string>"
        ],
        "cot_enabled": true,
        "output_type": "boolean",
        "input_type": "basic"
      }
    }
  ],
  "trigger": false
}
'
{
  "id": "<string>",
  "project_id": "<string>",
  "task_type": 0,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "",
  "created_by": "<string>",
  "created_by_user": {
    "id": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>"
  },
  "num_spans": 123,
  "num_traces": 123,
  "dataset": {
    "dataset_id": "<string>",
    "version_index": 123,
    "name": "<string>"
  },
  "aggregate_metrics": {},
  "aggregate_feedback": {},
  "ranking_score": 123,
  "rank": 123,
  "winner": true,
  "playground_id": "<string>",
  "playground": {
    "playground_id": "<string>",
    "name": "<string>"
  },
  "prompt_run_settings": {
    "logprobs": true,
    "top_logprobs": 5,
    "echo": false,
    "n": 1,
    "reasoning_effort": "medium",
    "verbosity": "medium",
    "deployment_name": "<string>",
    "model_alias": "GPT-4o",
    "temperature": 1,
    "max_tokens": 4096,
    "stop_sequences": [
      "<string>"
    ],
    "top_p": 1,
    "top_k": 40,
    "frequency_penalty": 0,
    "presence_penalty": 0,
    "tools": "<string>",
    "tool_choice": "<string>",
    "response_format": {}
  },
  "prompt_model": "<string>",
  "prompt": {
    "prompt_template_id": "<string>",
    "version_index": 123,
    "name": "<string>",
    "content": "<string>"
  },
  "tags": {},
  "status": {
    "log_generation": {
      "progress_percent": 0
    }
  }
}

Authorizations

Galileo-API-Key
string
header
required

Path Parameters

project_id
string<uuid4>
required

Body

application/json
name
string
required
Minimum string length: 1
task_type
default:16
playground_id
string<uuid4> | null
prompt_template_version_id
string<uuid4> | null
dataset
ExperimentDatasetRequest · object
playground_prompt_id
string<uuid4> | null
prompt_settings
PromptRunSettings · object

Prompt run settings.

scorers
ScorerConfig · object[]
trigger
boolean
default:false

Response

Successful Response

id
string<uuid4>
required

Galileo ID of the experiment

project_id
string<uuid4>
required

Galileo ID of the project associated with this experiment

task_type
enum<integer>
required

Valid task types for modeling.

We store these as ints instead of strings because we will be looking this up in the database frequently.

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18
created_at
string<date-time>

Timestamp of the experiment's creation

updated_at
string<date-time> | null

Timestamp of the trace or span's last update

name
string
default:""

Name of the experiment

created_by
string<uuid4> | null
created_by_user
UserInfo · object

A user's basic information, used for display purposes.

num_spans
integer | null
num_traces
integer | null
dataset
ExperimentDataset · object
aggregate_metrics
Aggregate Metrics · object
aggregate_feedback
Aggregate Feedback · object

Aggregate feedback information related to the experiment

ranking_score
number | null
rank
integer | null
winner
boolean | null
playground_id
string<uuid4> | null
playground
ExperimentPlayground · object
prompt_run_settings
PromptRunSettings · object

Prompt run settings.

prompt_model
string | null
prompt
ExperimentPrompt · object
tags
Tags · object
status
ExperimentStatus · object