Click API Docs in the navigation panel.
The Quickstart drop-down list opens by default to the Getting Started screen.
Getting Started
This screen provides detailed information for setting up and using the CalypsoAI Python SDK.
Select the relevant tab (Global, Groups, or Personal), then click Generate an API Token.
Enter an ID name for the token and set an expiration date, then click Save.
Note: Once created, API key tokens cannot be modified.
Download and Install the CalypsoAI Python SDK
Click the here link.
Click Download SDK. A pop-up window appears, indicating the download is complete.
Note: Before attempting to deploy the SDK, ensure pip is installed on your computer.
To install the pip, hover over the code on the screen. Click the Copy Link icon to copy the code, then install it onto your machine.
Export Settings
Settings can be exported from on system to another using the API. The following shows a script example using the SDK.
from calypsoai import CalypsoAI
cai = CalypsoAI(url="url1",token="token1")
export = cai.admin.exportSettings()
cai.admin.importSettings(export)
Sending Prompts to an LLM
When the SDK has been installed and an API key token has been generated, follow the code snippet on the screen to begin sending prompts to an LLM. Change the URL to your CalypsoAI environment. Replace the content inside the quotation marks on the prompt line with your prompt.
API Reference
This section displays all endpoints exposed by the CalypsoAI API.
API Examples
This section provides simple examples of interactions with the CalypsoAI API, including sending a prompt to the default LLM and to a specific LLM, scanning text, getting previous prompts, and creating a provider.
