Synadia Communications

Synadia Communications ObjectStore Entry Operations API

The ObjectStore Entry Operations API from Synadia Communications — 1 operation(s) for objectstore entry operations.

GitHub OpenAPI

Operations 3

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 /objm/buckets/{bucket}/keys/{key} Download an object from an object store · Obj get entry #
Ask an LLM
“How do I download a file stored in an object store?”
“Can I retrieve one object by its key?”
Tell an agent
Get object {key} from object store {bucket}.
Download {key} from bucket {bucket}.
PUT /objm/buckets/{bucket}/keys/{key} Upload or replace an object · Adds or updates an entry to the object store, #
Ask an LLM
“Can I upload a file into an object store?”
“Will uploading to an existing key replace the object?”
Tell an agent
Upload an object as {key} into object store {bucket}.
Replace object {key} in bucket {bucket} with new content.
DELETE /objm/buckets/{bucket}/keys/{key} Delete an object from an object store · Delete an entry #
Ask an LLM
“Can I delete a single file from an object store?”
“Is it possible to purge an object rather than just mark it deleted?”
Tell an agent destructive · confirm first
Delete object {key} from object store {bucket}.
Delete object {key} in bucket {bucket} with 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-objectstore-entry-operations-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-objectstore-entry-operations-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-objectstore-entry-operations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: NATS HTTP Gateway ObjectStore Entry Operations 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: ObjectStore Entry Operations
paths:
  /objm/buckets/{bucket}/keys/{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: ObjGetEntry
      tags:
      - ObjectStore Entry Operations
      responses:
        '200':
          headers:
            X-Nats-Obj-Name:
              schema:
                type: string
              description: the name of the entry
            X-Nats-Obj-Bucket:
              schema:
                type: string
              description: the name of the bucket
            X-Nats-Obj-Nuid:
              schema:
                type: string
              description: the identifier that used to store the entry's data
            X-Nats-Obj-Size:
              schema:
                type: number
                format: uint64
              description: the size of the entry's data in bytes
            X-Nats-Obj-Mod-Time:
              schema:
                type: date-time
              description: date when the entry was last modified
            X-Nats-Obj-Chunks:
              schema:
                type: number
                format: uint32
              description: the number of chunks used to store the entry
            X-Nats-Obj-Digest:
              schema:
                type: string
              description: the Base64 encoded SHA-256 digest of the entry's data
            X-Nats-Obj-Description:
              schema:
                type: string
              description: the description of the entry
            X-Nats-Obj-Max-Chunk-Size:
              schema:
                type: number
              description: the maximum size in bytes of a single chunk
            X-Nats-Obj-Link-Bucket:
              schema:
                type: string
              description: if set, the name of the bucket containing the entry
            X-Nats-Obj-Link-Name:
              schema:
                type: string
              description: if set, the name of the entry as stored in a different bucket
            X-Nats-Obj-Deleted:
              schema:
                type: boolean
              description: if true, the entry is marked as deleted
          description: success response body is payload, and metadata is HTTP headers
          content:
            application/text:
              schema:
                type: string
                format: binary
                x-content-type: application/text
        '400':
          description: Invalid Request
        '404':
          description: Key not found
      summary: Obj get entry
      x-summary-source: derived
    put:
      tags:
      - ObjectStore Entry Operations
      summary: Adds or updates an entry to the object store,
      operationId: ObjCreateEntry
      requestBody:
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
          application/text:
            schema:
              type: string
          application/json:
            schema:
              type: object
              additionalProperties:
                type: object
      responses:
        '200':
          description: ObjectInfo Response
          content:
            application/json:
              schema:
                x-content-type: application/json
                type: object
                properties:
                  name:
                    type: string
                  description:
                    type: string
                  metadata:
                    type: object
                    additionalProperties:
                      type: string
                    x-schema-name: Metadata
                  link:
                    type: object
                    properties:
                      bucket:
                        type: string
                      name:
                        type: string
                  max_chunk_size:
                    type: number
                    format: uint32
                  bucket:
                    type: string
                  nuid:
                    type: string
                  size:
                    type: number
                    format: uint64
                  mtime:
                    type: string
                    format: date-time
                  chunks:
                    type: number
                    format: uint32
                  digest:
                    type: string
                  deleted:
                    type: boolean
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
    delete:
      tags:
      - ObjectStore Entry Operations
      summary: Delete an entry
      operationId: ObjDeleteEntry
      parameters:
      - name: purge
        in: query
        description: Purges the deleted entry
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: Success response
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '404':
          description: Key not found
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      name: Authorization
      in: header