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-whatsapp-routing-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

openapi: 3.2.0
info:
  title: Cayra License Server Whatsapp Routing 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:
- name: whatsapp-routing
paths:
  /api/v1/whatsapp-routing/register:
    post:
      tags:
      - whatsapp-routing
      summary: Register WhatsApp agent routing
      description: 'Register WhatsApp agent phone number for routing.


        When a message comes to this phone number, it will be forwarded

        to the specified onprem webhook URL.'
      operationId: register_agent_routing_api_v1_whatsapp_routing_register_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoutingRegisterRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutingResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/whatsapp-routing/unregister:
    post:
      tags:
      - whatsapp-routing
      summary: Unregister WhatsApp agent routing
      description: 'Unregister WhatsApp agent phone number.


        Marks routing as inactive so messages will no longer be forwarded.'
      operationId: unregister_agent_routing_api_v1_whatsapp_routing_unregister_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoutingUnregisterRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutingResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    RoutingResponse:
      properties:
        success:
          type: boolean
          title: Success
        message:
          type: string
          title: Message
        routing_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Routing Id
      type: object
      required:
      - success
      - message
      title: RoutingResponse
      description: Response for routing operations
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    RoutingRegisterRequest:
      properties:
        license_key:
          type: string
          maxLength: 256
          minLength: 10
          title: License Key
        phone_number:
          type: string
          maxLength: 32
          minLength: 8
          title: Phone Number
        onprem_webhook_url:
          type: string
          maxLength: 500
          minLength: 10
          title: Onprem Webhook Url
      type: object
      required:
      - license_key
      - phone_number
      - onprem_webhook_url
      title: RoutingRegisterRequest
      description: Request to register WhatsApp agent routing
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    RoutingUnregisterRequest:
      properties:
        license_key:
          type: string
          maxLength: 256
          minLength: 10
          title: License Key
        phone_number:
          type: string
          maxLength: 32
          minLength: 8
          title: Phone Number
      type: object
      required:
      - license_key
      - phone_number
      title: RoutingUnregisterRequest
      description: Request to unregister WhatsApp agent routing