GET
/
chat
/
get-chat-session
/
{session_id}
Get Chat Session Data by ID
curl --request GET \
  --url https://cloud.onyx.app/api/chat/get-chat-session/{session_id} \
  --header 'Authorization: Bearer <token>'
{
  "chat_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "persona_id": 123,
  "persona_name": "<string>",
  "persona_icon_color": "<string>",
  "persona_icon_shape": 123,
  "messages": [
    {
      "message_id": 123,
      "parent_message": 123,
      "latest_child_message": 123,
      "message": "<string>",
      "rephrased_query": "<string>",
      "context_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,
            "is_relevant": true,
            "relevance_explanation": "<string>",
            "match_highlights": [
              "<string>"
            ],
            "updated_at": "2023-11-07T05:31:56Z",
            "primary_owners": [
              "<string>"
            ],
            "secondary_owners": [
              "<string>"
            ],
            "is_internet": true,
            "db_doc_id": 123
          }
        ]
      },
      "message_type": "system",
      "time_sent": "2023-11-07T05:31:56Z",
      "overridden_model": "<string>",
      "alternate_assistant_id": 123,
      "chat_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "citations": {},
      "sub_questions": [
        {
          "level": 123,
          "level_question_num": 123,
          "question": "<string>",
          "answer": "<string>",
          "sub_queries": [
            {
              "query": "<string>",
              "query_id": 123,
              "doc_ids": [
                123
              ]
            }
          ],
          "context_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,
                "is_relevant": true,
                "relevance_explanation": "<string>",
                "match_highlights": [
                  "<string>"
                ],
                "updated_at": "2023-11-07T05:31:56Z",
                "primary_owners": [
                  "<string>"
                ],
                "secondary_owners": [
                  "<string>"
                ],
                "is_internet": true,
                "db_doc_id": 123
              }
            ]
          }
        }
      ],
      "files": [
        {
          "id": "<string>",
          "type": "image",
          "name": "<string>"
        }
      ],
      "tool_call": {
        "tool_name": "<string>",
        "tool_args": {},
        "tool_result": "<any>",
        "level": 123,
        "level_question_num": 123
      },
      "refined_answer_improvement": true,
      "is_agentic": true,
      "error": "<string>"
    }
  ],
  "time_created": "2023-11-07T05:31:56Z",
  "shared_status": "public",
  "current_alternate_model": "<string>",
  "current_temperature_override": 123,
  "deleted": false
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

session_id
string<uuid>
required

Query Parameters

is_shared
boolean
default:false
include_deleted
boolean
default:false

Response

200
application/json

Successful Response

The response is of type object.