Cayra

Cayra Self Service API

The self-service API from Cayra — 20 operation(s) for self-service.

GitHub OpenAPI

Operations 23

GET /api/v1/me/profile Get Profile #
PATCH /api/v1/me/profile Update Profile #
GET /api/v1/me/companies List Companies #
POST /api/v1/me/companies Create Company #
PATCH /api/v1/me/companies/{company_id} Update Company Self #
GET /api/v1/me/licenses List My Licenses #
GET /api/v1/me/billings List My Billings #
GET /api/v1/me/agreements List Agreements Self #
GET /api/v1/me/agreements/versions List Agreement Versions Self #
GET /api/v1/me/agreements/acceptances List My Acceptances #
POST /api/v1/me/agreements/acceptances Accept Agreement Self #
GET /api/v1/me/usage/balance Get My Usage Balance #
GET /api/v1/me/usage/daily Get My Daily Usage #
GET /api/v1/me/packages List Deployment Packages Self #
GET /api/v1/me/provisioning/active Get Active Provisioning Job #
GET /api/v1/me/deployments/current Get Current Deployment #
GET /api/v1/me/bootstrap Get Dashboard Bootstrap #
PATCH /api/v1/me/workspace/draft Save Self Service Workspace Draft #
POST /api/v1/me/provisioning/jobs Create Self Service Provisioning Job #
POST /api/v1/me/workspace/reset Reset Self Service Workspace #
POST /api/v1/me/workspace/post-provision-confirmation Complete Self Service Post Provision Confirmation #
GET /api/v1/me/provisioning/jobs/{job_id} Get Self Service Provisioning Job #
POST /api/v1/me/redirect-session Create Redirect Session #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/cayra-io/openapi/cayra-io-self-service-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/cayra-io/json-schema/cayra-io-deployment-details-schema.json
📊
JSONSchema
https://artifacts.apis.io/cayra-io/json-schema/cayra-io-license-details-schema.json
📊
JSONSchema
https://artifacts.apis.io/cayra-io/json-schema/cayra-io-license-create-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/cayra-io/json-schema/cayra-io-billing-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/cayra-io/json-schema/cayra-io-company-create-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/cayra-io/json-schema/cayra-io-plaud-webhook-payload-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cayra-io:cayra-io-self-service-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cayra-io-self-service-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Cayra License Server Self Service API
  description: '# Cayra Chat Agent - License Management Server


    Centralized license management for on-premise deployments.


    ## Features


    - 🔑 License key generation (installation, update, trial)

    - ⏰ Dynamic expiry management (extend/shorten licenses)

    - 🔄 Activation tracking and monitoring

    - 💓 Heartbeat mechanism (1-hour intervals)

    - 📊 Audit logging for compliance

    - 🔐 JWT tokens with RSA-4096 encryption


    ## API Categories


    ### Admin Endpoints (Requires API Key)

    Manage licenses, view activations, update expiry dates.


    ### Client Endpoints (Public)

    Activate licenses, send heartbeats, check status.


    ## Authentication


    Admin endpoints require API key in header:

    ```

    X-Admin-API-Key: your-admin-key-here

    ```


    ## Security


    - 🔒 RSA-4096 asymmetric encryption

    - 🔐 JWT tokens for offline validation

    - 📝 Complete audit trail

    - 🛡️ Rate limiting (Phase 6)'
  contact:
    name: Cayra AI Team
    email: support@cayra.ai
  license:
    name: Proprietary
  version: 1.0.0
tags:


# --- truncated at 32 KB (70 KB total) ---
# Full source: https://artifacts.apis.io/cayra-io/openapi/cayra-io-self-service-api-openapi.yml