Skip to main content

Avaamo API for Python

Project description

Avaamo API for Python

  • Provides Python Bindings for Avaamo APIs
  • Command Line tools for accessing APIs


  • Python version 3.6 or later
  • Requests library 2.21 or later


This installs the Avaamo code into your python environment

$ pip install avaamo

A best practice is to create a separate virtual python environment for each of your python application which is described here


Configuration is passed via environment variables as follows (example data displayed):

export AVAAMO_ACCESS_TOKEN=7358b733270342559cb736b04a80c490
export AVAAMO_BOT_ID=5051


AVAAMO_ENVPOINT is the host name where your account resides AVAAMO_ACCESS_TOKEN is the API access token for a specific user from settings in your account

Command Line Tools

Add a document to existing Avaamo Answers Knowledge Pack

usage: avaamo-add-doc [-h] -a access_token -n endpoint -b bot_id -e
                       YYYY-MM-DD -s YYYY-MM-DD

Extract analytics data

optional arguments:
  -h, --help            show this help message and exit
  -a access_token, --access-token access_token
                        API access token
  -n endpoint, --endpoint endpoint
                        API endpoint or domain name
  -b bot_id, --bot-id bot_id
                        Specifies the bot to export data from
  -e YYYY-MM-DD, --end-dt YYYY-MM-DD
                        End Date
  -s YYYY-MM-DD, --start-dt YYYY-MM-DD
                        Start Date

Analytics Data

See Analytics Data for detail information on the contents provide by the anlytic APIs.

See Extracting for a procedure on how use the tools to extract the analytics data

Upload Document

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

avaamo-0.1.2.tar.gz (16.3 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page