> ## Documentation Index
> Fetch the complete documentation index at: https://docs.findable.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a single chat log by ID



## OpenAPI

````yaml /api-reference/openapi.json get /user/chatlogs/{id}
openapi: 3.0.3
info:
  title: Findable API
  version: 3.2.38
  description: >
    REST API for the Findable AI Assistant platform.


    ## Authentication


    All endpoints (except `/server/setup` and `/server/bootstrap`) require a
    valid **Azure AD / Entra ID Bearer token**.


    ### Obtaining a token


    1. Register (or reuse) an **App Registration** in Azure Entra ID for your
    client.

    2. Under **API Permissions**, add a delegated permission for the Findable
    server app:
       `api://<SERVER_CLIENT_ID>/User.Read`
    3. Acquire a token using MSAL (or any OAuth 2.0 library) with the following
    parameters:


    | Parameter | Value |

    |-----------|-------|

    | Authority | `https://login.microsoftonline.com/<TENANT_ID>` |

    | Client ID | Your client app registration ID |

    | Scope | `api://<SERVER_CLIENT_ID>/User.Read` |

    | Grant type | Authorization Code (interactive) or Client Credentials
    (daemon) |


    ### Example (MSAL Node.js)


    ```javascript

    const { ConfidentialClientApplication } = require("@azure/msal-node");


    const cca = new ConfidentialClientApplication({
      auth: {
        clientId: "<YOUR_CLIENT_ID>",
        authority: "https://login.microsoftonline.com/<TENANT_ID>",
        clientSecret: "<YOUR_CLIENT_SECRET>",
      },
    });


    const result = await cca.acquireTokenByClientCredential({
      scopes: ["api://<SERVER_CLIENT_ID>/.default"],
    });


    // Use result.accessToken in the Authorization header

    ```


    ### Using the token


    Include the token in every request:

    ```

    Authorization: Bearer <access_token>

    ```


    ### Roles


    Access is determined by Azure AD group membership configured in the
    application settings:

    - **Admin (Owner)**: Full access to all endpoints including admin operations

    - **Contributor**: Can create and manage chats, files, and content

    - **User**: Read access to entitled chats and resources
  contact:
    name: Findable Support
  license:
    name: Proprietary
servers:
  - url: /server
    description: Application server (relative)
security:
  - BearerAuth: []
tags:
  - name: AI
    description: Chat completion and AI generation endpoints
  - name: Chats
    description: Chat configuration CRUD with ACL enforcement
  - name: Settings
    description: Application settings and health
  - name: Files
    description: Blob storage file operations
  - name: Search
    description: Azure AI Search resource management
  - name: User
    description: User profile, feedback, chat logs, and preferences
  - name: Flows
    description: FlowEngine flow designer operations
  - name: Prompts
    description: Prompt template management
  - name: Pages
    description: Navigation page management
  - name: Admin
    description: Administrative operations (admin-only)
  - name: Bootstrap
    description: Bootstrap seed data operations (admin-only)
  - name: Setup
    description: Initial application setup (pre-auth)
  - name: Cosmos
    description: Generic Cosmos DB CRUD operations
  - name: Tools
    description: Tool providers, web search, and utility tools
  - name: MCP
    description: Model Context Protocol server management
  - name: Telemetry
    description: Version, health, and API permission checks
  - name: SharePoint
    description: SharePoint entitlement management
  - name: Data Platform
    description: Data platform connection management
  - name: Vector Stores
    description: Vector store provider operations
  - name: OneDrive
    description: OneDrive personal file storage operations
  - name: Jobs
    description: Background job and scheduler management
  - name: Memory
    description: User and organizational memory operations
  - name: Slack
    description: >-
      Slack bot interactions and webhooks (public, uses Slack signature
      verification)
  - name: Teams
    description: Microsoft Teams bot webhooks and interactions
  - name: Human Input
    description: Human-in-the-loop input requests for flow executions
  - name: Datasources
    description: Datasource catalog CRUD with ACL enforcement
  - name: Assignments
    description: >-
      Assignment lifecycle: inbox, sent, create, launch, complete, delegate,
      reject, reassign, remind, and recurring schedules. Experimental feature —
      requires experimental flag enabled.
paths:
  /user/chatlogs/{id}:
    get:
      tags:
        - User
      summary: Get a single chat log by ID
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Chat log found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatLog'
        '404':
          description: Chat log not found or access denied
