Frontline Max Proactive API

openapi: 3.2.0
info:
  title: Public Max Proactive API
  version: 1.0.0
  description: 'Public API for accessing agents, flows, and analytics.


    ## Authentication


    The Public API supports two API key types. Pass the key as a Bearer token:


    ```

    Authorization: Bearer

    ```


    ### Account API key (GENERAL)


    Account-level key that acts on behalf of the entire account. Required for account-level endpoints unless noted otherwise.


    ### User API key (USER)


    User-level key tied to a specific user. Required for write operations and user-owned resources. **Also accepted on all account-level endpoints.**


    Each operation documents which key type(s) it accepts in its **Security** section.'
  license:
    name: Proprietary
    url: https://www.getfrontline.ai/terms-and-conditions
servers:
- url: https://prod-api.getfrontline.ai
tags:
- name: Max Proactive
  description: Control whether Max reaches out unprompted, on which channel, how often, and within which hours
paths:
  /public/v1/max/settings/proactive:
    get:
      summary: Get the Max proactive settings
      operationId: getMaxProactiveSettings
      description: 'Returns whether Max may reach out unprompted, and under what conditions: the channel it uses, how often it may interrupt, the hours it is allowed to write in, whether weekends are fair game, which events it reacts to, and free-form instructions on what is worth a nudge. Read-only — these settings govern when Max may act on its own, so they are changed in the app by the user themselves and cannot be written through the API. Requires a USER API key.'
      security:
      - userApiKey: []
      tags:
      - Max Proactive
      responses:
        '200':
          description: Proactive settings
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    enum:
                    - true
                    example: true
                  data:
                    type: object
                    properties:
                      enabled:
                        type: boolean
                        example: false
                      preferredChannel:
                        type: string
                        enum:
                        - AUTO
                        - WHATSAPP
                        - SLACK
                        example: AUTO
                      frequency:
                        type: string
                        enum:
                        - RELAXED
                        - BALANCED
                        - ACTIVE
                        example: RELAXED
                      deliveryWindowStart:
                        type: number
                        example: 1
                      deliveryWindowEnd:
                        type: number
                        example: 1
                      allowWeekends:
                        type: boolean
                        example: false
                      enabledEventTypes:
                        type: array
                        items:
                          type: string
                          enum:
                          - MEETING_COMPLETED_WITH_ACTION_ITEMS
                          example: MEETING_COMPLETED_WITH_ACTION_ITEMS
                      proactiveInstructions:
                        type: string
                        example: example
                      lastProactiveContactAt:
                        type:
                        - string
                        - 'null'
                        example: example
                    required:
                    - enabled
                    - preferredChannel
                    - frequency
                    - deliveryWindowStart
                    - deliveryWindowEnd
                    - allowWeekends
                    - enabledEventTypes
                    - proactiveInstructions
                    - lastProactiveContactAt
                required:
                - ok
                - data
        '401':
          description: Unauthorized — a USER API key is required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: The caller's Max profile has no proactive settings row
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      properties:
        ok:
          type: boolean
          enum:
          - false
          example: false
        error:
          $ref: '#/components/schemas/ErrorBody'
      required:
      - ok
      - error
    ErrorBody:
      type: object
      properties:
        code:
          type: string
          enum:
          - bad_request
          - unauthorized
          - forbidden
          - not_found
          - conflict
          - internal_error
          - cli_outdated
          - upgrade_required
          example: unauthorized
        message:
          type: string
          example: Detailed error message
        details:
          type: object
          description: 'Optional structured details. Validation errors include `{ issues: [...] }`.'
          example:
            issues:
            - path:
              - name
              message: String must contain at least 1 character(s)
              code: too_small
      required:
      - code
      - message
  securitySchemes:
    accountApiKey:
      type: http
      scheme: bearer
      bearerFormat: Account API Key
      description: Account-level API key (GENERAL). Authenticates on behalf of the entire account. Use for read-only and analytics endpoints marked as account-level in this documentation.
    userApiKey:
      type: http
      scheme: bearer
      bearerFormat: User API Key
      description: User-level API key (USER). Authenticates on behalf of a specific user. Required for write operations and user-owned resources. Also accepted on all account-level endpoints.
x-tagGroups:
- name: Agent Builder
  tags:
  - Agent Builder
  - Flows
  - Flow Variables
  - Intents
  - Agents
  - Agent Playbooks
- name: Workflows
  tags:
  - Workflows
  - Workflow Variables
- name: Campaigns
  tags:
  - Campaigns
  - Audiences
- name: Sequences
  tags:
  - Sequences
  - Email Templates
- name: Objects
  tags:
  - Objects
  - Object fields
  - Object options
  - Object record types
  - Object views
  - Object relations
  - Object rows
  - Object aggregations
  - Object activities
  - Object tasks
  - Object files
  - Object export
- name: Tables
  tags:
  - Tables
  - Table fields
  - Table options
  - Table rows
  - Table aggregations
  - Table activities
  - Table tasks
  - Table files
  - Table export
- name: Integrations
  tags:
  - Custom Tools
  - Incoming Webhooks
  - Workspace Connectors
  - Agent Channels
  - Integration Resources
- name: Knowledge
  tags:
  - Knowledge Bases
- name: Max
  tags:
  - Max Conversations
  - Max Meetings
  - Max Tasks
  - Max Playbooks
  - Max Settings
  - Max Proactive
  - Max Connectors
- name: Admin
  tags:
  - Account
  - Users
  - Billing
  - Data & Sync
  - Meeting Analytics
- name: Core
  tags:
  - AI Models
  - User Tasks
  - Guidance