aYOUne
← Automation API

BotRequests

Singular: BotRequest — Base URL: https://automation-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": "65e0afbc121b7d48fe155233",
    "started": false,
    "running": false,
    "done": false,
    "stepsLeft": false,
    "steps": false,
    "progress": 0,
    "attempts": 0,
    "results": [],
    "createdBy": "6045f4d25704710012485569",
    "intents": [],
    "createdAt": "2024-02-29T16:24:28.692Z",
    "updatedAt": "2024-02-29T16:24:28.692Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://automation-api.ayoune.app/botrequests/65e0afbc121b7d48fe155233",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6a62dc44f9f895648ea726b8",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_BOTREQUEST",
        "href": "https://api.ayoune.app/automation/botrequests/65e0afbc121b7d48fe155233/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_BOTREQUEST",
        "href": "https://api.ayoune.app/automation/botrequests/65e0afbc121b7d48fe155233/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.19.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2458",
      "reset": "1784867403",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 84.945514,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also