darkgoldblade01/paradox-ai-php-sdk

There is no license information available for the latest version (1.0.0) of this package.

A PHP SDK for Paradox.ai's Olivia.

1.0.0 2019-03-08 00:13 UTC

This package is auto-updated.

Last update: 2024-03-13 04:19:09 UTC


README

This is an unofficial PHP SDK developed for use with version 1.0 of the Paradox.ai Olivia API.

Official documentation can be found here.

Getting Started

Include the library via composer

composer require darkgoldblade01/paradox-ai-php-sdk 

Once included, make sure you have the following from Paradox:

  • Account ID
  • Secret Key
  • UID

These are required to generate the JWT token used.

Initializing the API

To initialize the API is simple, just create a new instance of Olivia, and include the Account ID, Secret Key, and UID:

$olivia = new \darkgoldblade01\Paradox\Olivia\Olivia($account_id, $secret_key, $uid)

From there, you are ready to start interacting with the API!

$olivia->company()

Returns the company resource.

get_conversations($conversations)

Parameter Type Default
$conversations bool true

Returns a list of company conversations.

get_locations($locations)

Parameter Type Default
$locations bool true

Returns a list of all company locations.

get_ai_assistant()

Parameter Type Default

Returns the AI assistant's name and image.