Synadia Communications

Synadia Communications Stream Export API

The stream-export API from Synadia Communications — 3 operation(s) for stream-export.

GitHub OpenAPI

Operations 5

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

DELETE /core/beta/stream-exports/{streamExportId} Delete a stream export · Delete Stream Export #
Ask an LLM
“Can I stop exporting a stream to other accounts?”
“How do I remove a stream export altogether?”
Tell an agent destructive · confirm first
Delete stream export {export}.
Stop exporting the stream behind export {export}.
GET /core/beta/stream-exports/{streamExportId} Look up a stream export · Get Stream Export #
Ask an LLM
“How do I see the details of one stream export?”
“Is a given stream export public or shared with specific accounts?”
Tell an agent
Show stream export {export}.
Get info about stream export {export}.
GET /core/beta/stream-exports/{streamExportId}/shares List accounts a stream export is shared with · List Stream Shares #
Ask an LLM
“Which accounts can import a stream I've exported?”
“Where do I see the shares on a stream export?”
Tell an agent
List the shares for stream export {export}.
Show which accounts stream export {export} is shared with.
POST /core/beta/stream-exports/{streamExportId}/shares Share a stream export with another account · Create Stream Shares #
Ask an LLM
“How do I let another account import my exported stream?”
“What do I need from the other account to share a stream with it?”
Tell an agent
Share stream export {export} with account NKey {target}.
Grant account {target} access to stream export {export}.
DELETE /core/beta/stream-exports/{streamExportId}/shares/{targetAccountNKeyPublic} Revoke a stream share from an account · Delete Stream Share #
Ask an LLM
“How do I revoke one account's access to my exported stream?”
“Can I unshare a stream export from a single account but keep the export?”
Tell an agent destructive · confirm first
Revoke stream export {export}'s share with account NKey {target}.
Unshare stream export {export} from account {target}.

Documentation

📖
Documentation
https://docs.synadia.com/platform/control-plane
📖
APIReference
https://cloud.synadia.com/api-docs
📖
Documentation
https://docs.synadia.com/cloud/resources/http-gateway
📖
APIReference
https://api.ngs.global/api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/synadia-communications/refs/heads/main/openapi/synadia-communications-stream-export-api-openapi.yml

Other Resources

🔗
SourceCode
https://github.com/synadia-io/control-plane-sdk-go

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-stream-export-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

synadia-communications-stream-export-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: API for Synadia Control Plane / Synadia Cloud
  title: Synadia Control Plane / Synadia Cloud Stream Export API
  version: beta
servers:
- description: Path to Synadia Control Plane Server Api
  url: '{baseUrl}/api'
  variables:
    baseUrl:
      default: ''
security:
- bearerAuth: []
  sessionAuth: []
tags:
- name: stream-export
paths:
  /core/beta/stream-exports/{streamExportId}:
    delete:
      operationId: deleteStreamExport
      parameters:
      - explode: false
        in: path
        name: streamExportId
        required: true
        schema:
          type: string
        style: simple
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Delete Stream Export
      tags:
      - stream-export
      x-doc-tags:
      - Sharing
    get:
      description: Returns Stream Export info
      operationId: getStreamExport
      parameters:
      - explode: false
        in: path
        name: streamExportId
        required: true
        schema:
          type: string
        style: simple
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamExportViewResponse'
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Get Stream Export
      tags:
      - stream-export
      x-doc-tags:
      - Sharing
  /core/beta/stream-exports/{streamExportId}/shares:
    get:
      description: List stream shares for this export
      operationId: listStreamShares
      parameters:
      - explode: false
        in: path
        name: streamExportId
        required: true
        schema:
          type: string
        style: simple
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamShareListResponse'
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: List Stream Shares
      tags:
      - stream-export
      x-doc-tags:
      - Sharing
    post:
      description: Creates Stream Shares
      operationId: createStreamShares
      parameters:
      - explode: false
        in: path
        name: streamExportId
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StreamShareCreateRequest'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamShareViewResponse'
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Create Stream Shares
      tags:
      - stream-export
      x-doc-tags:
      - Sharing
  /core/beta/stream-exports/{streamExportId}/shares/{targetAccountNKeyPublic}:
    delete:
      description: Revokes the share for provided Account NKey
      operationId: deleteStreamShare
      parameters:
      - explode: false
        in: path
        name: streamExportId
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: targetAccountNKeyPublic
        required: true
        schema:
          type: string
        style: simple
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Delete Stream Share
      tags:
      - stream-export
      x-doc-tags:
      - Sharing
components:
  schemas:
    StreamShareCreateRequest:
      description: '/

        Stream Share

        /'
      example:
        target_account_nkey_public: target_account_nkey_public
      properties:
        target_account_nkey_public:
          type: string
      required:
      - target_account_nkey_public
      type: object
    StreamExportViewResponse:
      description: '/

        Stream export

        /'
      example:
        account_id: account_id
        stream_name: stream_name
        created: 2000-01-23 04:56:07+00:00
        js_subject_prefix: js_subject_prefix
        is_public: true
        deliver_subject_prefix: deliver_subject_prefix
        id: id
      properties:
        account_id:
          type: string
        created:
          format: date-time
          type: string
        deliver_subject_prefix:
          type: string
        id:
          type: string
        is_public:
          type: boolean
        js_subject_prefix:
          type: string
        stream_name:
          type: string
      required:
      - account_id
      - created
      - deliver_subject_prefix
      - id
      - is_public
      - js_subject_prefix
      - stream_name
      type: object
    StreamShareViewResponse:
      example:
        target_account_nkey_public: target_account_nkey_public
      properties:
        target_account_nkey_public:
          type: string
      required:
      - target_account_nkey_public
      type: object
    StreamShareListResponse:
      example:
        items:
        - target_account_nkey_public: target_account_nkey_public
        - target_account_nkey_public: target_account_nkey_public
      properties:
        items:
          items:
            $ref: '#/components/schemas/StreamShareViewResponse'
          type: array
      required:
      - items
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: Personal Access Token
      scheme: bearer
      type: http
    sessionAuth:
      in: cookie
      name: control_plane_session
      type: apiKey