PostHog max API

openapi: 3.0.3
info:
  title: PostHog actions max API
  version: 1.0.0
  description: ''
tags:
- name: max
paths:
  /api/environments/{project_id}/conversations/:
    get:
      operationId: conversations_list
      parameters:
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - max
      security:
      - PersonalAPIKeyAuth:
        - conversation:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedConversationMinimalList'
          description: ''
      x-explicit-tags:
      - max
    post:
      operationId: conversations_create
      description: 'Unified endpoint that handles both conversation creation and streaming.


        - If message is provided: Start new conversation processing

        - If no message: Stream from existing conversation'
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - max
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Message'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Message'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Message'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - conversation:write
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Message'
          description: ''
      x-explicit-tags:
      - max
  /api/environments/{project_id}/conversations/{conversation}/:
    get:
      operationId: conversations_retrieve
      parameters:
      - in: path
        name: conversation
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this conversation.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - max
      security:
      - PersonalAPIKeyAuth:
        - conversation:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Conversation'
          description: ''
      x-explicit-tags:
      - max
  /api/environments/{project_id}/conversations/{conversation}/append_message/:
    post:
      operationId: conversations_append_message_create
      description: 'Appends a message to an existing conversation without triggering AI processing.

        This is used for client-side generated messages that need to be persisted

        (e.g., support ticket confirmation messages).'
      parameters:
      - in: path
        name: conversation
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this conversation.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - max
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MessageMinimal'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/MessageMinimal'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/MessageMinimal'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageMinimal'
          description: ''
      x-explicit-tags:
      - max
  /api/environments/{project_id}/conversations/{conversation}/cancel/:
    patch:
      operationId: conversations_cancel_partial_update
      parameters:
      - in: path
        name: conversation
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this conversation.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - max
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedConversation'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedConversation'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedConversation'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Conversation'
          description: ''
      x-explicit-tags:
      - max
  /api/environments/{project_id}/conversations/{conversation}/queue/:
    get:
      operationId: conversations_queue_retrieve
      parameters:
      - in: path
        name: conversation
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this conversation.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - max
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Conversation'
          description: ''
      x-explicit-tags:
      - max
    post:
      operationId: conversations_queue_create
      parameters:
      - in: path
        name: conversation
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this conversation.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - max
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Conversation'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Conversation'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Conversation'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Conversation'
          description: ''
      x-explicit-tags:
      - max
  /api/environments/{project_id}/conversations/{conversation}/queue/{queue_id}/:
    patch:
      operationId: conversations_queue_partial_update
      parameters:
      - in: path
        name: conversation
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this conversation.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      - in: path
        name: queue_id
        schema:
          type: string
        required: true
      tags:
      - max
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedConversation'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedConversation'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedConversation'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Conversation'
          description: ''
      x-explicit-tags:
      - max
    delete:
      operationId: conversations_queue_destroy
      parameters:
      - in: path
        name: conversation
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this conversation.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      - in: path
        name: queue_id
        schema:
          type: string
        required: true
      tags:
      - max
      responses:
        '204':
          description: No response body
      x-explicit-tags:
      - max
  /api/environments/{project_id}/conversations/{conversation}/queue/clear/:
    post:
      operationId: conversations_queue_clear_create
      parameters:
      - in: path
        name: conversation
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this conversation.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - max
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Conversation'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Conversation'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Conversation'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Conversation'
          description: ''
      x-explicit-tags:
      - max
