Cloud APIs
Answer with Citations
- Documentation
- Slack
- Discord
- Introduction
- Quickstart
- Resourcing
- Slack Bot Setup
Gen AI Configs
- Configuring Danswer
- System Overview
- Contact Us
- Connector Overview
- Web Connector
- File Connector
- Slack Connector
- GitHub Connector
- GitLab Connector
- Confluence Connector
- Jira Connector
Google Drive Connector
Gmail Connector
- Notion Connector
- Zendesk Connector
- Microsoft Sharepoint Connector
- Gong Connector
- Linear Connector
- BookStack Connector
- Document360 Connector
- Request Tracker Connector
- Slab Connector
- Guru Connector
- Productboard Connector
- HubSpot Connector
- Zulip Connector
- Google Sites Connector
- Ingestion API
- Telemetry
Welcome to Danswer
Connectors
Backend APIs
More
Cloud APIs
Answer with Citations
This is a Non-Streaming version that only gives back a minimal set of information
POST
/
chat
/
send-message-simple-api
fastapiusersauth
string
*
fastapiusersauth
Required
string
BasicCreateChatMessageRequest · object
*
Required
object
Before creating messages, be sure to create a chat_session and get an id Note, for simplicity this option only allows for a single linear chain of messages
chat_session_id
Chat Session Id · integer
*
chat_session_id
Required
integer
message
Message · string
*
message
Required
string
retrieval_options
RetrievalDetails · object
retrieval_options
object
run_search
OptionalSearchSetting · enum<string>
run_search
enum<string>
An enumeration.
real_time
Real Time · boolean
real_time
boolean
filters
BaseFilters · object
filters
object
source_type
array
source_type
array
document_set
Document Set · array
document_set
array
time_cutoff
Time Cutoff · string
time_cutoff
string
tags
Tags · array
tags
array
enable_auto_detect_filters
Enable Auto Detect Filters · boolean
enable_auto_detect_filters
boolean
offset
Offset · integer
offset
integer
limit
Limit · integer
limit
integer
query_override
Query Override · string
query_override
string
search_doc_ids
Search Doc Ids · array
search_doc_ids
array
{
"answer": "<string>",
"answer_citationless": "<string>",
"simple_search_docs": [
{
"semantic_identifier": "<string>",
"link": "<string>",
"blurb": "<string>",
"match_highlights": [
"<string>"
],
"source_type": "ingestion_api"
}
],
"error_msg": "<string>"
}
Authorizations
fastapiusersauth
string
cookierequiredBody
application/json
chat_session_id
integer
requiredmessage
string
requiredretrieval_options
object
retrieval_options.run_search
enum<string>
An enumeration.
Available options:
always
, never
, auto
retrieval_options.real_time
boolean
default: trueretrieval_options.filters
object
retrieval_options.filters.source_type
enum<string>[]
Available options:
ingestion_api
, slack
, web
, google_drive
, gmail
, requesttracker
, github
, gitlab
, guru
, bookstack
, confluence
, slab
, jira
, productboard
, file
, notion
, zulip
, linear
, hubspot
, document360
, gong
, google_sites
, zendesk
, loopio
, sharepoint
retrieval_options.filters.document_set
string[]
retrieval_options.filters.time_cutoff
string
retrieval_options.filters.tags
object[]
retrieval_options.filters.tags.tag_key
string
requiredretrieval_options.filters.tags.tag_value
string
requiredretrieval_options.enable_auto_detect_filters
boolean
retrieval_options.offset
integer
retrieval_options.limit
integer
query_override
string
search_doc_ids
integer[]
Response
200 - application/json
answer
string
answer_citationless
string
simple_search_docs
object[]
simple_search_docs.semantic_identifier
string
requiredsimple_search_docs.link
string
simple_search_docs.blurb
string
requiredsimple_search_docs.match_highlights
string[]
requiredsimple_search_docs.source_type
enum<string>
requiredAn enumeration.
Available options:
ingestion_api
, slack
, web
, google_drive
, gmail
, requesttracker
, github
, gitlab
, guru
, bookstack
, confluence
, slab
, jira
, productboard
, file
, notion
, zulip
, linear
, hubspot
, document360
, gong
, google_sites
, zendesk
, loopio
, sharepoint
error_msg
string
{
"answer": "<string>",
"answer_citationless": "<string>",
"simple_search_docs": [
{
"semantic_identifier": "<string>",
"link": "<string>",
"blurb": "<string>",
"match_highlights": [
"<string>"
],
"source_type": "ingestion_api"
}
],
"error_msg": "<string>"
}