chat_session
Create Chat Session
React
JS Snippet
Common Settings
Customization Guides
Docusaurus
Next.js
Nextra
Astro
Remix
WordPress
Webflow
Framer
- Mintlify
VitePress
Sphinx
Redocly
Hugo
chat_session
- UI Components
UI Components
Add to your site
API
Release Notes
chat_session
Create Chat Session
POST
/
v0
/
chat_sessions
/
chat_results
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Create Chat Session Input · object
*
integration_id
Integration ID · string
*
integration_id
Required
string
chat_session
Chat Session Input · object
*
chat_session
Required
object
guidance
string
guidance
string
context
string
context
string
messages
Messages · array
*
messages
Required
array
chat_mode
enum<string>
chat_mode
enum<string>
stream
Stream · boolean
stream
boolean
curl --request POST \
--url https://api.inkeep.com/v0/chat_sessions/chat_results \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'
{
"chat_session_id": "<string>",
"message": {
"role": "<string>",
"content": "<string>",
"records_cited": {
"citations": [
{
"number": 123,
"record": {
"type": "documentation",
"url": "<string>",
"title": "<string>",
"description": "<string>",
"breadcrumbs": [
"<string>"
]
},
"hit_url": "<string>"
}
]
}
}
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
integration_id
string
requiredchat_session
object
requiredchat_session.guidance
string | null
chat_session.context
string | null
chat_session.messages
object[]
requiredchat_session.messages.role
string
requiredchat_session.messages.content
string
requiredchat_mode
Available options:
turbo
, auto
stream
boolean
default: falseResponse
200 - application/json
chat_session_id
string
requiredmessage
object
requiredmessage.role
string
requiredmessage.content
string
requiredmessage.records_cited
object
message.records_cited.citations
object[]
requiredmessage.records_cited.citations.number
integer
message.records_cited.citations.record
object
requiredmessage.records_cited.citations.record.type
required
The type of record
Available options:
documentation
, site
, discourse_post
, github_issue
, github_discussion
, stackoverflow_question
, discord_forum_post
, discord_message
, custom_question_answer
message.records_cited.citations.record.url
string | null
message.records_cited.citations.record.title
string | null
message.records_cited.citations.record.description
string | null
message.records_cited.citations.record.breadcrumbs
string[] | null
message.records_cited.citations.hit_url
string | null
curl --request POST \
--url https://api.inkeep.com/v0/chat_sessions/chat_results \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'
{
"chat_session_id": "<string>",
"message": {
"role": "<string>",
"content": "<string>",
"records_cited": {
"citations": [
{
"number": 123,
"record": {
"type": "documentation",
"url": "<string>",
"title": "<string>",
"description": "<string>",
"breadcrumbs": [
"<string>"
]
},
"hit_url": "<string>"
}
]
}
}
}