aYOUne
← KI / AI API

Bots

Singular: Bot — Base-URL: https://bots.ayoune.app — Zugriff: CRUD — Maschinenlesbare Beschreibung (JSON · YAML)

play_circle Jetzt ausprobieren beta

Requests werden über den consumer-app Proxy an *.ayoune.app weitergeleitet. Tokens bleiben im Browser und werden pro Call mitgesendet.

Beispiel-Response (aufgezeichnet) Beispiel

Eine echte, zuvor aufgezeichnete GET /:id-Antwort dieses Endpunkts — nicht der Live-Call oben. Sensible Felder sind maskiert.

{
  "payload": {
    "initial": {
      "allowCustomAnswer": false,
      "answers": []
    },
    "knowledgeBase": {
      "use": false,
      "showAll": false,
      "btnText": "Read the full article",
      "preTextSingleResult": "",
      "preTextMultipleResult": "",
      "preTextNoResult": "",
      "limitResults": 3,
      "returnFullArticle": false,
      "suggestedArticles": [],
      "knowledgeBases": []
    },
    "_id": "65e0afb8121b7d48fe1550c3",
    "_user": "6045f4d25704710012485569",
    "active": false,
    "monitorBadWords": false,
    "monitorGoodWords": false,
    "shared": false,
    "forSale": false,
    "global": false,
    "isDraft": true,
    "createdBy": "6045f4d25704710012485569",
    "entities": [],
    "actions": [],
    "intents": [],
    "commands": [],
    "createdAt": "2024-02-29T16:24:24.049Z",
    "updatedAt": "2024-02-29T16:24:24.049Z",
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://ai.ayoune.app/bots/65e0afb8121b7d48fe1550c3",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6aa0cf14a20da3616dda2309",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_BOT",
        "href": "https://api.ayoune.app/ai/bots/65e0afb8121b7d48fe1550c3/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_BOT",
        "href": "https://api.ayoune.app/ai/bots/65e0afb8121b7d48fe1550c3",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.172.0",
      "core": "2026.334.1"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "9666",
      "reset": "1788927245",
      "resetDate": "Wed Sep 09 2026"
    },
    "responseTime": 29.959939,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

MethodePathBeschreibungRight
GET /bots Liste mit Filtern/Paginierung ai.bots.view
GET /bots/:id Einzelner Datensatz ai.bots.view
POST /bots Neuen Datensatz erstellen ai.bots.new
PUT /bots Datensatz aktualisieren ai.bots.edit
DELETE /bots/:id Datensatz löschen ai.bots.delete

SDK

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

// Alle abrufen
const list = await ay.ai.bots.find().limit(10).exec();

// Einzelnen Datensatz
const one = await ay.ai.bots.findById('OBJECT_ID').exec();

// Erstellen
const created = await ay.ai.bots.create({ name: 'Foo' });

Weiterführend