Olark

Olark Box API

Chatbox visibility and lifecycle

GitHub OpenAPI

Operations 5

POST /box/show api.box.show
POST /box/hide api.box.hide
POST /box/expand api.box.expand
POST /box/shrink api.box.shrink
POST /box/setLocale api.box.setLocale

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/olark/refs/heads/main/openapi/olark-box-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/olark-box-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

olark-box-api-openapi.yml Raw ↑ 
openapi: 3.2.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.

        '