components:
  schemas:
    ChatLog:
      type: object
      properties:
        id:
          type: string
          description: Chat log ID (UUID)
        email:
          type: string
          description: >-
            Owner's email / UPN (Cosmos partition key). Always set server-side
            from the authenticated user.
        chatHistory:
          type: array
          items:
            type: object
            properties:
              role:
                type: string
                enum:
                  - system
                  - user
                  - assistant
                description: OpenAI-style message role
              content:
                type: string
              citations:
                description: Citation references attached to an assistant message
                nullable: true
                type: array
                items:
                  type: string
              timestamp:
                description: Unix timestamp in milliseconds
                type: integer
              messageType:
                description: 'Rich message kind (default: message)'
                type: string
                enum:
                  - message
                  - human_input_prompt
                  - prompt_response
                  - inline_buttons
                  - message_notification
                  - sources_unavailable
              humanInputData:
                description: >-
                  Human-input request payload (when messageType ===
                  human_input_prompt)
                type: object
                additionalProperties: {}
              promptResponseData:
                description: >-
                  Submitted prompt response (when messageType ===
                  prompt_response)
                type: object
                additionalProperties: {}
              toolActivities:
                description: Tool call activity persisted by the flow engine
                type: array
                items:
                  type: object
                  additionalProperties: {}
              thinkingText:
                description: Model reasoning text captured during generation
                type: string
              scopedChatData:
                description: Scoped-chat context payload
                type: object
                additionalProperties: {}
              inlineButtonsData:
                description: >-
                  Inline button definitions (when messageType ===
                  inline_buttons)
                type: object
                additionalProperties: {}
              messageNotificationData:
                description: >-
                  Notification payload (when messageType ===
                  message_notification)
                type: object
                additionalProperties: {}
              workflowInvitationData:
                description: Workflow invitation card data
                type: object
                properties:
                  title:
                    type: string
                  description:
                    type: string
                  started:
                    type: boolean
                required:
                  - title
                additionalProperties: false
              entryPromptData:
                description: Entry prompt form data for flow-variable collection
                type: object
                properties:
                  prompt:
                    description: Prompt template shown as the entry form
                  isReminder:
                    type: boolean
                  filledValues:
                    nullable: true
                    type: object
                    additionalProperties: {}
                additionalProperties: false
            required:
              - role
              - content
            additionalProperties: false
            title: ChatLogMessage
            description: A single persisted message within a chat log
          description: Ordered conversation messages
        title:
          description: >-
            AI-generated title for the chat session (generated asynchronously
            after create/update)
          type: string
        chatTitle:
          description: >-
            Parent chat name (e.g. "My Workspace" for personal, chat tab title
            for shared)
          type: string
        dataSourceName:
          type: string
          description: Display name of the data source at log-write time
        dataSourceType:
          type: string
          description: >-
            DATASOURCE_TYPE at log-write time (shared, personal, workspace,
            sharepoint, ...)
        dataSourceId:
          type: string
        chatId:
          type: string
          description: >-
            Source chat ID — ephemeral workspace session ID for workspace chats,
            persisted chat ID for shared chats
        isWorkspace:
          description: >-
            True when produced by the ephemeral cross-chat workspace session —
            authoritative chat-kind signal on rehydrate
          type: boolean
        aiOptions:
          type: object
          properties:
            maxTokens:
              type: integer
            topP:
              type: number
            temperature:
              type: number
            topNDocuments:
              type: integer
            systemPrompt:
              type: string
            filter:
              type: string
          additionalProperties: false
          title: ChatLogAIOptions
          description: AI inference options captured at log-write time
        hasHumanInput:
          description: True if any message is human_input_prompt or prompt_response
          type: boolean
        humanInputCount:
          description: Count of prompt_response messages
          type: integer
        promptIds:
          description: All promptTemplateIds referenced in this chat log
          type: array
          items:
            type: string
        createdAt:
          description: ISO-8601 creation timestamp (set server-side)
          type: string
        updatedAt:
          description: ISO-8601 update timestamp (set server-side)
          type: string
        _ts:
          description: Cosmos DB last-modified timestamp (epoch seconds)
          type: integer
      required:
        - id
        - email
        - chatHistory
        - dataSourceName
        - dataSourceType
        - dataSourceId
        - chatId
        - aiOptions
      additionalProperties: false
      title: ChatLog
      description: A persisted chat session (conversation transcript + source/AI metadata)
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Azure AD access token obtained via MSAL

````