Appearance
About the CalypsoAI API
The CalypsoAI API offers almost all the functionalities available in the CalypsoAI Platform and allows you to integrate CalypsoAI features with your own applications and services.
With our API, you can:
- Run attack campaigns against LLMs (Large Language Models), using our Inference Red-Team product, to get a comprehensive understanding of LLM security.
- Create and use scanners with our Inference Defend product to secure usage of your applications and LLMs.
This documentation provides examples for the most common scenarios you can come across when using CalypsoAI.
Python SDK
We provide a Python SDK to make integration with your applications as seamless as possible. The calypsoai package is the most efficient way to interact with our API, providing a fast, simple, and robust experience.
PYTHON SDK
All the API samples provided in this documentation use our Python SDK.
API resources
Our API includes the following resources:
- Admin: Creates and imports backups of organization settings.
- Auth: Manages roles and permissions. You can create, update or delete roles, and retrieve lists of roles. You can also manage permissions assigned to a role.
- Campaigns (Inference Red-Team only): Manages your campaigns. You can create, update or delete campaigns. You can also retrieve single campaign details or the details of all campaigns in the system.
- License: Updates the system license.
- Projects: Manages your projects. You can create, update or delete single or multiple projects, and retrieve lists of projects. You can also retrieve details on project members, scanners and scanner packages.
- Prompts: Creates and manages prompts and prompt templates in the system. You can send prompts to providers, and update or delete prompts or prompt templates. You can also retrieve lists of prompts stored in CalypsoAI.
- Scanners: Manages your scanners. You can create scanners with a specific configuration, update or delete scanners, and export or import scanner data using ZIP archives. You can also retrieve lists of scanners stored in CalypsoAI.
- Scans: Creates and updates scans. Runs scans with a specific configuration.
- Tokens: Creates and deletes authorization tokens. You can also retrieve lists of tokens stored in CalypsoAI.
- Users: Manages users. You can add, update or delete users, and retrieve user lists. You can also verify users, and reset their multifactor authentication.
RELATED INFORMATION