Cloud APIs
Answer with Quote
- 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 Quote
POST
/
query
/
answer-with-quote
fastapiusersauth
string
*
fastapiusersauth
Required
string
DirectQARequest · object
*
messages
Messages · array
*
messages
Required
array
prompt_id
Prompt Id · integer
prompt_id
integer
persona_id
Persona Id · integer
*
persona_id
Required
integer
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
chain_of_thought
Chain Of Thought · boolean
chain_of_thought
boolean
return_contexts
Return Contexts · boolean
return_contexts
boolean
{
"answer": "<string>",
"rephrase": "<string>",
"quotes": {
"quotes": [
{
"quote": "<string>",
"document_id": "<string>",
"link": "<string>",
"source_type": "<string>",
"semantic_identifier": "<string>",
"blurb": "<string>"
}
]
},
"citations": [
{
"citation_num": 123,
"document_id": "<string>"
}
],
"docs": {
"top_documents": [
{
"document_id": "<string>",
"chunk_ind": 123,
"semantic_identifier": "<string>",
"link": "<string>",
"blurb": "<string>",
"source_type": "ingestion_api",
"boost": 123,
"hidden": true,
"metadata": {},
"score": 123,
"match_highlights": [
"<string>"
],
"updated_at": "2023-11-07T05:31:56Z",
"primary_owners": [
"<string>"
],
"secondary_owners": [
"<string>"
],
"db_doc_id": 123
}
],
"rephrased_query": "<string>",
"predicted_flow": "search",
"predicted_search": "keyword",
"applied_source_filters": [
"ingestion_api"
],
"applied_time_cutoff": "2023-11-07T05:31:56Z",
"recency_bias_multiplier": 123
},
"llm_chunks_indices": [
123
],
"error_msg": "<string>",
"answer_valid": true,
"chat_message_id": 123,
"contexts": {
"contexts": [
{
"content": "<string>",
"document_id": "<string>",
"semantic_identifier": "<string>",
"blurb": "<string>"
}
]
}
}
Authorizations
fastapiusersauth
string
cookierequiredBody
application/json
messages
object[]
requiredmessages.message
string
requiredmessages.sender
string
messages.role
enum<string>
An enumeration.
Available options:
system
, user
, assistant
prompt_id
integer
persona_id
integer
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
chain_of_thought
boolean
default: falsereturn_contexts
boolean
default: falseResponse
200 - application/json
answer
string
rephrase
string
quotes
object
quotes.quotes
object[]
requiredquotes.quotes.quote
string
requiredquotes.quotes.document_id
string
requiredquotes.quotes.link
string
quotes.quotes.source_type
string
requiredquotes.quotes.semantic_identifier
string
requiredquotes.quotes.blurb
string
requiredcitations
object[]
citations.citation_num
integer
requiredcitations.document_id
string
requireddocs
object
docs.top_documents
object[]
requireddocs.top_documents.document_id
string
requireddocs.top_documents.chunk_ind
integer
requireddocs.top_documents.semantic_identifier
string
requireddocs.top_documents.link
string
docs.top_documents.blurb
string
requireddocs.top_documents.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
docs.top_documents.boost
integer
requireddocs.top_documents.hidden
boolean
requireddocs.top_documents.metadata
object
requireddocs.top_documents.score
number
default: 0docs.top_documents.match_highlights
string[]
requireddocs.top_documents.updated_at
string
docs.top_documents.primary_owners
string[]
docs.top_documents.secondary_owners
string[]
docs.top_documents.db_doc_id
integer
requireddocs.rephrased_query
string
docs.predicted_flow
enum<string>
An enumeration.
Available options:
search
, question-answer
docs.predicted_search
enum<string>
An enumeration.
Available options:
keyword
, semantic
, hybrid
docs.applied_source_filters
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
docs.applied_time_cutoff
string
docs.recency_bias_multiplier
number
requiredllm_chunks_indices
integer[]
error_msg
string
answer_valid
boolean
default: truechat_message_id
integer
contexts
object
contexts.contexts
object[]
requiredcontexts.contexts.content
string
requiredcontexts.contexts.document_id
string
requiredcontexts.contexts.semantic_identifier
string
requiredcontexts.contexts.blurb
string
required{
"answer": "<string>",
"rephrase": "<string>",
"quotes": {
"quotes": [
{
"quote": "<string>",
"document_id": "<string>",
"link": "<string>",
"source_type": "<string>",
"semantic_identifier": "<string>",
"blurb": "<string>"
}
]
},
"citations": [
{
"citation_num": 123,
"document_id": "<string>"
}
],
"docs": {
"top_documents": [
{
"document_id": "<string>",
"chunk_ind": 123,
"semantic_identifier": "<string>",
"link": "<string>",
"blurb": "<string>",
"source_type": "ingestion_api",
"boost": 123,
"hidden": true,
"metadata": {},
"score": 123,
"match_highlights": [
"<string>"
],
"updated_at": "2023-11-07T05:31:56Z",
"primary_owners": [
"<string>"
],
"secondary_owners": [
"<string>"
],
"db_doc_id": 123
}
],
"rephrased_query": "<string>",
"predicted_flow": "search",
"predicted_search": "keyword",
"applied_source_filters": [
"ingestion_api"
],
"applied_time_cutoff": "2023-11-07T05:31:56Z",
"recency_bias_multiplier": 123
},
"llm_chunks_indices": [
123
],
"error_msg": "<string>",
"answer_valid": true,
"chat_message_id": 123,
"contexts": {
"contexts": [
{
"content": "<string>",
"document_id": "<string>",
"semantic_identifier": "<string>",
"blurb": "<string>"
}
]
}
}