aYOUne
← CMS API

Streams

Singular: Stream — Base URL: https://cms-api.ayoune.app — Access: CRUD — Machine-readable spec (JSON · YAML)

play_circle Try it now beta

Requests are proxied through the consumer-app to *.ayoune.app. Tokens stay in your browser and are forwarded per call.

Example response (recorded) sample

A real, previously recorded GET /:id response of this endpoint — not the live call above. Sensitive fields are masked.

{
  "payload": {
    "musicMeta": {
      "title": "",
      "subtitle": "",
      "artist": "",
      "album": "",
      "album_artist": "",
      "genre": "Podcast",
      "track": "",
      "comment": "",
      "language": "",
      "mood": "",
      "podcastkeywords": "",
      "podcastcategory": "",
      "podcastdesc": ""
    },
    "options": {
      "showLogo": true,
      "showTitle": true,
      "showCover": true,
      "roundCover": true,
      "showDescriptions": true,
      "showShareLinks": true,
      "showBuyLinks": true,
      "showMarkers": true,
      "showChapters": true,
      "coverSize": 96,
      "waveSize": 100,
      "shareUrl": ""
    },
    "meta": {
      "sampleRate": 0,
      "size": 0,
      "fileType": "",
      "totalDuration": 0,
      "waveformData": "",
      "waveformUrl": "",
      "markers": []
    },
    "summary": {
      "source": {
        "urlOrUploadKey": "",
        "sourceTextSnapshot": ""
      },
      "locales": [],
      "scriptModel": "",
      "ttsProvider": "",
      "humanReviewFlag": false,
      "speakerVoices": []
    },
    "_id": "6a9a3d1ade44e793983efa80",
    "type": "audio",
    "productName": "",
    "name": "CENTRAL_MAROON_KIT FISTO",
    "slug": "",
    "fileUrl": "",
    "totalPlays": 0,
    "totalPlayTime": 0,
    "createdBy": "6045f4d25704710012485569",
    "parts": [],
    "shares": [],
    "createdAt": "2026-09-04T03:38:02.138Z",
    "updatedAt": "2026-09-04T03:38:03.334Z",
    "modifiedBy": "6045f4d25704710012485569"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://cms-api.ayoune.app/streams/6a9a3d1ade44e793983efa80",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Products",
        "title": "MODEL_PRODUCT",
        "href": "https://api.ayoune.app/pim/products",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pim.products"
      },
      {
        "rel": "Podcasts",
        "title": "MODEL_PODCAST",
        "href": "https://api.ayoune.app/cms/podcasts",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "cms.podcasts"
      },
      {
        "rel": "Images",
        "title": "MODEL_IMAGE",
        "href": "https://api.ayoune.app/cms/images",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "cms.images"
      }
    ],
    "debugId": "6a9a3d1bf1e2cb6f240a4ec9",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_STREAM",
        "href": "https://api.ayoune.app/cms/streams/6a9a3d1ade44e793983efa80/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_STREAM",
        "href": "https://api.ayoune.app/cms/streams/6a9a3d1ade44e793983efa80",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.46.0",
      "core": "2026.328.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2211",
      "reset": "1788496622",
      "resetDate": "Fri Sep 04 2026"
    },
    "responseTime": 24.03585,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

MethodPathDescriptionRight
GET /streams List with filters/pagination cms.streams.view
GET /streams/:id Single record cms.streams.view
POST /streams Create new record cms.streams.new
PUT /streams Update record cms.streams.edit
DELETE /streams/:id Delete record cms.streams.delete

SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

// List all
const list = await ay.cms.streams.find().limit(10).exec();

// Single record
const one = await ay.cms.streams.findById('OBJECT_ID').exec();

// Create
const created = await ay.cms.streams.create({ name: 'Foo' });

See also