Skip to content

Main Navigation App Product docs

Appearance

Sidebar Navigation

Get started

About the CalypsoAI API

Prompts and scans in CalypsoAI

Permissions, roles, and tokens in CalypsoAI

First steps with CalypsoAI API

Getting started with Inference Defend

Getting started with Inference Red-Team

Using CalypsoAI API

Creating a provider

Inference Defend

Sending a prompt to a specific provider

Sending a prompt to a specific project

Sending a scan request to a specific project

Removing a scanner from a project

Creating a custom scanner

Working with scanner versions

Getting prompt logs

Getting audit logs

Inference Red-Team

Running the All Attacks campaign

Managing campaigns

Examples

Integrating with a Slack bot (SaaS)

Integrating with a Slack bot (on-prem)

Integrating with Microsoft Teams (SaaS)

Integrating with Microsoft Teams (on-prem)

Troubleshooting

Status and error codes

Error handling

The None response

Common issues

No token provided

Invalid token

Insufficient permissions

API reference

Welcome

Admin

POST Create org settings backup.

POST Import org settings.

App

GET Get app metrics.

Audit

GET Get audit events.

Auth

GET Get roles.

POST Create role.

GET Get role.

DELETE Delete role.

PATCH Update role.

DELETE Remove permissions.

PATCH Add permissions.

Branding

GET Get branding.

PATCH Update branding.

GET Get favicon.

POST Upload favicon.

DELETE Reset favicon.

GET Get logo.

POST Upload logo.

DELETE Reset logo.

Campaign-Runs

GET Get campaign runs.

POST Run campaign.

GET Get campaign run.

DELETE Delete a campaign run.

PATCH Update campaign run.

Campaign-Schedules

GET Get campaign schedules.

POST Run campaigns on a schedule.

GET Get scheduled campaign run.

DELETE Delete a campaign run schedule.

PATCH Update a scheduled campaign run.

Campaigns

GET Get campaigns.

POST Create campaign.

GET Get campaign.

DELETE Delete a campaign.

PATCH Update campaign.

Chats

GET Get chats.

POST Create chat.

GET Get chat by access ID.

GET Get chat.

DELETE Delete chat.

PATCH Update chat.

Endpoint

GET Get the default endpoint for the group/chatbot specified or global settings if neither is given.

Endpoints

GET Get endpoints matching the given filter criteria.

POST Create a new endpoint.

GET Get endpoint by its ID or name.

PATCH Update endpoint.

GET Get the scanners and their configuration that will be used when sending prompts to a given endpoint.

Groups

GET Get groups matching the given filter criteria.

POST Create group.

GET Get group by its ID.

DELETE Delete group.

PATCH Update group's name.

POST Add users to a group.

DELETE Remove a user from a group. Only a group admin can remove a user from a group.

PATCH Update a user's admin status in a group.

License

PATCH Update license.

Org

GET Get organization.

POST Create organization.

PATCH Update organization.

GET Get org preferences.

PATCH Update org preferences.

Orgs

GET Get organizations.

Project

GET Get default project.

Projects

GET Get projects.

POST Create project.

GET Get project by ID or name.

DELETE Delete project.

PATCH Update project.

POST Add users to project.

DELETE Remove user from project.

PATCH Update project user.

POST Add provider to project.

DELETE Remove provider from project.

POST Add scanner_package to project.

DELETE Remove scanner_package from project.

GET Get project scanners.

POST Add scanner to project.

DELETE Remove scanner from project.

Prompts

GET Get prompts.

POST Send prompt.

GET Get prompt templates.

POST Create prompt template.

GET Get prompt template.

DELETE Delete a prompt template.

PATCH Update prompt template.

GET Get prompt.

PATCH Update prompt.

Providers

GET Get providers.

POST Create provider.

GET Get cai models.

GET Get available system providers.

GET Get system provider.

POST Test provider.

GET Get provider.

DELETE Delete provider.

PATCH Update provider.

PATCH Update provider availability.

Scanner-Packages

GET Get scanner packages.

POST Create scanner package.

GET Get scanner package.

DELETE Delete scanner package.

PATCH Update scanner package.

PATCH Update scanner package availability.

Scanners

GET Get scanners.

POST Create scanner.

POST Export the given scanners and scanner packages in a zip file.

POST Import scanners.

GET Get scanner.

DELETE Delete scanner.

PATCH Update scanner.

PATCH Update scanner availability.

GET Get metadata for all existing versions of a scanner.

PATCH Update a scanner version.

Scans

GET Get scans.

POST Scan data.

GET Get scan.

PATCH Update scan preservation.

Secrets

GET Get secrets.

POST Create secret.

GET Get secret.

DELETE Delete secret.

PATCH Update secret.

Tokens

GET Get API tokens.

POST Create API token.

DELETE Delete API token.

Users

GET Get users.

POST Create user.

GET Get authenticated user.

POST Set user's password.

GET Get user.

DELETE Delete user.

PATCH Update user.

DELETE Reset multi-factor authentication.

POST Assign role to user.

DELETE Retract role from user.

POST Re-sends users verification email.

POST Generate verification token.

Terms of use

Reset favicon.

DELETE

/backend/v1/branding/favicon

Reset the favicon to the first in the history, normally the CalypsoAI branding.

Authorizations

HTTPBearer

TypeHTTP (bearer)

Responses

Successful Response

Content-Type

application/json

JSON

{

"message": "string"

}

DELETE

/backend/v1/branding/favicon

Playground

Authorization

HTTPBearer

Samples

Powered by VitePress OpenAPI

Updated at:

CalypsoAI © 2025-present