COMPREHEND

API ACCESS & DOCUMENTATION OVERVIEW

This document provides details about Helios Life Enterprises’ Comprehend Voice Analytics API. We feed audio from a variety of companies’ events into our analytics engine. Clients may utilize this API to fetch results from our proprietary engine.

1. SETUP

AUTHENTICATION

The API authenticates against API keys. There are two methods to create an API key, we will generate keys for you. Let us know during onboarding how many keys are needed.

Once the API key is created, you may use it in any request to this API by including it in a header called x-api-key or query param key/api_key. Any generated clients from our OpenAPI spec will automatically include thisheader once configured.

2. ENDPOINTS

Base Path: https://comprehend.api.helioslife.ventures

v1/result/search

PARAMETERS

The API will return the latest 250 analysis results by default. Users can modify these results by using the following query parameters:

Parameter
Values Descriptions
product (required)
string Limit results to product line
version (required)
string Limit results to one version
ticker
string Limit results to a specific ticker.
time_field
event.published This field determines the context for sorting and searching in a time range. By defauit will be the 'event' time.
time_start
1SO-8601 string Earliest inclusive date time for search
time_end
1SO-8601 string Earliest exclusive date time for search
sort
asc.desc Sort results by datetirne field. Default to 'desc' for most result time first.
size
integer Max number of results per page. Default and max is 250
nextPage
string Allows you to fetch the next set Of results from a previous query. If this parameter is used. all other parameters are ignored. This parameter will be found on the provious response.
RESPONSE

Response will consist at the top level with two fields: data and meta.

Data will be an array of Result objects, while the meta will importantly have two fields. nextPage and size. The nextPage field can be used in the subsequent request to get the next page of data. If the nextPage field is empty, then there are no more responses.

EXAMPLE RESPONSE
DATETIME FORMATTING

Datetime passed as string parameters to the API are allowed to take several forms. You must have a date section followed by an optional time section separated by a T. Previous must be complete to take advantage of the subsequent. Any non passed information will be defaulted to the first of that section. Note for time zone even though you can pass us different offsets any response will return datetime in UTC. Formats include:

DATE
  • YYYY
  • YYYY-MM or YYYYMM
  • YYYY-MM-DD or YYYYMMDD
TIME
  • hh
  • hh:mm or hhmm
  • hh:mm:ss or hhmmss
TIME ZONE
  • Z (UTC)
  • ±HH:MM
  • ±HHMM
  • ±HH

FEATURES IN BETA

PLEASE REQUEST THROUGH YOUR HELIOS CONTACT