aYOUne
← AI API

AIWorkflows

Singular: AIWorkflow — Base URL: https://ai.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": {
    "_id": "6a618a58276160baeebcc5f4",
    "name": "Copilot Health Check",
    "description": "Zero-cost two-step smoke workflow: proves the tenant's workflow runtime end-to-end (conditional steps, no LLM spend). Clone-Basis für eigene Workflows.",
    "status": "active",
    "steps": [
      {
        "notificationConfig": {
          "recipients": []
        },
        "condition": {
          "field": "status",
          "operator": "exists"
        },
        "stepId": "check-runtime",
        "name": "Runtime check",
        "type": "conditional",
        "parallelSteps": [],
        "retryCount": 0,
        "onFailure": "stop",
        "nextStep": "confirm",
        "sortOrder": 0,
        "_id": "6a5cccd74e8ab60d02036025",
        "isDraft": true,
        "shares": []
      },
      {
        "notificationConfig": {
          "recipients": []
        },
        "condition": {
          "field": "status",
          "operator": "exists"
        },
        "stepId": "confirm",
        "name": "Confirm completion",
        "type": "conditional",
        "parallelSteps": [],
        "retryCount": 0,
        "onFailure": "stop",
        "sortOrder": 1,
        "_id": "6a5cccd74e8ab60d02036026",
        "isDraft": true,
        "shares": []
      }
    ],
    "feedbackLoopEnabled": false,
    "triggerType": "manual",
    "global": false,
    "isTemplate": false,
    "isDraft": true,
    "createdAt": "2026-07-23T03:28:24.573Z",
    "updatedAt": "2026-07-23T03:28:24.573Z",
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://ai.ayoune.app/aiworkflows/6a618a58276160baeebcc5f4",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "AICronJobs",
        "title": "MODEL_AICRONJOB",
        "href": "https://api.ayoune.app/ai/aicronjobs",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "ai.aicronjobs"
      }
    ],
    "debugId": "6aa0cf131d5f163b722c8b2f",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_AIWORKFLOW",
        "href": "https://api.ayoune.app/ai/aiworkflows/6a618a58276160baeebcc5f4/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_AIWORKFLOW",
        "href": "https://api.ayoune.app/ai/aiworkflows/6a618a58276160baeebcc5f4",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.172.0",
      "core": "2026.334.1"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "9689",
      "reset": "1788927245",
      "resetDate": "Wed Sep 09 2026"
    },
    "responseTime": 56.704316,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also