CalypsoAI — API

CalypsoAI API v10.62.4 · spec ↗ · 141 endpoints · 1 deprecated

What it covers

Projects 15 create, read, update, delete
Users 12 create, read, update, delete
Scanners 10 create, read, update, delete
Prompts 9 create, read, update, delete
Providers 9 create, read, update, delete
Auth 8 create, read, update, delete
Branding 8 create, read, update, delete
Chats 6 create, read, update, delete
Datasets 6 create, read
Scanner Packages 6 create, read, update, delete
Campaign Runs 5 create, read, update, delete
Campaign Schedules 5 create, read, update, delete

16 more areas

Campaigns 5 create, read, update, delete
Org 5 create, read, update
Scans 5 create, read, update
Secrets 5 create, read, update, delete
Openai 4 create
Refusal Catalogs 3 create, read
Tokens 3 create, read, delete
Admin 2 create
Audit 2 read
Files 2 create, read
Agent Sessions 1 read
Anthropic 1 create
Generations 1 create
Google 1 create
License 1 update
Project 1 read

Endpoints

Open an endpoint for its inputs and outputs.

Projects 15

DELETE /backend/v1/projects/{project} Delete project.

Loading…
DELETE /backend/v1/projects/{project}/members/{userId} Remove user from project.

Loading…
DELETE /backend/v1/projects/{project}/providers/{providerId} Remove provider from project.

Loading…
DELETE /backend/v1/projects/{project}/scanner-packages/{scannerPackageId} Remove guardrail package from project.

Loading…
DELETE /backend/v1/projects/{project}/scanners/{scannerId} Remove guardrail from project.

Loading…
GET /backend/v1/projects Get projects.

Loading…
GET /backend/v1/projects/{project} Get project by ID or name.

Loading…
GET /backend/v1/projects/{project}/scanners Get project guardrails.

Loading…
PATCH /backend/v1/projects/{project} Update project.

Loading…
PATCH /backend/v1/projects/{project}/members/{userId} Update project user.

Loading…
POST /backend/v1/projects Create project.

Loading…
POST /backend/v1/projects/{project}/members Add users to project.

Loading…
POST /backend/v1/projects/{project}/providers/{providerId} Add provider to project.

Loading…
POST /backend/v1/projects/{project}/scanner-packages/{scannerPackageId} Add scanner_package to project.

Loading…
POST /backend/v1/projects/{project}/scanners/{scannerId} Add guardrail to project.

Loading…

Users 12

DELETE /backend/v1/users/{userId} Delete user.

Loading…
DELETE /backend/v1/users/{userId}/multifactor Reset multi-factor authentication.

Loading…
DELETE /backend/v1/users/{userId}/roles/{roleId} Retract role from user.

Loading…
GET /backend/v1/users Get users.

Loading…
GET /backend/v1/users/me Get authenticated user.

Loading…
GET /backend/v1/users/{userId} Get user.

Loading…
PATCH /backend/v1/users/{userId} Update user.

Loading…
POST /backend/v1/users Create user.

Loading…
POST /backend/v1/users/token-verification Set user's password.

Loading…
POST /backend/v1/users/{userId}/roles/{roleId} Assign role to user.

Loading…
POST /backend/v1/users/{userId}/verification/resend Re-sends users verification email.

Loading…
POST /backend/v1/users/{userId}/verification/token Generate verification token.

Loading…

Scanners 10

DELETE /backend/v1/scanners/{scannerId} Delete guardrail.

Loading…
GET /backend/v1/scanners Get guardrails.

Loading…
GET /backend/v1/scanners/{scannerId} Get guardrail.

Loading…
GET /backend/v1/scanners/{scannerId}/versions Get metadata for all existing versions of a guardrail.

Loading…
PATCH /backend/v1/scanners/{scannerId} Update guardrail.

Loading…
PATCH /backend/v1/scanners/{scannerId}/access Update guardrail availability.

Loading…
PATCH /backend/v1/scanners/{scannerId}/versions/{versionId} Update a guardrail version.

Loading…
POST /backend/v1/scanners Create guardrail.

Loading…
POST /backend/v1/scanners/export Export the given guardrails and guardrail packages in a zip file.

Loading…
POST /backend/v1/scanners/import Import guardrails.

