aYOUne
← CMS API

TextGenerators

Singular: TextGenerator — Base URL: https://cms-api.ayoune.app — Access: CRUD

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": {
    "_id": "65e0afcf121b7d48fe155860",
    "createdBy": "6045f4d25704710012485569",
    "progress": 0,
    "useQuery": false,
    "fileFromData": false,
    "fileFromDataField": "",
    "lastExecutionTime": 0,
    "totalExecutionTime": 0,
    "numExecutions": 0,
    "texts": [],
    "createdAt": "2024-02-29T16:24:47.246Z",
    "updatedAt": "2024-02-29T16:24:47.246Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://cms-api.ayoune.app/textgenerators/65e0afcf121b7d48fe155860",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Queries",
        "title": "MODEL_QUERY",
        "href": "https://api.ayoune.app/config/queries",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.queries"
      }
    ],
    "debugId": "6a62dc7f01c81db07e1db6f3",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_TEXTGENERATOR",
        "href": "https://api.ayoune.app/cms/textgenerators/65e0afcf121b7d48fe155860/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_TEXTGENERATOR",
        "href": "https://api.ayoune.app/cms/textgenerators/65e0afcf121b7d48fe155860/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.25.5",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2335",
      "reset": "1784867449",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 15.977919,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also