Skip to main content

​
Installation

We offer the SDK in several popular programming languages. 
pip install freeplay

​
Freeplay Client

The Freeplay client object will be your point of entry for all SDK usage. For most users, the base freeplay domain will be https://app.freeplay.ai with api exposed at https.app.freeplay.ai/api.

​
Custom Domain

If your organization has been assigned a custom Freeplay domain it will look like this: https://acme.freeplay.ai and your SDK connection URL will have an additional /api appended to it. Note the rest of the documentation will use https://app.freeplay.ai.

​
Authentication

Freeplay authenticates your API request using your API Key which can be managed through the Freeplay application at https://app.freeplay.ai/settings/api-access

​
Client Instantiation

The first step to using Freeplay is to create a client 
from freeplay import Freeplay
import os

# create a freeplay client object
fpClient = Freeplay(
    freeplay_api_key=os.getenv("FREEPLAY_API_KEY"),
    api_base="https://app.freeplay.ai/api"
)