Olark Box API

openapi: 3.1.0
info:
  title: Olark JavaScript Box API
  description: 'Olark exposes a browser-side JavaScript API for embedding and controlling

    the Olark live-chat widget. It is not a server REST API; this OpenAPI

    document describes the JavaScript API surface as documented at

    https://www.olark.com/api by treating each `olark(''api.<area>.<method>'')`

    invocation as a logical operation under a synthetic `/api/...` path so

    that the contract can be navigated alongside conventional REST APIs.

    Authentication is performed client-side via the Olark site identifier

    passed to `olark.identify(siteId)`.

    '
  version: 1.0.0
  contact:
    name: Olark
    url: https://www.olark.com/api
servers:
- url: https://www.olark.com/api
  description: Olark JavaScript API documentation host (logical base for this spec)
security:
- OlarkSiteId: []
tags:
- name: Box
  description: Chatbox visibility and lifecycle
paths:
  /box/show:
    post:
      tags:
      - Box
      summary: api.box.show
      responses:
        '200':
          description: Chatbox shown
  /box/hide:
    post:
      tags:
      - Box
      summary: api.box.hide
      responses:
        '200':
          description: Chatbox hidden
  /box/expand:
    post:
      tags:
      - Box
      summary: api.box.expand
      responses:
        '200':
          description: Chatbox expanded
  /box/shrink:
    post:
      tags:
      - Box
      summary: api.box.shrink
      responses:
        '200':
          description: Chatbox shrunk
  /box/setLocale:
    post:
      tags:
      - Box
      summary: api.box.setLocale
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                locale:
                  type: string
      responses:
        '200':
          description: Locale applied
components:
  securitySchemes:
    OlarkSiteId:
      type: apiKey
      in: query
      name: site_id
      description: 'Olark identifies an installation via a public site identifier

        (e.g. `1234-456-78-9810`) passed client-side to `olark.identify()`.

        It is not a secret and is included here only to make the

        identification mechanism explicit in the OpenAPI contract.

        '