PostHog session_summaries API

openapi: 3.0.3
info:
  title: PostHog actions session_summaries API
  version: 1.0.0
  description: ''
tags:
- name: session_summaries
paths:
  /api/environments/{project_id}/session_summaries/config/:
    get:
      operationId: retrieve_session_summaries_config
      description: Retrieve the team's session summaries configuration (product context used to tailor single-session replay summaries).
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - session_summaries
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionSummariesConfig'
          description: ''
      x-explicit-tags: []
    patch:
      operationId: update_session_summaries_config
      description: Update the team's session summaries configuration (product context used to tailor single-session replay summaries).
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - session_summaries
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedSessionSummariesConfig'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedSessionSummariesConfig'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedSessionSummariesConfig'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionSummariesConfig'
          description: ''
      x-explicit-tags: []
  /api/environments/{project_id}/session_summaries/create_session_summaries/:
    post:
      operationId: create_session_summaries
      description: Generate AI summary for a group of session recordings to find patterns and generate a notebook.
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - session_summaries
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SessionSummaries'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SessionSummaries'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SessionSummaries'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - session_recording:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionSummaries'
          description: ''
      x-explicit-tags: []
  /api/environments/{project_id}/session_summaries/create_session_summaries_individually/:
    post:
      operationId: create_session_summaries_individually
      description: Generate AI individual summary for each session, without grouping.
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - session_summaries
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SessionSummaries'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SessionSummaries'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SessionSummaries'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - session_recording:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionSummaries'
          description: ''
      x-explicit-tags:
      - replay
components:
  schemas:
    PatchedSessionSummariesConfig:
      type: object
      properties:
        product_context:
          type: string
          description: Free-form description of the team's product, used to tailor AI-generated single-session replay summaries. Injected into the system prompt of every summary generated for this team via the replay page.
          maxLength: 10000
    SessionSummaries:
      type: object
      properties:
        session_ids:
          type: array
          items:
            type: string
          description: List of session IDs to summarize (max 300)
          maxItems: 300
          minItems: 1
        focus_area:
          type: string
          description: Optional focus area for the summarization
          maxLength: 500
      required:
      - session_ids
    SessionSummariesConfig:
      type: object
      properties:
        product_context:
          type: string
          description: Free-form description of the team's product, used to tailor AI-generated single-session replay summaries. Injected into the system prompt of every summary generated for this team via the replay page.
          maxLength: 10000
  parameters:
    ProjectIdPath:
      in: path
      name: project_id
      required: true
      schema:
        type: string
      description: Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
  securitySchemes:
    PersonalAPIKeyAuth:
      type: http
      scheme: bearer
x-tagGroups:
- name: All endpoints
  tags:
  - LLM Analytics
  - actions
  - activity_log
  - activity_logs
  - advanced_activity_logs
  - alerts
  - annotations
  - approval_policies
  - batch_exports
  - cdp
  - change_requests
  - code
  - code-invites
  - cohorts
  - comments
  - conversations
  - core
  - customer_analytics
  - customer_journeys
  - customer_profile_configs
  - dashboard_templates
  - dashboards
  - data_color_themes
  - data_modeling_jobs
  - data_warehouse
  - dataset_items
  - datasets
  - desktop_recordings
  - domains
  - early_access_feature
  - early_access_features
  - elements
  - endpoints
  - environments
  - error_tracking
  - evaluation_runs
  - evaluations
  - event_definitions
  - event_filter
  - event_schemas
  - events
  - experiment_holdouts
  - experiment_saved_metrics
  - experiments
  - exports
  - external_data_schemas
  - external_data_sources
  - feature_flags
  - file_system
  - file_system_shortcut
  - flag_value
  - groups
  - groups_types
  - health_issues
  - heatmap_screenshots
  - heatmaps
  - hog_flows
  - hog_function_templates
  - hog_functions
  - insight_variables
  - insights
  - integrations
  - invites
  - js-snippet
  - legal_documents
  - lineage
  - live_debugger_breakpoints
  - llm_analytics
  - llm_prompts
  - llm_skills
  - logs
  - managed_viewsets
  - max
  - max_tools
  - mcp_server_installations
  - mcp_servers
  - mcp_store
  - mcp_tools
  - members
  - notebooks
  - oauth_applications
  - object_media_previews
  - organizations
  - persisted_folder
  - persons
  - platform_features
  - plugin_configs
  - product_analytics
  - product_tours
  - project_secret_api_keys
  - projects
  - property_definitions
  - proxy_records
  - public_hog_function_templates
  - query
  - replay
  - reverse_proxy
  - role_external_references
  - roles
  - sandbox-environments
  - sandbox_environments
  - saved
  - schema_property_groups
  - sdk_doctor
  - session_group_summaries
  - session_recording_playlists
  - session_recordings
  - session_summaries
  - sessions
  - signals
  - subscriptions
  - surveys
  - taggers
  - task-automations
  - task-runs
  - task_automations
  - tasks
  - uploaded_media
  - user_home_settings
  - user_interviews
  - users
  - visual_review
  - warehouse_dag
  - warehouse_model_paths
  - warehouse_saved_queries
  - warehouse_saved_query_folders
  - warehouse_tables
  - warehouse_view_link
  - warehouse_view_links
  - web_analytics
  - web_experiments
  - web_vitals
  - welcome
  - workflows