- Knowledge
- Community
- GETRetrieve a list of configurations
- POSTCreate a new configuration
- PUTUpdate an existing configuration
- DELDelete a configuration
- GETRetrieve a list of datapoints
- PUTUpdate a specific datapoint
- POSTCreate a new datapoint
- GETRetrieve a specific datapoint
- DELDelete a specific datapoint
Configurations
Datapoints
Start a new session
curl --request POST \
--url https://api.honeyhive.ai/session/start \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"session": {
"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"
}
}
}'
{
"session_id": "<string>"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
Project name associated with the session
Name of the session
Source of the session - production, staging, etc
Unique id of the session, if not set, it will be auto-generated
Id of events that are nested within the session
Associated configuration for the session
Input object passed to the session - user query, text blob, etc
Final output of the session - completion, chunks, etc
Any error description if session failed
How long the session took in milliseconds
Any user properties associated with the session
Any values computed over the output of the session
Any user feedback provided for the session output
Any system or application metadata associated with the session
UTC timestamp (in milliseconds) for the session start
UTC timestamp (in milliseconds) for the session end
Response
curl --request POST \
--url https://api.honeyhive.ai/session/start \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"session": {
"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"
}
}
}'
{
"session_id": "<string>"
}