Synadia Communications

Synadia Communications KV API

The KV API API from Synadia Communications — 1 operation(s) for kv api.

GitHub OpenAPI

Operations 4

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

GET /kv/{bucket}/{key} Read a value from a KV bucket · Retrieves a value from the key value store #
Ask an LLM
“How do I read the value stored under a key?”
“Can I fetch an older revision of a key's value?”
Tell an agent
Get the value of key {key} in bucket {bucket}.
Read key {key} from bucket {bucket} at revision {revision}.
POST /kv/{bucket}/{key} Create a new key only if absent · Adds a new entry to the key value store, fails if the entry exists #
Ask an LLM
“Can I add a key so the call fails if it already exists?”
“What's the safe way to create a key without overwriting?”
Tell an agent
Create key {key} in bucket {bucket} only if it doesn't exist.
Add a brand-new entry {key} to bucket {bucket}.
PUT /kv/{bucket}/{key} Put a value in a KV bucket · Adds or updates an existing entry at an optional revision #
Ask an LLM
“Can I write a key whether or not it already exists?”
“Is optimistic concurrency supported by passing the previous revision?”
Tell an agent
Put a value at key {key} in bucket {bucket}.
Update key {key} in bucket {bucket} only if it's still at revision {previousRevision}.
DELETE /kv/{bucket}/{key} Delete a key from a KV bucket · Delete an entry #
Ask an LLM
“Can I delete a key and also purge its history?”
“What's the way to remove an entry from a key-value bucket?”
Tell an agent destructive · confirm first
Delete key {key} from bucket {bucket}.
Delete key {key} in bucket {bucket} and purge its history (purge={purge}).

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-kv-api-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-kv-api-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-kv-api-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: NATS HTTP Gateway KV API
  description: 'This is the API for interacting with NATS and NATS

    based services using HTTP.'
  version: 1.0.0
servers:
- url: https://api.ngs.global/v1
security:
- ApiKeyAuth: []
tags:
- name: KV API
paths:
  /kv/{bucket}/{key}:
    parameters:
    - in: path
      name: bucket
      description: Bucket name
      required: true
      style: simple
      explode: false
      schema:
        maximum: 1
        minimum: 1
        type: string
    - in: path
      name: key
      description: Key name
      required: true
      style: simple
      explode: false
      schema:
        maximum: 1
        minimum: 1
        type: string
    get:
      operationId: SimpleKvGet
      tags:
      - KV API
      summary: Retrieves a value from the key value store
      parameters:
      - in: query
        name: revision
        description: the value of the key at the specified revision. Note the revision may not be available.
        schema:
          type: number
      responses:
        '200':
          headers:
            X-Nats-Kv-Bucket:
              schema:
                type: string
              description: the name of the bucket (only on application/text)
            X-Nats-Kv-Created:
              schema:
                type: date-time
              description: date when the entry was created (only on application/text)
            X-Nats-Kv-Revision:
              schema:
                type: number
              description: the revision storing the entry (only on application/text)
            X-Nats-Kv-Delta:
              schema:
                type: number
              description: number of revisions from current the KV is on (only on application/text)
            X-Nats-Kv-Operation:
              schema:
                type: string
                enum:
                - PUT
                - DEL
                - PURGE
              description: the operation (PUT, DEL, PURGE) represented by the entry (only on application/text)
          description: success response body is payload, and metadata is HTTP headers. On JSON responses the value property is base64 encoded.
          content:
            application/text:
              schema:
                type: string
                format: binary
                x-content-type: application/text
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    bucket:
                      type: string
                    created:
                      type: string
                      format: date-time
                    revision:
                      type: number
                      format: uint64
                    delta:
                      type: number
                      format: uint64
                    operation:
                      type: string
                      enum:
                      - PUT
                      - DEL
                      - PURGE
                - type: object
                  properties:
                    value:
                      description: value is base64 encoded
                      type: string
                      format: byte
        '400':
          description: Invalid Request
        '404':
          description: Key not found
    post:
      tags:
      - KV API
      summary: Adds a new entry to the key value store, fails if the entry exists
      operationId: SimpleKvCreateEntry
      requestBody:
        content:
          text/plain:
            schema:
              type: string
          application/text:
            schema:
              type: string
              format: binary
      responses:
        '201':
          description: Success response
          headers:
            X-Nats-Kv-Sequence:
              schema:
                type: number
                format: uint64
              description: the sequence assigned to the entry (only on application/text)
          content:
            application/json:
              schema:
                type: number
                format: uint64
            application/text:
              schema:
                type: number
                format: uint64
        '400':
          description: Invalid Request
        '409':
          description: Key already exists
    put:
      tags:
      - KV API
      summary: Adds or updates an existing entry at an optional revision
      operationId: SimpleKvPutEntry
      parameters:
      - in: query
        name: previousRevision
        required: false
        description: the expected previous revision. If specified and the key is not at the specified revision the operation fails.
        schema:
          type: number
          format: uint64
      requestBody:
        content:
          application/text:
            schema:
              type: string
      responses:
        '201':
          description: Success response
          headers:
            X-Nats-Kv-Sequence:
              schema:
                type: number
                format: uint64
              description: the sequence assigned to the entry (only on application/text)
          content:
            application/json:
              schema:
                type: number
                format: uint64
            application/text:
              schema:
                type: number
                format: uint64
        '400':
          description: Invalid Request
        '409':
          description: Key already exists if previousRevision is incorrect
    delete:
      tags:
      - KV API
      summary: Delete an entry
      operationId: SimpleKvDeleteEntry
      parameters:
      - name: purge
        in: query
        description: Purges the deleted entry
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: Success response
        '400':
          description: Invalid Request
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      name: Authorization
      in: header