{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"HoneyHive AI Docs","description":"AI observability and evaluation platform. Trace, evaluate, monitor, and improve AI agents and LLM applications.","colors":{"primary":"#A56311","light":"#E8A23D","dark":"#A56311"},"logo":{"light":"https://mintcdn.com/honeyhiveai/lWy7JAPdMsmL06l1/logo/light.svg?fit=max\u0026auto=format\u0026n=lWy7JAPdMsmL06l1\u0026q=85\u0026s=419c99bb22ce1e89ae8fb4a87c589528","dark":"https://mintcdn.com/honeyhiveai/lWy7JAPdMsmL06l1/logo/dark.svg?fit=max\u0026auto=format\u0026n=lWy7JAPdMsmL06l1\u0026q=85\u0026s=2cee835bc5438cd29005218a18e0168b"},"favicon":{"light":"https://mintcdn.com/honeyhiveai/W7aN2oGPMTbOQxZv/images/favicon.svg?fit=max\u0026auto=format\u0026n=W7aN2oGPMTbOQxZv\u0026q=85\u0026s=1c201da27b06120f1c630bf53ad1a831","dark":"https://mintcdn.com/honeyhiveai/W7aN2oGPMTbOQxZv/images/favicon-dark.svg?fit=max\u0026auto=format\u0026n=W7aN2oGPMTbOQxZv\u0026q=85\u0026s=01cb0bffc66454f0e19853e701832110"},"api":{"openapi":["output.yaml","https://raw.githubusercontent.com/honeyhiveai/honeyhive-openapi/main/data_plane_openapi.yaml","https://raw.githubusercontent.com/honeyhiveai/honeyhive-openapi/main/control_plane_openapi.yaml"],"mdx":{"auth":{"method":"key","name":"key"},"server":"https://api.dp1.us.honeyhive.ai"}},"appearance":{"default":"light"},"background":{"color":{"light":"#ffffff","dark":"#101010"}},"navbar":{"links":[{"href":"https://discord.gg/vqctGpqA97","label":"Community"}],"primary":{"type":"button","label":"Log In","href":"https://app.us.honeyhive.ai"}},"footer":{"socials":{"x":"https://x.com/honeyhiveai","linkedin":"https://www.linkedin.com/company/honeyhive-ai","github":"https://github.com/honeyhiveai"},"links":[{"header":"Resources","items":[{"label":"Quickstart","href":"https://docs.honeyhive.ai/v2/introduction/tracing-quickstart"},{"label":"SDK Reference","href":"https://docs.honeyhive.ai/v2/sdk-reference/overview"},{"label":"API Reference","href":"https://docs.honeyhive.ai/v2/api-reference-autogen/sessions/start-a-new-session"},{"label":"Integrations","href":"https://docs.honeyhive.ai/v2/integrations/openai"},{"label":"Changelog","href":"https://docs.honeyhive.ai/v2/changelog/product"}]},{"header":"Explore","items":[{"label":"Sign Up","href":"https://app.us.honeyhive.ai"},{"label":"Pricing","href":"https://www.honeyhive.ai/pricing"},{"label":"Blog","href":"https://honeyhive.ai/blog"}]},{"header":"Platform","items":[{"label":"Observability","href":"https://honeyhive.ai/observability"},{"label":"Evaluation","href":"https://honeyhive.ai/evaluation"},{"label":"Prompt Management","href":"https://honeyhive.ai/playground"}]},{"header":"Legal","items":[{"label":"Terms of Service","href":"https://honeyhive.ai/terms"},{"label":"Privacy Policy","href":"https://honeyhive.ai/privacy"}]}]},"search":{"prompt":"Search or ask AI..."},"seo":{"metatags":{"og:site_name":"HoneyHive AI Docs"},"indexing":"navigable"},"integrations":{"posthog":{"apiKey":"phc_CtmMXHNhIs1Iem8viAsXYH7lB0aaj4X2nCrCunPqDbF","sessionRecording":false},"telemetry":{"enabled":true}},"contextual":{"options":["copy","view","chatgpt","claude","mcp","cursor","vscode",{"title":"Join Discord","description":"Get help from the HoneyHive community","icon":"discord","href":"https://discord.gg/vqctGpqA97"}],"display":"header"},"styling":{"latex":false},"navigation":{"global":{},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"honeyhiveai","hasAudioNarration":false,"actualSubdomain":"honeyhiveai","customDomains":["docs.honeyhive.ai"],"gitSource":{"type":"github","owner":"honeyhiveai","repo":"honeyhive-ai-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae3679851fbfc0519ab5b75","collectionId":"88f8d388-c76c-4ca9-8c6e-557655f1bca5","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae3679851fbfc0519ab5b75"},"feedback":{"issues":false,"edits":false,"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae3679851fbfc0519ab5b75","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"v2","count":385},{"language":"default","tag":"SDK Reference","count":168},{"language":"default","tag":"Reference","count":164},{"language":"default","tag":"TypeScript API SDK","count":112},{"language":"default","tag":"Documentation","count":91},{"language":"default","tag":"API Reference","count":69},{"language":"default","tag":"Data Plane API","count":51},{"language":"default","tag":"TypeScript Control Plane SDK","count":45},{"language":"default","tag":"Experiments","count":40},{"language":"default","tag":"Integrations","count":34}]},"assistantConfig":{"deflection":{"enabled":true,"email":"support@honeyhive.ai"}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".update-container .hh-update-entry:first-child>h2{margin-top:0}"}],"page":{"pagePath":"api-reference/session/start-a-new-session","slug":"/api-reference/session/start-a-new-session","pageMetadata":{"openapi":"output.yaml post /session/start","noindex":true,"title":"Start a new session","description":null,"href":"/api-reference/session/start-a-new-session"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"output.yaml post /session/start","noindex":true,"title":"Start a new session","description":null,"href":"/api-reference/session/start-a-new-session"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/honeyhiveai/295d4d275d20dba2/leadfeeder.js"],"openApiReferenceData":{"operation":{"summary":"Start a new session","operationId":"startSession","tags":["Session"],"requestBody":"efb8bf55-94ca-4c8f-aadc-78688183a4b2","responses":{"200":"45ced6c1-6db1-4ce3-8bb3-4639b4869de2"},"x-codeSamples":[{"lang":"python","label":"startSession","source":"import honeyhive\nfrom honeyhive.models import components, operations\n\ns = honeyhive.HoneyHive(\n bearer_auth=\"\u003cYOUR_BEARER_TOKEN_HERE>\",\n)\n\n\nres = s.session.start_session(request=operations.StartSessionRequestBody(\n session=components.SessionStartRequest(\n project='Simple RAG Project',\n session_name='Playground Session',\n source='playground',\n session_id='caf77ace-3417-4da4-944d-f4a0688f3c23',\n children_ids=[\n '7f22137a-6911-4ed3-bc36-110f1dde6b66',\n ],\n inputs={\n 'context': 'Hello world',\n 'question': 'What is in the context?',\n 'chat_history': [\n {\n 'role': 'system',\n 'content': 'Answer the user\\'s question only using provided context.\n\n Context: Hello world',\n },\n {\n 'role': 'user',\n 'content': 'What is in the context?',\n },\n ],\n },\n outputs={\n 'role': 'assistant',\n 'content': 'Hello world',\n },\n error=None,\n duration=824.8056,\n user_properties={\n 'user': 'google-oauth2|111840237613341303366',\n },\n metrics={\n\n },\n feedback={\n\n },\n metadata={\n\n },\n start_time=1712025501605,\n end_time=1712025499832,\n ),\n))\n\nif res.object is not None:\n # handle response\n pass"},{"lang":"typescript","label":"startSession","source":"import { HoneyHive } from \"honeyhive\";\n\nasync function run() {\n const sdk = new HoneyHive({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE>\",\n });\n\n const res = await sdk.session.startSession({\n session: {\n project: \"Simple RAG Project\",\n sessionName: \"Playground Session\",\n source: \"playground\",\n sessionId: \"caf77ace-3417-4da4-944d-f4a0688f3c23\",\n childrenIds: [\n \"7f22137a-6911-4ed3-bc36-110f1dde6b66\",\n ],\n config: {\n \"key\": \"\u003cvalue>\",\n },\n inputs: {\n \"context\": \"Hello world\",\n \"question\": \"What is in the context?\",\n \"chat_history\": [\n {\n \"role\": \"system\",\n \"content\": \"Answer the user's question only using provided context.\n\n Context: Hello world\",\n },\n {\n \"role\": \"user\",\n \"content\": \"What is in the context?\",\n },\n ],\n },\n outputs: {\n \"role\": \"assistant\",\n \"content\": \"Hello world\",\n },\n error: null,\n duration: 824.8056,\n userProperties: {\n \"user\": \"google-oauth2|111840237613341303366\",\n },\n metrics: {\n\n },\n feedback: {\n\n },\n metadata: {\n\n },\n startTime: 1712025501605,\n endTime: 1712025499832,\n },\n });\n\n if (res.statusCode == 200) {\n // handle response\n }\n}\n\nrun();"}],"method":"post","type":"path","servers":["9c085861-5b70-49fb-8539-db0cd1f26b97"],"security":["a9b62862-c317-4d53-990d-dc3e72abce55"],"path":"/session/start","baseUrlOptions":["https://api.honeyhive.ai"],"title":"Start a new session","description":"","codeSamples":[{"label":"startSession","lang":"python","source":"import honeyhive\nfrom honeyhive.models import components, operations\n\ns = honeyhive.HoneyHive(\n bearer_auth=\"\u003cYOUR_BEARER_TOKEN_HERE>\",\n)\n\n\nres = s.session.start_session(request=operations.StartSessionRequestBody(\n session=components.SessionStartRequest(\n project='Simple RAG Project',\n session_name='Playground Session',\n source='playground',\n session_id='caf77ace-3417-4da4-944d-f4a0688f3c23',\n children_ids=[\n '7f22137a-6911-4ed3-bc36-110f1dde6b66',\n ],\n inputs={\n 'context': 'Hello world',\n 'question': 'What is in the context?',\n 'chat_history': [\n {\n 'role': 'system',\n 'content': 'Answer the user\\'s question only using provided context.\n\n Context: Hello world',\n },\n {\n 'role': 'user',\n 'content': 'What is in the context?',\n },\n ],\n },\n outputs={\n 'role': 'assistant',\n 'content': 'Hello world',\n },\n error=None,\n duration=824.8056,\n user_properties={\n 'user': 'google-oauth2|111840237613341303366',\n },\n metrics={\n\n },\n feedback={\n\n },\n metadata={\n\n },\n start_time=1712025501605,\n end_time=1712025499832,\n ),\n))\n\nif res.object is not None:\n # handle response\n pass"},{"label":"startSession","lang":"typescript","source":"import { HoneyHive } from \"honeyhive\";\n\nasync function run() {\n const sdk = new HoneyHive({\n bearerAuth: \"\u003cYOUR_BEARER_TOKEN_HERE>\",\n });\n\n const res = await sdk.session.startSession({\n session: {\n project: \"Simple RAG Project\",\n sessionName: \"Playground Session\",\n source: \"playground\",\n sessionId: \"caf77ace-3417-4da4-944d-f4a0688f3c23\",\n childrenIds: [\n \"7f22137a-6911-4ed3-bc36-110f1dde6b66\",\n ],\n config: {\n \"key\": \"\u003cvalue>\",\n },\n inputs: {\n \"context\": \"Hello world\",\n \"question\": \"What is in the context?\",\n \"chat_history\": [\n {\n \"role\": \"system\",\n \"content\": \"Answer the user's question only using provided context.\n\n Context: Hello world\",\n },\n {\n \"role\": \"user\",\n \"content\": \"What is in the context?\",\n },\n ],\n },\n outputs: {\n \"role\": \"assistant\",\n \"content\": \"Hello world\",\n },\n error: null,\n duration: 824.8056,\n userProperties: {\n \"user\": \"google-oauth2|111840237613341303366\",\n },\n metrics: {\n\n },\n feedback: {\n\n },\n metadata: {\n\n },\n startTime: 1712025501605,\n endTime: 1712025499832,\n },\n });\n\n if (res.statusCode == 200) {\n // handle response\n }\n}\n\nrun();"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"session":{"type":"object","properties":{"project":{"type":"string","description":"Project name associated with the session","isRequired":true,"uniqueKey":"session.project","typeLabel":"string"},"session_name":{"type":"string","description":"Name of the session","isRequired":true,"uniqueKey":"session.session_name","typeLabel":"string"},"source":{"type":"string","description":"Source of the session - production, staging, etc","isRequired":true,"uniqueKey":"session.source","typeLabel":"string"},"session_id":{"type":"string","description":"Unique id of the session, if not set, it will be auto-generated","uniqueKey":"session.session_id","typeLabel":"string"},"children_ids":{"type":"array","items":{"type":"string","uniqueKey":"session.children_ids.items.[INDEX]","typeLabel":"string"},"description":"Id of events that are nested within the session","uniqueKey":"session.children_ids","typeLabel":"string[]"},"config":{"type":"object","additionalProperties":true,"description":"Associated configuration for the session","uniqueKey":"session.config","typeLabel":"object"},"inputs":{"type":"object","additionalProperties":true,"description":"Input object passed to the session - user query, text blob, etc","uniqueKey":"session.inputs","typeLabel":"object"},"outputs":{"type":"object","additionalProperties":true,"description":"Final output of the session - completion, chunks, etc","uniqueKey":"session.outputs","typeLabel":"object"},"error":{"type":"string","description":"Any error description if session failed","uniqueKey":"session.error","typeLabel":"string"},"duration":{"type":"number","description":"How long the session took in milliseconds","uniqueKey":"session.duration","typeLabel":"number"},"user_properties":{"type":"object","additionalProperties":true,"description":"Any user properties associated with the session","uniqueKey":"session.user_properties","typeLabel":"object"},"metrics":{"type":"object","additionalProperties":true,"description":"Any values computed over the output of the session","uniqueKey":"session.metrics","typeLabel":"object"},"feedback":{"type":"object","additionalProperties":true,"description":"Any user feedback provided for the session output","uniqueKey":"session.feedback","typeLabel":"object"},"metadata":{"type":"object","additionalProperties":true,"description":"Any system or application metadata associated with the session","uniqueKey":"session.metadata","typeLabel":"object"},"start_time":{"type":"number","description":"UTC timestamp (in milliseconds) for the session start","uniqueKey":"session.start_time","typeLabel":"number"},"end_time":{"type":"integer","description":"UTC timestamp (in milliseconds) for the session end","uniqueKey":"session.end_time","typeLabel":"integer"}},"required":["project","session_name","source"],"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"}},"uniqueKey":"session","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"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"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"45ced6c1-6db1-4ce3-8bb3-4639b4869de2":{"description":"Session successfully started","content":{"application/json":{"schema":{"type":"object","properties":{"session_id":{"type":"string","uniqueKey":"session_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"session_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"a9b62862-c317-4d53-990d-dc3e72abce55":{"BearerAuth":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{"9c085861-5b70-49fb-8539-db0cd1f26b97":{"url":"https://api.honeyhive.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"output.yaml"},"subdomain":"honeyhiveai","siteName":"HoneyHive AI Docs","title":"Start a new session - HoneyHive AI Docs","relatedPagesConfig":{"enabled":true,"limit":3,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-29T14:55:24.783Z","originalFileLocation":"api-reference/session/start-a-new-session.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"HoneyHive AI Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/honeyhiveai/XiZ-DZ6IaFrWYjlm/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/honeyhiveai/XiZ-DZ6IaFrWYjlm/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/honeyhiveai/XiZ-DZ6IaFrWYjlm/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/honeyhiveai/XiZ-DZ6IaFrWYjlm/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/honeyhiveai/XiZ-DZ6IaFrWYjlm/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/honeyhiveai/XiZ-DZ6IaFrWYjlm/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/honeyhiveai/XiZ-DZ6IaFrWYjlm/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/honeyhiveai/XiZ-DZ6IaFrWYjlm/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/honeyhiveai/XiZ-DZ6IaFrWYjlm/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Start a new session - HoneyHive AI Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"HoneyHive AI Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.honeyhive.ai/api-reference/session/start-a-new-session\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://honeyhiveai.mintlify.app/_mintlify/api/og/v2?division=Session\u0026amp;title=Start+a+new+session\u0026amp;theme=0dac4d98fc38691c224052c2\u0026amp;signature=9dd5502d3f815cea221f573c4d03ac438789f34b7ec4dce5aed3728bc2c1f285\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Start a new session - HoneyHive AI Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://honeyhiveai.mintlify.app/_mintlify/api/og/v2?division=Session\u0026amp;title=Start+a+new+session\u0026amp;theme=0dac4d98fc38691c224052c2\u0026amp;signature=9dd5502d3f815cea221f573c4d03ac438789f34b7ec4dce5aed3728bc2c1f285\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/honeyhiveai/XiZ-DZ6IaFrWYjlm/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"HoneyHive AI Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#A56311\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.honeyhive.ai/api-reference/session/start-a-new-session\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/session/start-a-new-session.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"HoneyHive AI Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"HoneyHive AI Docs","nav":{"global":{},"products":[{"product":"v2","icon":"hive","description":"The next generation of HoneyHive.","pages":[{"title":"v2","href":"/v2/introduction/what-is-hhai"}]},{"product":"v1 (legacy)","icon":"server","description":"Deprecating Nov 5, 2026.","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction/what-is-hhai"}]},{"tab":"SDK Reference","pages":[{"title":"SDK Reference","href":"/sdk-reference/authentication"}]},{"tab":"API Reference","groups":[{"group":"Session","pages":[{"openapi":"output.yaml post /session/start","title":"Start a new session","href":"/api-reference/session/start-a-new-session"},{"openapi":"get /session/{session_id}","title":"Retrieve a session","description":null,"href":"/api-reference/session/retrieve-a-session"}]},{"group":"Events","pages":[{"openapi":"output.yaml put /events","title":"Update an event","href":"/api-reference/events/update-an-event"},{"openapi":"output.yaml post /events","title":"Create a new event","href":"/api-reference/events/create-a-new-event"},{"openapi":"post /events/export","title":"Retrieve events based on filters","href":"/api-reference/events/retrieve-events-based-on-filters"},{"openapi":"output.yaml post /events/model","title":"Create a new model event","href":"/api-reference/events/create-a-new-model-event"},{"openapi":"output.yaml post /events/batch","title":"Create a batch of events","href":"/api-reference/events/create-a-batch-of-events"},{"openapi":"output.yaml post /events/model/batch","title":"Create a batch of model events","href":"/api-reference/events/create-a-batch-of-model-events"}]},{"group":"Metrics","pages":[{"openapi":"get /metrics","title":"Get all metrics","href":"/api-reference/metrics/get-all-metrics"},{"openapi":"put /metrics","title":"Update an existing metric","href":"/api-reference/metrics/update-an-existing-metric"},{"openapi":"post /metrics","title":"Create a new metric","href":"/api-reference/metrics/create-a-new-metric"},{"openapi":"delete /metrics","title":"Delete a metric","href":"/api-reference/metrics/delete-a-metric"}]},{"group":"Datapoints","pages":[{"openapi":"get /datapoints","title":"Retrieve a list of datapoints","href":"/api-reference/datapoints/retrieve-a-list-of-datapoints"},{"openapi":"post /datapoints","title":"Create a new datapoint","href":"/api-reference/datapoints/create-a-new-datapoint"},{"openapi":"get /datapoints/{id}","title":"Retrieve a specific datapoint","href":"/api-reference/datapoints/retrieve-a-specific-datapoint"},{"openapi":"put /datapoints/{id}","title":"Update a specific datapoint","href":"/api-reference/datapoints/update-a-specific-datapoint"},{"openapi":"delete /datapoints/{id}","title":"Delete a specific datapoint","href":"/api-reference/datapoints/delete-a-specific-datapoint"}]},{"group":"Datasets","pages":[{"openapi":"get /datasets","title":"Get datasets","href":"/api-reference/datasets/get-datasets"},{"openapi":"put /datasets","title":"Update a dataset","href":"/api-reference/datasets/update-a-dataset"},{"openapi":"post /datasets","title":"Create a dataset","href":"/api-reference/datasets/create-a-dataset"},{"openapi":"delete /datasets","title":"Delete a dataset","href":"/api-reference/datasets/delete-a-dataset"},{"openapi":"post /datasets/{dataset_id}/datapoints","title":"Add datapoints to a dataset","href":"/api-reference/datasets/add-datapoints-to-a-dataset"}]},{"group":"Projects","pages":[{"openapi":"get /projects","title":"Get a list of projects","href":"/api-reference/projects/get-a-list-of-projects"},{"openapi":"put /projects","title":"Update an existing project","href":"/api-reference/projects/update-an-existing-project"},{"openapi":"post /projects","title":"Create a new project","href":"/api-reference/projects/create-a-new-project"},{"openapi":"delete /projects","title":"Delete a project","href":"/api-reference/projects/delete-a-project"}]},{"group":"Experiments","pages":[{"openapi":"get /runs","title":"Get a list of evaluation runs","href":"/api-reference/experiments/get-a-list-of-evaluation-runs"},{"openapi":"post /runs","title":"Create a new evaluation run","href":"/api-reference/experiments/create-a-new-evaluation-run"},{"openapi":"get /runs/{run_id}","title":"Get details of an evaluation run","href":"/api-reference/experiments/get-details-of-an-evaluation-run"},{"openapi":"put /runs/{run_id}","title":"Update an evaluation run","href":"/api-reference/experiments/update-an-evaluation-run"},{"openapi":"delete /runs/{run_id}","title":"Delete an evaluation run","href":"/api-reference/experiments/delete-an-evaluation-run"},{"openapi":"get /runs/{run_id}/result","title":null,"href":"/api-reference/experiments/retrieve-experiment-result"},{"openapi":"get /runs/{run_id_1}/compare-with/{run_id_2}","title":null,"href":"/api-reference/experiments/retrieve-experiment-comparison"}]}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/langchain"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/changelog"}]}]}]},"title":"Start a new session - HoneyHive AI Docs","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}