POST
/
session
/
start
import honeyhive
from honeyhive.models import components, operations

s = honeyhive.HoneyHive(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)


res = s.session.start_session(request=operations.StartSessionRequestBody(
    session=components.SessionStartRequest(
        project='Simple RAG Project',
        session_name='Playground Session',
        source='playground',
        session_id='caf77ace-3417-4da4-944d-f4a0688f3c23',
        children_ids=[
            '7f22137a-6911-4ed3-bc36-110f1dde6b66',
        ],
        inputs={
            'context': 'Hello world',
            'question': 'What is in the context?',
            'chat_history': [
                {
                    'role': 'system',
                    'content': 'Answer the user\'s question only using provided context.

                    Context: Hello world',
                },
                {
                    'role': 'user',
                    'content': 'What is in the context?',
                },
            ],
        },
        outputs={
            'role': 'assistant',
            'content': 'Hello world',
        },
        error=None,
        duration=824.8056,
        user_properties={
            'user': 'google-oauth2|111840237613341303366',
        },
        metrics={

        },
        feedback={

        },
        metadata={

        },
        start_time=1712025501605,
        end_time=1712025499832,
    ),
))

if res.object is not None:
    # handle response
    pass
{
  "session_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
session
object
Example:
{
  "project": "Simple RAG Project",
  "source": "playground",
  "event_type": "session",
  "session_name": "Playground Session",
  "session_id": "caf77ace-3417-4da4-944d-f4a0688f3c23",
  "event_id": "caf77ace-3417-4da4-944d-f4a0688f3c23",
  "parent_id": null,
  "children_ids": ["7f22137a-6911-4ed3-bc36-110f1dde6b66"],
  "inputs": {
    "context": "Hello world",
    "question": "What is in the context?",
    "chat_history": [
      {
        "role": "system",
        "content": "Answer the user's question only using provided context.\n\nContext: Hello world"
      },
      {
        "role": "user",
        "content": "What is in the context?"
      }
    ]
  },
  "outputs": {
    "role": "assistant",
    "content": "Hello world"
  },
  "error": null,
  "start_time": 1712025501605,
  "end_time": 1712025499832,
  "duration": 824.8056,
  "metrics": {},
  "feedback": {},
  "metadata": {},
  "user_properties": {
    "user": "google-oauth2|111840237613341303366"
  }
}

Response

200 - application/json
Session successfully started
​
session_id
string

Was this page helpful?

Suggest editsRaise issue