CalypsoAI API Reference Guide

Welcome to the CalypsoAI API Reference! Here, you’ll find a handy overview of all the endpoints you can use to integrate, manage, and supercharge your AI operations. This guide is designed for developers who want to get things done—fast, securely, and with a dash of style.

Table of Contents

• Getting Started ↗
• Authentication ↗
• Key API Endpoints ↗
  • Admin ↗
  • App ↗
  • Audit ↗
  • Auth ↗
  • Branding ↗
  • Campaigns & Schedules ↗
  • Chats ↗
  • Endpoints ↗
  • Org & Projects ↗
  • Prompts ↗
  • Providers ↗
  • Scanners & Scans ↗
  • Secrets ↗
  • Tokens & Users ↗

 

Getting Started
Before you dive in, make sure you’re logged in to CalypsoAI and have your API key handy. If you haven’t set that up yet, check out our Getting Started Guide ↗.

Authentication
All API requests require authentication. Pass your API token in the ‎⁠Authorization⁠ header:Authorization: Bearer <your-api-token>

Key API Endpoints
Below are the main API endpoints grouped by category. For each, you’ll see a quick description of what you can do (and sometimes, what you probably shouldn’t).

Admin

• POST /backend/v1/admin/export — Back up your org settings.
• POST /backend/v1/admin/import — Import org settings.

App

• GET /backend/v1/app/metrics — Retrieve app metrics.

Audit

• GET /backend/v1/audit — Get audit events.

Auth

• GET /backend/v1/auth/roles — List roles.
• POST /backend/v1/auth/roles — Create a new role.
• DELETE /backend/v1/auth/roles/{roleId} — Delete a role.
• PATCH /backend/v1/auth/roles/{roleId}/permissions — Add permissions to a role.

Branding

• GET /backend/v1/branding — Get current branding.
• PATCH /backend/v1/branding — Update branding.
• POST /backend/v1/branding/logo — Upload a logo.
• DELETE /backend/v1/branding/favicon — Reset favicon.

Campaigns & Schedules

• GET /backend/v1/campaigns — List campaigns.
• POST /backend/v1/campaigns — Create a campaign.
• GET /backend/v1/campaign-runs — List campaign runs.
• POST /backend/v1/campaign-schedules — Schedule a campaign.

Chats

• GET /backend/v1/chats — List chats.
• POST /backend/v1/chats — Create a chat.
• DELETE /backend/v1/chats/{chatId} — Delete a chat.

Endpoints

• GET /backend/v1/endpoints — List endpoints.
• POST /backend/v1/endpoints — Create an endpoint.
• PATCH /backend/v1/endpoints/{endpoint} — Update an endpoint.

Org & Projects

• GET /backend/v1/org — Get organization details.
• PATCH /backend/v1/org — Update organization.
• GET /backend/v1/projects — List projects.
• POST /backend/v1/projects — Create a project.

Prompts

• GET /backend/v1/prompts — List prompts.
• POST /backend/v1/prompts — Send a prompt.
• GET /backend/v1/prompts/templates — List prompt templates.

Providers

• GET /backend/v1/providers — List providers.
• POST /backend/v1/providers — Create a provider.
• GET /backend/v1/providers/cai-models — List CAI models.

Scanners & Scans

• GET /backend/v1/scanners — List scanners.
• POST /backend/v1/scanners — Create a scanner.
• GET /backend/v1/scans — List scans.
• POST /backend/v1/scans — Scan data.

Secrets

• GET /backend/v1/secrets — List secrets.
• POST /backend/v1/secrets — Create a secret.

Tokens & Users

• GET /backend/v1/tokens — List API tokens.
• POST /backend/v1/tokens — Create an API token.
• GET /backend/v1/users — List users.
• POST /backend/v1/users — Create a user.

More Resources

• For detailed request/response schemas, see our OpenAPI spec ↗.
• Need code samples or extra help? Check out our API Examples ↗ or reach out to support.

 

Happy building! If you have questions, don’t hesitate to contact the CalypsoAI team.