Use CalypsoAI via API
Click API Docs in the navigation panel.
The Quickstart instructions open and display the Getting Started screen.
Getting Started
This screen provides detailed information for setting up and using the CalypsoAI Python SDK.
Create an API Key
Click here to open the API Key Tokens screen.
Select the relevant link (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.
Once created, API key tokens cannot be modified.
Download and Install the CalypsoAI Python SDK
Click here.
Click Download SDK. A pop-up window appears, indicating the download is complete.
Before attempting to deploy the SDK, ensure pip is installed on your computer. Hover over the code. 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.
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.
