Synadia Communications Platform Components API

The platform-components API from Synadia Communications — 1 operation(s) for platform-components.

Documentation GitHub OpenAPI

Operations 1

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /core/beta/platform-components/connect Connect a platform component · Connect a Platform Component #

Ask an LLM

“How does a platform component register its connection with the Control Plane?”

“What does a platform component need to send when it connects?”

Tell an agent

Connect platform component {id} with public NKey {nkey}.

Register component {id} using NKey {nkey} and data {data}.

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/synadia-communications:synadia-communications-platform-components-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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:
  description: API for Synadia Control Plane / Synadia Cloud
  title: Synadia Control Plane / Synadia Cloud Platform Components…
  version: beta
servers:
- description: Path to Synadia Control Plane Server Api
  url: '{baseUrl}/api'
  variables:
    baseUrl:
      default: ''
security:
- bearerAuth: []
  sessionAuth: []
tags:
- name: platform-components
paths:
  /core/beta/platform-components/connect:
    post:
      description: Connection endpoint for platform components to use. Requires a platform component bearer token
      operationId: platformComponentConnect
      parameters:
      - explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlatformComponentsConnectRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformComponentsConnectViewResponse'
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Connect a Platform Component
      tags:
      - platform-components
      x-doc-tags:
      - Platform Components
components:
  schemas:
    HttpGatewayPlatformComponentConfig:
      properties:
        account:
          type: string
        token_bucket:
          type: string
        url:
          type: string
      required:
      - account
      - token_bucket
      - url
      type: object
    ScraperComponentConfig:
      properties:
        account:
          type: string
        interval:
          default: 15
          minimum: 0
          type: integer
        stream:
          type: string
      required:
      - account
      - interval
      - stream
      type: object
    PlatformComponentConnectConfig:
      oneOf:
      - $ref: '#/components/schemas/HttpGatewayPlatformComponentConfig'
      - $ref: '#/components/schemas/AuthCalloutAuthenticatorComponentConfig'
      type:
      - object
      - 'null'
    WorkloadsPlatformComponentConfig:
      properties:
        account:
          type: string
        nexus_name:
          type: string
      required:
      - account
      - nexus_name
      type: object
    PlatformComponentsConnectRequest:
      example:
        data: null
        nkey_public: nkey_public
      properties:
        data:
          $ref: '#/components/schemas/PlatformComponentConnectConfig'
        nkey_public:
          type: string
      required:
      - nkey_public
      type: object
    CatalogPlatformComponentConfig:
      properties:
        account:
          default: ''
          type: string
        catalog_id:
          type: string
      required:
      - account
      - catalog_id
      type: object
    PlatformComponentConfigs:
      oneOf:
      - $ref: '#/components/schemas/HttpGatewayPlatformComponentConfig'
      - $ref: '#/components/schemas/AuthCalloutAuthenticatorComponentConfig'
      - $ref: '#/components/schemas/WorkloadsPlatformComponentConfig'
      - $ref: '#/components/schemas/ScraperComponentConfig'
      - $ref: '#/components/schemas/CatalogPlatformComponentConfig'
      type:
      - object
      - 'null'
    AuthCalloutAuthenticatorComponentConfig:
      properties:
        account:
          type: string
        bucket:
          type: string
      required:
      - account
      - bucket
      type: object
    PlatformComponentsConnectViewResponse:
      example:
        server: server
        jwt: jwt
        config: null
        account: account
      properties:
        account:
          type: string
        config:
          $ref: '#/components/schemas/PlatformComponentConfigs'
        jwt:
          type: string
        server:
          type: string
      required:
      - account
      - jwt
      - server
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: Personal Access Token
      scheme: bearer
      type: http
    sessionAuth:
      in: cookie
      name: control_plane_session
      type: apiKey