Create Session

POST /v2/projects/{project_id}/sessions

Create Session

cURL

curl --request POST \
  --url https://api.galileo.ai/v2/projects/{project_id}/sessions \
  --header 'Content-Type: application/json' \
  --header 'Galileo-API-Key: <api-key>' \
  --data '
{
  "log_stream_id": "<string>",
  "experiment_id": "<string>",
  "metrics_testing_id": "<string>",
  "logging_method": "api_direct",
  "client_version": "<string>",
  "reliable": true,
  "name": "<string>",
  "previous_session_id": "<string>",
  "external_id": "<string>",
  "user_metadata": {}
}
'

import requests

url = "https://api.galileo.ai/v2/projects/{project_id}/sessions"

payload = {
    "log_stream_id": "<string>",
    "experiment_id": "<string>",
    "metrics_testing_id": "<string>",
    "logging_method": "api_direct",
    "client_version": "<string>",
    "reliable": True,
    "name": "<string>",
    "previous_session_id": "<string>",
    "external_id": "<string>",
    "user_metadata": {}
}
headers = {
    "Galileo-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Galileo-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    log_stream_id: '<string>',
    experiment_id: '<string>',
    metrics_testing_id: '<string>',
    logging_method: 'api_direct',
    client_version: '<string>',
    reliable: true,
    name: '<string>',
    previous_session_id: '<string>',
    external_id: '<string>',
    user_metadata: {}
  })
};

fetch('https://api.galileo.ai/v2/projects/{project_id}/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.galileo.ai/v2/projects/{project_id}/sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'log_stream_id' => '<string>',
    'experiment_id' => '<string>',
    'metrics_testing_id' => '<string>',
    'logging_method' => 'api_direct',
    'client_version' => '<string>',
    'reliable' => true,
    'name' => '<string>',
    'previous_session_id' => '<string>',
    'external_id' => '<string>',
    'user_metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Galileo-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.galileo.ai/v2/projects/{project_id}/sessions"

	payload := strings.NewReader("{\n  \"log_stream_id\": \"<string>\",\n  \"experiment_id\": \"<string>\",\n  \"metrics_testing_id\": \"<string>\",\n  \"logging_method\": \"api_direct\",\n  \"client_version\": \"<string>\",\n  \"reliable\": true,\n  \"name\": \"<string>\",\n  \"previous_session_id\": \"<string>\",\n  \"external_id\": \"<string>\",\n  \"user_metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Galileo-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.galileo.ai/v2/projects/{project_id}/sessions")
  .header("Galileo-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"log_stream_id\": \"<string>\",\n  \"experiment_id\": \"<string>\",\n  \"metrics_testing_id\": \"<string>\",\n  \"logging_method\": \"api_direct\",\n  \"client_version\": \"<string>\",\n  \"reliable\": true,\n  \"name\": \"<string>\",\n  \"previous_session_id\": \"<string>\",\n  \"external_id\": \"<string>\",\n  \"user_metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.galileo.ai/v2/projects/{project_id}/sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Galileo-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"log_stream_id\": \"<string>\",\n  \"experiment_id\": \"<string>\",\n  \"metrics_testing_id\": \"<string>\",\n  \"logging_method\": \"api_direct\",\n  \"client_version\": \"<string>\",\n  \"reliable\": true,\n  \"name\": \"<string>\",\n  \"previous_session_id\": \"<string>\",\n  \"external_id\": \"<string>\",\n  \"user_metadata\": {}\n}"

response = http.request(request)
puts response.read_body

200

{
  "id": "<string>",
  "name": "<string>",
  "project_id": "<string>",
  "project_name": "<string>",
  "previous_session_id": "<string>",
  "external_id": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

ClassicAPIKeyHeaderAPIKeyHeaderOAuth2PasswordBearerHTTPBasic

Galileo-API-Key · string · header · required

Path Parameters

project_id · string<uuid4> · required

Body

application/json

log_stream_id · string<uuid4> | null

Log stream id associated with the traces.

experiment_id · string<uuid4> | null

Experiment id associated with the traces.

metrics_testing_id · string<uuid4> | null

Metrics testing id associated with the traces.

logging_method · enum<string> · default: api_direct

Available options: playground, python_client, typescript_client, api_direct

client_version · string | null

reliable · boolean · default: true

Whether or not to use reliable logging. If set to False, the method will respond immediately before verifying that the traces have been successfully ingested, and no error message will be returned if ingestion fails. If set to True, the method will wait for the traces to be successfully ingested or return an error message if there is an ingestion failure.

name · string | null

Name of the session.

previous_session_id · string<uuid4> | null

Id of the previous session.

external_id · string | null

External id of the session.

user_metadata · User Metadata · object | null

User metadata for the session.

Show child attributes

Response

200

application/json

Successful Response

id · string<uuid4> · required

Session id associated with the session.

name · string | null · required

Name of the session.

project_id · string<uuid4> · required

Project id associated with the session.

project_name · string · required

Project name associated with the session.

previous_session_id · string<uuid4> | null

Id of the previous session.

external_id · string | null

External id of the session.