Loading…

Prompts 9

DELETE /backend/v1/prompts/templates/{promptTemplateId} Delete a prompt template.

Loading…
GET /backend/v1/prompts Get prompts.

Loading…
GET /backend/v1/prompts/templates Get prompt templates.

Loading…
GET /backend/v1/prompts/templates/{promptTemplateId} Get prompt template.

Loading…
GET /backend/v1/prompts/{promptId} Get prompt.

Loading…
PATCH /backend/v1/prompts/templates/{promptTemplateId} Update prompt template.

Loading…
PATCH /backend/v1/prompts/{promptId} Update prompt.

Loading…
POST /backend/v1/prompts Send prompt.

Loading…
POST /backend/v1/prompts/templates Create prompt template.

Loading…

Providers 9

DELETE /backend/v1/providers/{provider} Delete provider.

Loading…
GET /backend/v1/providers Get providers.

Loading…
GET /backend/v1/providers/system Get available system providers.

Loading…
GET /backend/v1/providers/system/{systemProvider} Get system provider.

Loading…
GET /backend/v1/providers/{provider} Get provider.

Loading…
PATCH /backend/v1/providers/{provider} Update provider.

Loading…
PATCH /backend/v1/providers/{provider}/access Update provider availability.

Loading…
POST /backend/v1/providers Create provider.

Loading…
POST /backend/v1/providers/test Test provider.

Loading…

Auth 8

DELETE /backend/v1/auth/roles/{roleId} Delete role.

Loading…
DELETE /backend/v1/auth/roles/{roleId}/permissions Remove permissions.

Loading…
GET /backend/v1/auth/roles Get roles.

Loading…
GET /backend/v1/auth/roles/default Get the default role.

Loading…
GET /backend/v1/auth/roles/{roleId} Get role.

Loading…
PATCH /backend/v1/auth/roles/{roleId} Update role.

Loading…
PATCH /backend/v1/auth/roles/{roleId}/permissions Add permissions.

Loading…
POST /backend/v1/auth/roles Create role.

Loading…

Branding 8

DELETE /backend/v1/branding/favicon Reset favicon.

Loading…
DELETE /backend/v1/branding/logo Reset logo.

Loading…
GET /backend/v1/branding Get branding.

Loading…
GET /backend/v1/branding/favicon Get favicon.

Loading…
GET /backend/v1/branding/logo Get logo.

Loading…
PATCH /backend/v1/branding Update branding.

Loading…
POST /backend/v1/branding/favicon Upload favicon.

Loading…
POST /backend/v1/branding/logo Upload logo.

Loading…

Chats 6

DELETE /backend/v1/chats/{chatId} Delete chat.

Loading…
GET /backend/v1/chats Get chats.

Loading…
GET /backend/v1/chats/public/{accessId} Get chat by access ID.

Loading…
GET /backend/v1/chats/{chatId} Get chat.

Loading…
PATCH /backend/v1/chats/{chatId} Update chat.

Loading…
POST /backend/v1/chats Create chat.

Loading…

Datasets 6

GET /backend/v1/datasets Get

Loading…
GET /backend/v1/datasets/runs Get

Loading…
GET /backend/v1/datasets/runs/{datasetRunId} Get

Loading…
GET /backend/v1/datasets/runs/{datasetRunId}/download Getdeprecated

Loading…
GET /backend/v1/datasets/{datasetId} Get

Loading…
POST /backend/v1/datasets Post

Loading…

Scanner Packages 6

DELETE /backend/v1/scanner-packages/{scannerPackageId} Delete guardrail package.

Loading…
GET /backend/v1/scanner-packages Get guardrail packages.

Loading…
GET /backend/v1/scanner-packages/{scannerPackageId} Get guardrail package.

Loading…
PATCH /backend/v1/scanner-packages/{scannerPackageId} Update guardrail package.

Loading…
PATCH /backend/v1/scanner-packages/{scannerPackageId}/access Update guardrail package availability.

Loading…
POST /backend/v1/scanner-packages Create guardrail package.

Loading…

Campaign Runs 5

DELETE /backend/v1/campaign-runs/{campaignRunId} Delete a campaign run.

Loading…
GET /backend/v1/campaign-runs Get campaign runs.

