---
title: "Get Chat Session"
method: GET
path: "/chat/get-chat-session/{session_id}"
tags: ["public"]
---

# Get Chat Session

`GET /chat/get-chat-session/{session_id}`

## Path parameters

- `session_id` string, uuid, required

## Query parameters

- `is_shared` boolean
- `include_deleted` boolean

## Response `200`

Successful Response

- ChatSessionDetailResponse
  - `chat_session_id` string, uuid, required
  - `description` string, nullable, required
  - `persona_id` integer, nullable
  - `persona_name` string, nullable, required
  - `personal_icon_name` string, nullable, required
  - `messages` ChatMessageDetail[], required
    - `chat_session_id` string, uuid, nullable
    - `message_id` integer, required
    - `parent_message` integer, nullable
    - `latest_child_message` integer, nullable
    - `message` string, required
    - `reasoning_tokens` string, nullable
    - `message_type` 'system' | 'user' | 'assistant' | 'tool_call' | 'tool_call_response', required
    - `context_docs` SavedSearchDoc[], nullable
      - `document_id` string, required
      - `chunk_ind` integer, required
      - `semantic_identifier` string, required
      - `link` string, nullable
      - `blurb` string, required
      - `source_type` 'ingestion_api' | 'slack' | 'web' | 'google_drive' | 'gmail' | 'requesttracker' | 'github' | 'gitbook' | 'gitlab' | 'guru' | 'bookstack' | 'outline' | 'confluence' | 'jira' | 'slab' | 'productboard' | 'file' | 'coda' | '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' | 'drupal_wiki' | 'imap' | 'bitbucket' | 'testrail' | 'mock_connector' | 'user_file', required
      - `boost` integer, required
      - `hidden` boolean, required
      - `metadata` object, required
      - `score` number, nullable
      - `is_relevant` boolean, nullable
      - `relevance_explanation` string, nullable
      - `match_highlights` string[], required
      - `updated_at` string, date-time, nullable
      - `primary_owners` string[], nullable
      - `secondary_owners` string[], nullable
      - `is_internet` boolean
      - `db_doc_id` integer, required
    - `citations` object, nullable
    - `time_sent` string, date-time, required
    - `files` FileDescriptor[], required
      - `id` string, required
      - `type` 'image' | 'document' | 'plain_text' | 'csv', required
      - `name` string, nullable
      - `user_file_id` string, nullable
    - `error` string, nullable
    - `current_feedback` string, nullable
  - `time_created` string, date-time, required
  - `shared_status` 'public' | 'private', required
  - `current_alternate_model` string, nullable, required
  - `current_temperature_override` number, nullable, required
  - `deleted` boolean
  - `packets` array[], required
    - Packet[]
      - `placement` Placement, required
        - `turn_index` integer, required
        - `tab_index` integer
        - `sub_turn_index` integer, nullable
      - `obj` union, required
        - OverallStop
          - `type` 'stop'
          - `stop_reason` string, nullable
        - SectionEnd
          - `type` 'section_end'
        - TopLevelBranching
          - `type` 'top_level_branching'
          - `num_parallel_branches` integer, required
        - AgentResponseStart
          - `type` 'message_start'
          - `final_documents` SearchDoc[], nullable
            - `document_id` string, required
            - `chunk_ind` integer, required
            - `semantic_identifier` string, required
            - `link` string, nullable
            - `blurb` string, required
            - `source_type` 'ingestion_api' | 'slack' | 'web' | 'google_drive' | 'gmail' | 'requesttracker' | 'github' | 'gitbook' | 'gitlab' | 'guru' | 'bookstack' | 'outline' | 'confluence' | 'jira' | 'slab' | 'productboard' | 'file' | 'coda' | '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' | 'drupal_wiki' | 'imap' | 'bitbucket' | 'testrail' | 'mock_connector' | 'user_file', required
            - `boost` integer, required
            - `hidden` boolean, required
            - `metadata` object, required
            - `score` number, nullable
            - `is_relevant` boolean, nullable
            - `relevance_explanation` string, nullable
            - `match_highlights` string[], required
            - `updated_at` string, date-time, nullable
            - `primary_owners` string[], nullable
            - `secondary_owners` string[], nullable
            - `is_internet` boolean
        - AgentResponseDelta
          - `type` 'message_delta'
          - `content` string, required
        - SearchToolStart
          - `type` 'search_tool_start'
          - `is_internet_search` boolean
        - SearchToolQueriesDelta
          - `type` 'search_tool_queries_delta'
          - `queries` string[], required
        - SearchToolDocumentsDelta
          - `type` 'search_tool_documents_delta'
          - `documents` SearchDoc[], required
            - `document_id` string, required
            - `chunk_ind` integer, required
            - `semantic_identifier` string, required
            - `link` string, nullable
            - `blurb` string, required
            - `source_type` 'ingestion_api' | 'slack' | 'web' | 'google_drive' | 'gmail' | 'requesttracker' | 'github' | 'gitbook' | 'gitlab' | 'guru' | 'bookstack' | 'outline' | 'confluence' | 'jira' | 'slab' | 'productboard' | 'file' | 'coda' | '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' | 'drupal_wiki' | 'imap' | 'bitbucket' | 'testrail' | 'mock_connector' | 'user_file', required
            - `boost` integer, required
            - `hidden` boolean, required
            - `metadata` object, required
            - `score` number, nullable
            - `is_relevant` boolean, nullable
            - `relevance_explanation` string, nullable
            - `match_highlights` string[], required
            - `updated_at` string, date-time, nullable
            - `primary_owners` string[], nullable
            - `secondary_owners` string[], nullable
            - `is_internet` boolean
        - ImageGenerationToolStart
          - `type` 'image_generation_start'
        - ImageGenerationToolHeartbeat
          - `type` 'image_generation_heartbeat'
        - ImageGenerationFinal
          - `type` 'image_generation_final'
          - `images` GeneratedImage[], required
            - `file_id` string, required
            - `url` string, required
            - `revised_prompt` string, required
            - `shape` string, nullable
        - OpenUrlStart — Signal that OpenURL tool has started.
          - `type` 'open_url_start'
        - OpenUrlUrls — URLs to be fetched (sent before crawling begins).
          - `type` 'open_url_urls'
          - `urls` string[], required
        - OpenUrlDocuments — Final documents after crawling completes.
          - `type` 'open_url_documents'
          - `documents` SearchDoc[], required
            - `document_id` string, required
            - `chunk_ind` integer, required
            - `semantic_identifier` string, required
            - `link` string, nullable
            - `blurb` string, required
            - `source_type` 'ingestion_api' | 'slack' | 'web' | 'google_drive' | 'gmail' | 'requesttracker' | 'github' | 'gitbook' | 'gitlab' | 'guru' | 'bookstack' | 'outline' | 'confluence' | 'jira' | 'slab' | 'productboard' | 'file' | 'coda' | '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' | 'drupal_wiki' | 'imap' | 'bitbucket' | 'testrail' | 'mock_connector' | 'user_file', required
            - `boost` integer, required
            - `hidden` boolean, required
            - `metadata` object, required
            - `score` number, nullable
            - `is_relevant` boolean, nullable
            - `relevance_explanation` string, nullable
            - `match_highlights` string[], required
            - `updated_at` string, date-time, nullable
            - `primary_owners` string[], nullable
            - `secondary_owners` string[], nullable
            - `is_internet` boolean
        - PythonToolStart
          - `type` 'python_tool_start'
          - `code` string, required
        - PythonToolDelta
          - `type` 'python_tool_delta'
          - `stdout` string
          - `stderr` string
          - `file_ids` string[]
        - CustomToolStart
          - `type` 'custom_tool_start'
          - `tool_name` string, required
        - CustomToolDelta
          - `type` 'custom_tool_delta'
          - `tool_name` string, required
          - `response_type` string, required
          - `data` union
            - object
            - unknown[]
              - …
            - string
            - integer
            - number
            - boolean
          - `file_ids` string[], nullable
        - ReasoningStart
          - `type` 'reasoning_start'
        - ReasoningDelta
          - `type` 'reasoning_delta'
          - `reasoning` string, required
        - ReasoningDone
          - `type` 'reasoning_done'
        - CitationInfo
          - `type` 'citation_info'
          - `citation_number` integer, required
          - `document_id` string, required
        - DeepResearchPlanStart
          - `type` 'deep_research_plan_start'
        - DeepResearchPlanDelta
          - `type` 'deep_research_plan_delta'
          - `content` string, required
        - ResearchAgentStart
          - `type` 'research_agent_start'
          - `research_task` string, required
        - IntermediateReportStart
          - `type` 'intermediate_report_start'
        - IntermediateReportDelta
          - `type` 'intermediate_report_delta'
          - `content` string, required
        - IntermediateReportCitedDocs
          - `type` 'intermediate_report_cited_docs'
          - `cited_docs` SearchDoc[], nullable
            - `document_id` string, required
            - `chunk_ind` integer, required
            - `semantic_identifier` string, required
            - `link` string, nullable
            - `blurb` string, required
            - `source_type` 'ingestion_api' | 'slack' | 'web' | 'google_drive' | 'gmail' | 'requesttracker' | 'github' | 'gitbook' | 'gitlab' | 'guru' | 'bookstack' | 'outline' | 'confluence' | 'jira' | 'slab' | 'productboard' | 'file' | 'coda' | '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' | 'drupal_wiki' | 'imap' | 'bitbucket' | 'testrail' | 'mock_connector' | 'user_file', required
            - `boost` integer, required
            - `hidden` boolean, required
            - `metadata` object, required
            - `score` number, nullable
            - `is_relevant` boolean, nullable
            - `relevance_explanation` string, nullable
            - `match_highlights` string[], required
            - `updated_at` string, date-time, nullable
            - `primary_owners` string[], nullable
            - `secondary_owners` string[], nullable
            - `is_internet` boolean

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/onyx-dot-app/apis/onyx-api.md) · [All operations](https://skmtc.net/onyx-dot-app/apis/onyx-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onyx-dot-app/onyx-api/versions/027af016ba5c/schema)