curl --request POST \
--url https://cloud.onyx.app/api/chat/send-message-simple-api \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"message": "<string>",
"chunks_above": 123,
"chunks_below": 123,
"full_doc": false,
"chat_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"persona_id": 123,
"retrieval_options": {
"chunks_above": 123,
"chunks_below": 123,
"full_doc": false,
"run_search": "always",
"real_time": true,
"filters": {
"source_type": [
"ingestion_api"
],
"document_set": [
"<string>"
],
"time_cutoff": "2023-11-07T05:31:56Z",
"tags": [
{
"tag_key": "<string>",
"tag_value": "<string>"
}
],
"kg_entities": [
"<string>"
],
"kg_relationships": [
"<string>"
],
"kg_terms": [
"<string>"
],
"kg_sources": [
"<string>"
],
"kg_chunk_id_zero_only": false
},
"enable_auto_detect_filters": true,
"offset": 123,
"limit": 123,
"dedupe_docs": false
},
"query_override": "<string>",
"search_doc_ids": [
123
],
"structured_response_format": {},
"use_agentic_search": false
}
'{
"answer": "<string>",
"answer_citationless": "<string>",
"top_documents": [
{
"document_id": "<string>",
"chunk_ind": 123,
"semantic_identifier": "<string>",
"blurb": "<string>",
"source_type": "ingestion_api",
"boost": 123,
"hidden": true,
"metadata": {},
"match_highlights": [
"<string>"
],
"db_doc_id": 123,
"link": "<string>",
"score": 0,
"is_relevant": true,
"relevance_explanation": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"primary_owners": [
"<string>"
],
"secondary_owners": [
"<string>"
],
"is_internet": false
}
],
"error_msg": "<string>",
"message_id": 123,
"cited_documents": {}
}This is a Non-Streaming version that only gives back a minimal set of information
curl --request POST \
--url https://cloud.onyx.app/api/chat/send-message-simple-api \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"message": "<string>",
"chunks_above": 123,
"chunks_below": 123,
"full_doc": false,
"chat_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"persona_id": 123,
"retrieval_options": {
"chunks_above": 123,
"chunks_below": 123,
"full_doc": false,
"run_search": "always",
"real_time": true,
"filters": {
"source_type": [
"ingestion_api"
],
"document_set": [
"<string>"
],
"time_cutoff": "2023-11-07T05:31:56Z",
"tags": [
{
"tag_key": "<string>",
"tag_value": "<string>"
}
],
"kg_entities": [
"<string>"
],
"kg_relationships": [
"<string>"
],
"kg_terms": [
"<string>"
],
"kg_sources": [
"<string>"
],
"kg_chunk_id_zero_only": false
},
"enable_auto_detect_filters": true,
"offset": 123,
"limit": 123,
"dedupe_docs": false
},
"query_override": "<string>",
"search_doc_ids": [
123
],
"structured_response_format": {},
"use_agentic_search": false
}
'{
"answer": "<string>",
"answer_citationless": "<string>",
"top_documents": [
{
"document_id": "<string>",
"chunk_ind": 123,
"semantic_identifier": "<string>",
"blurb": "<string>",
"source_type": "ingestion_api",
"boost": 123,
"hidden": true,
"metadata": {},
"match_highlights": [
"<string>"
],
"db_doc_id": 123,
"link": "<string>",
"score": 0,
"is_relevant": true,
"relevance_explanation": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"primary_owners": [
"<string>"
],
"secondary_owners": [
"<string>"
],
"is_internet": false
}
],
"error_msg": "<string>",
"message_id": 123,
"cited_documents": {}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
If a chat_session_id is not provided, a persona_id must be provided to automatically create a new chat session Note, for simplicity this option only allows for a single linear chain of messages
Show child attributes
always, never, auto Show child attributes
ingestion_api, slack, web, google_drive, gmail, requesttracker, github, gitbook, gitlab, guru, bookstack, confluence, jira, slab, productboard, file, notion, zulip, linear, hubspot, document360, gong, google_sites, zendesk, loopio, dropbox, sharepoint, teams, salesforce, discourse, axero, clickup, mediawiki, wikipedia, asana, s3, r2, google_cloud_storage, oci_storage, xenforo, not_applicable, discord, freshdesk, fireflies, egnyte, airtable, highspot, imap, mock_connector Successful Response
Show child attributes
ingestion_api, slack, web, google_drive, gmail, requesttracker, github, gitbook, gitlab, guru, bookstack, confluence, jira, slab, productboard, file, notion, zulip, linear, hubspot, document360, gong, google_sites, zendesk, loopio, dropbox, sharepoint, teams, salesforce, discourse, axero, clickup, mediawiki, wikipedia, asana, s3, r2, google_cloud_storage, oci_storage, xenforo, not_applicable, discord, freshdesk, fireflies, egnyte, airtable, highspot, imap, mock_connector Was this page helpful?