Loading…
GET /backend/v1/campaign-runs/{campaignRunId} Get campaign run.

Loading…
PATCH /backend/v1/campaign-runs/{campaignRunId} Update campaign run.

Loading…
POST /backend/v1/campaign-runs Run campaign.

Loading…

Campaign Schedules 5

DELETE /backend/v1/campaign-schedules/{campaignScheduleId} Delete a campaign run schedule.

Loading…
GET /backend/v1/campaign-schedules Get campaign schedules.

Loading…
GET /backend/v1/campaign-schedules/{campaignScheduleId} Get scheduled campaign run.

Loading…
PATCH /backend/v1/campaign-schedules/{campaignScheduleId} Update a scheduled campaign run.

Loading…
POST /backend/v1/campaign-schedules Run campaigns on a schedule.

Loading…

Campaigns 5

DELETE /backend/v1/campaigns/{campaignId} Delete a campaign.

Loading…
GET /backend/v1/campaigns Get campaigns.

Loading…
GET /backend/v1/campaigns/{campaignId} Get campaign.

Loading…
PATCH /backend/v1/campaigns/{campaignId} Update campaign.

Loading…
POST /backend/v1/campaigns Create campaign.

Loading…

Org 5

GET /backend/v1/org Get organization.

Loading…
GET /backend/v1/org/preferences Get org preferences.

Loading…
PATCH /backend/v1/org Update organization.

Loading…
PATCH /backend/v1/org/preferences Update org preferences.

Loading…
POST /backend/v1/org Create organization.

Loading…

Scans 5

GET /backend/v1/scans Get scans.

Loading…
GET /backend/v1/scans/{scanRequestId} Get scan.

Loading…
PATCH /backend/v1/scans/{scanRequestId} Update scan preservation.

Loading…
POST /backend/v1/scans Scan data.

Loading…
POST /backend/v1/scans/raw/{format} Process a raw request/response body from a third party API and inject the result in the returned body.

Loading…

Secrets 5

DELETE /backend/v1/secrets/{secretId} Delete secret.

Loading…
GET /backend/v1/secrets Get secrets.

Loading…
GET /backend/v1/secrets/{secretId} Get secret.

Loading…
PATCH /backend/v1/secrets/{secretId} Update secret.

Loading…
POST /backend/v1/secrets Create secret.

Loading…

Openai 4

POST /openai/{provider}/chat/completions Chat Completions.

Loading…
POST /openai/{provider}/openai/deployments/{model}/chat/completions Chat Completions.

Loading…
POST /openai/{provider}/openai/responses OpenAI responses API gateway.

Loading…
POST /openai/{provider}/responses OpenAI responses API gateway.

Loading…

Refusal Catalogs 3

GET /backend/v1/refusal-catalogs/latest Get the latest refusal catalog.

Loading…
GET /backend/v1/refusal-catalogs/{refusalCatalogId} Get refusal catalog by id.

Loading…
POST /backend/v1/refusal-catalogs Set refusal catalog.

Loading…

Tokens 3

DELETE /backend/v1/tokens/{tokenId} Delete API token.

Loading…
GET /backend/v1/tokens Get API tokens.

Loading…
POST /backend/v1/tokens Create API token.

Loading…

Admin 2

POST /backend/v1/admin/export Create org settings backup.

Loading…
POST /backend/v1/admin/import Import org settings.

Loading…

Audit 2

GET /backend/v1/audit Get audit events.

Loading…
GET /backend/v1/audit/{eventId} Get event.

Loading…

Files 2

GET /backend/v1/files/{fileId} Get a file's metadata by the file ID.

Loading…
POST /backend/v1/files Upload a file.

Loading…

Agent Sessions 1

GET /backend/v1/agent-sessions Get

Loading…

Anthropic 1

POST /anthropic/{provider}/v1/messages Post

Loading…

Generations 1

POST /backend/v1/generations Post

Loading…

Google 1

POST /google/{provider}/v1beta/models/{model}:{methodName} Google gemini generateContent API gateway.

Loading…

License 1

PATCH /backend/v1/license Update license.

Loading…

Project 1

GET /backend/v1/project Get default project.

Loading…

Recent changes

2026-08-04 ⚠ GET /backend/v1/datasets/runs/{datasetRunId}/download