aYOUne
← communication API

CallAgents

Singular: CallAgent — Base URL: https://communication-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": {
    "onboardingChecks": {
      "state": "pending",
      "items": []
    },
    "disabledTopics": [],
    "costCapDaily": 50,
    "maxConcurrentCalls": 1,
    "isActive": true,
    "toolIds": [],
    "_id": "69fd4fae4456bf4be4072f8a",
    "name": "Default Tolinax Voice-Agent",
    "description": "Erste Konfiguration nach Voice-W2-Bootstrap. STT: Deepgram, PSTN: Twilio.",
    "phoneNumber": "+4989255525668",
    "pstnProvider": "twilio",
    "pstnConfig": {
      "accountSid": "set-via-credentials-vault",
      "twimlAppSid": "AP8cfb56008ea5a7917e57c5f14440f5c8",
      "streamWebsocketUrl": "wss://voice-stream.ayoune.app/voice/stream"
    },
    "sttProvider": "deepgram",
    "sttConfig": {
      "model": "nova-2",
      "interim_results": true,
      "smart_format": true,
      "punctuate": true,
      "language": "de"
    },
    "preferredLocale": "de-DE",
    "disclosureText": "Diese Konversation wird zur Qualitätssicherung aufgezeichnet und kann durch eine künstliche Intelligenz analysiert werden. Bitte bestätigen Sie mit \"Ja, einverstanden\" oder beenden Sie das Gespräch.",
    "disclosureRequired": false,
    "disclosureBlockUntilConfirmed": false,
    "recordingEnabled": true,
    "recordingRetentionDays": 30,
    "active": true,
    "createdAt": "2026-05-08T02:51:26.926Z",
    "updatedAt": "2026-05-08T02:51:26.926Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://communication-api.ayoune.app/callagents/69fd4fae4456bf4be4072f8a",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Websites",
        "title": "MODEL_WEBSITE",
        "href": "https://api.ayoune.app/cms/websites",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "cms.websites"
      },
      {
        "rel": "AIAgents",
        "title": "MODEL_AIAGENT",
        "href": "https://api.ayoune.app/ai/aiagents",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "ai.aiagents"
      }
    ],
    "debugId": "6a62dc9d715b92602aca575a",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_CALLAGENT",
        "href": "https://api.ayoune.app/communication/callagents/69fd4fae4456bf4be4072f8a/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_CALLAGENT",
        "href": "https://api.ayoune.app/communication/callagents/69fd4fae4456bf4be4072f8a/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.12.2",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2469",
      "reset": "1784867498",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 95.00814,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also