components:
  schemas:
    ConversationType:
      enum:
      - assistant
      - tool_call
      - deep_research
      - slack
      type: string
      description: '* `assistant` - Assistant

        * `tool_call` - Tool call

        * `deep_research` - Deep research

        * `slack` - Slack'
    BlankEnum:
      enum:
      - ''
    UserBasic:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        uuid:
          type: string
          format: uuid
          readOnly: true
        distinct_id:
          type: string
          nullable: true
          maxLength: 200
        first_name:
          type: string
          maxLength: 150
        last_name:
          type: string
          maxLength: 150
        email:
          type: string
          format: email
          title: Email address
          maxLength: 254
        is_email_verified:
          type: boolean
          nullable: true
        hedgehog_config:
          type: object
          additionalProperties: true
          nullable: true
          readOnly: true
        role_at_organization:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/RoleAtOrganizationEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
      required:
      - email
      - hedgehog_config
      - id
      - uuid
    Conversation:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        status:
          allOf:
          - $ref: '#/components/schemas/ConversationStatus'
          readOnly: true
        title:
          type: string
          readOnly: true
          nullable: true
          description: Title of the conversation.
        user:
          allOf:
          - $ref: '#/components/schemas/UserBasic'
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        type:
          allOf:
          - $ref: '#/components/schemas/ConversationType'
          readOnly: true
        is_internal:
          type: boolean
          readOnly: true
          nullable: true
          description: Whether this conversation was created during an impersonated session (e.g., by support agents). Internal conversations are hidden from customers.
        slack_thread_key:
          type: string
          readOnly: true
          nullable: true
          description: 'Unique key for Slack thread: ''{workspace_id}:{channel}:{thread_ts}'''
        slack_workspace_domain:
          type: string
          readOnly: true
          nullable: true
          description: Slack workspace subdomain (e.g. 'posthog' for posthog.slack.com)
        messages:
          type: array
          items:
            type: object
            additionalProperties: true
          readOnly: true
        has_unsupported_content:
          type: boolean
          readOnly: true
        agent_mode:
          type: string
          nullable: true
          readOnly: true
        is_sandbox:
          type: boolean
          readOnly: true
        pending_approvals:
          type: array
          items:
            type: object
            additionalProperties: true
          description: 'Return pending approval cards as structured data.


            Combines metadata from conversation.approval_decisions with payload from checkpoint

            interrupts (single source of truth for payload data).'
          readOnly: true
      required:
      - agent_mode
      - created_at
      - has_unsupported_content
      - id
      - is_internal
      - is_sandbox
      - messages
      - pending_approvals
      - slack_thread_key
      - slack_workspace_domain
      - status
      - title
      - type
      - updated_at
      - user
    ConversationStatus:
      enum:
      - idle
      - in_progress
      - canceling
      type: string
      description: '* `idle` - Idle

        * `in_progress` - In progress

        * `canceling` - Canceling'
    MessageMinimal:
      type: object
      description: Serializer for appending a message to an existing conversation without triggering AI processing.
      properties:
        content:
          type: string
          maxLength: 10000
      required:
      - content
    RoleAtOrganizationEnum:
      enum:
      - engineering
      - data
      - product
      - founder
      - leadership
      - marketing
      - sales
      - other
      type: string
      description: '* `engineering` - Engineering

        * `data` - Data

        * `product` - Product Management

        * `founder` - Founder

        * `leadership` - Leadership

        * `marketing` - Marketing

        * `sales` - Sales / Success

        * `other` - Other'
    ConversationMinimal:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        status:
          allOf:
          - $ref: '#/components/schemas/ConversationStatus'
          readOnly: true
        title:
          type: string
          readOnly: true
          nullable: true
          description: Title of the conversation.
        user:
          allOf:
          - $ref: '#/components/schemas/UserBasic'
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        type:
          allOf:
          - $ref: '#/components/schemas/ConversationType'
          readOnly: true
        is_internal:
          type: boolean
          readOnly: true
          nullable: true
          description: Whether this conversation was created during an impersonated session (e.g., by support agents). Internal conversations are hidden from customers.
        slack_thread_key:
          type: string
          readOnly: true
          nullable: true
          description: 'Unique key for Slack thread: ''{workspace_id}:{channel}:{thread_ts}'''
        slack_workspace_domain:
          type: string
          readOnly: true
          nullable: true
          description: Slack workspace subdomain (e.g. 'posthog' for posthog.slack.com)
      required:
      - created_at
      - id
      - is_internal
      - slack_thread_key
      - slack_workspace_domain
      - status
      - title
      - type
      - updated_at
      - user
    PaginatedConversationMinimalList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?offset=400&limit=100
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?offset=200&limit=100
        results:
          type: array
          items:
            $ref: '#/components/schemas/ConversationMinimal'
    AgentModeEnum:
      enum:
      - product_analytics
      - sql
      - session_replay
      - error_tracking
      - plan
      - execution
      - survey
      - research
      - flags
      - llm_analytics
      - sandbox
      type: string
      description: '* `product_analytics` - product_analytics

        * `sql` - sql

        * `session_replay` - session_replay

        * `error_tracking` - error_tracking

        * `plan` - plan

        * `execution` - execution

        * `survey` - survey

        * `research` - research

        * `flags` - flags

        * `llm_analytics` - llm_analytics

        * `sandbox` - sandbox'
    PatchedConversation:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        status:
          allOf:
          - $ref: '#/components/schemas/ConversationStatus'
          readOnly: true
        title:
          type: string
          readOnly: true
          nullable: true
          description: Title of the conversation.
        user:
          allOf:
          - $ref: '#/components/schemas/UserBasic'
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        type:
          allOf:
          - $ref: '#/components/schemas/ConversationType'
          readOnly: true
        is_internal:
          type: boolean
          readOnly: true
          nullable: true
          description: Whether this conversation was created during an impersonated session (e.g., by support agents). Internal conversations are hidden from customers.
        slack_thread_key:
          type: string
          readOnly: true
          nullable: true
          description: 'Unique key for Slack thread: ''{workspace_id}:{channel}:{thread_ts}'''
        slack_workspace_domain:
          type: string
          readOnly: true
          nullable: true
          description: Slack workspace subdomain (e.g. 'posthog' for posthog.slack.com)
        messages:
          type: array
          items:
            type: object
            additionalProperties: true
          readOnly: true
        has_unsupported_content:
          type: boolean
          readOnly: true
        agent_mode:
          type: string
          nullable: true
          readOnly: true
        is_sandbox:
          type: boolean
          readOnly: true
        pending_approvals:
          type: array
          items:
            type: object
            additionalProperties: true
          description: 'Return pending approval cards as structured data.


            Combines metadata from conversation.approval_decisions with payload from checkpoint

            interrupts (single source of truth for payload data).'
          readOnly: true
    Message:
      type: object
      description: Serializer for appending a message to an existing conversation without triggering AI processing.
      properties:
        content:
          type: string
          nullable: true
          maxLength: 40000
        conversation:
          type: string
          format: uuid
        contextual_tools:
          type: object
          additionalProperties: true
        ui_context: {}
        billing_context: {}
        trace_id:
          type: string
          format: uuid
        session_id:
          type: string
        agent_mode:
          $ref: '#/components/schemas/AgentModeEnum'
        is_sandbox:
          type: boolean
          default: false
        resume_payload:
          nullable: true
      required:
      - content
      - conversation
      - trace_id
    NullEnum:
      enum:
      - null
  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