trace

Create Session

Changed on
post/public/v2/projects/{project_id}/sessions

Request

  • Base URL
    https://api.galileo.ai
  • URL
    https://api.galileo.ai/public/v2/projects/{project_id}/sessions
  • Auth
    • API key in header Splunk-AO-API-Key
    • or API key in header Galileo-API-Key
    • or OAuth 2
      Password
      Token URL: https://api.galileo.ai/login
    • or HTTP basic

Path parameters

project_idstring uuid4 required

Request body

log_stream_idstring uuid4 nullable

Log stream id associated with the traces.

experiment_idstring uuid4 nullable

Experiment id associated with the traces.

metrics_testing_idstring uuid4 nullable

Metrics testing id associated with the traces.

logging_method'playground' | 'python_client' | 'typescript_client' | 'api_direct'
client_versionstring nullable
reliableboolean

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 durably accepted or return an error message if there is an ingestion failure. On the streaming write path (kafka_metrics_pipeline) accepted means acknowledged by Kafka; the records become readable after the data-writer flush, about GALILEO_STREAMING_EXPECTED_LAG_SECONDS (default 2.5 s) later, so a read issued immediately after the response can miss them.

namestring nullable

Name of the session.

previous_session_idstring uuid4 nullable

Id of the previous session.

external_idstring nullable

External id of the session.

user_metadataobject nullable

User metadata for the session.

Response

Successful Response

idstring uuid4 required

Session id associated with the session.

namestring nullable required

Name of the session.

project_idstring uuid4 required

Project id associated with the session.

project_namestring required

Project name associated with the session.

previous_session_idstring uuid4 nullable

Id of the previous session.

external_idstring nullable

External id of the session.

Changes