API Dokumentation

AIX Aleph API

Eine einheitliche, sichere API für Agenten-Orchestrierung, Events/Streams, Policies und Observability – von Edge bis Cloud.

AIX Orchestrierungsnetz Knoten rotieren auf Ringen, Strahlen verbinden Agenten in Teams.

Quick Start

Base URLs

Prod
https://api.aix-aleph.com/v1
Sandbox
https://sandbox.api.aix-aleph.com/v1 empfohlen für Tests

Auth

Bearer Token per OAuth2 Client Credentials oder API Key.

# Beispiel (cURL)
curl -X POST https://auth.aix-aleph.com/oauth/token \
  -d 'grant_type=client_credentials' \
  -u CLIENT_ID:CLIENT_SECRET

Rate Limits

Adaptive, fair-use basiert; Header liefern Kontingente.

PlanLimitBursts
Core1,000 req/minYes
Pro5,000 req/minYes
EnterpriseCustomCustom

SDKs

JavaScript/TypeScript

npm i @aix-aleph/sdk
import { Aleph } from '@aix-aleph/sdk'
const api = new Aleph({ baseUrl:'https://api.aix-aleph.com/v1', token: process.env.AIX_TOKEN })
const agent = await api.agents.create({ name:'planner-01', role:'planner' })

Python

pip install aix-aleph
from aix_aleph import Aleph
api = Aleph(token=os.getenv("AIX_TOKEN"))
print(api.health())

Go

go get github.com/aix-aleph/sdk-go
cli := aleph.New(os.Getenv("AIX_TOKEN"))
st, _ := cli.Health()

Endpoints – Überblick

/agents

  • POST
    Agent anlegen (Rolle, Policies, Ressourcen)
  • GET
    Agenten listen/filtern
  • PATCH
    Agent aktualisieren (z. B. Ziele)
  • DELETE
    Agent deaktivieren

/streams

  • POST
    Event/Telemetry publizieren
  • GET
    Stream abonnieren (SSE/WebSocket)

/policies

  • POST
    Richtlinie definieren (allow/deny, constraints)
  • GET
    Richtlinien & Versionen abrufen

/plans

  • POST
    Plan/Task-Graph vorschlagen lassen
  • GET
    Status, Artefakte, Kausalgraph

/explain

  • GET
    Explainability-Artefakte (CausalPath, Attestierungen)

/telemetry

  • GET
    Metriken, Latenzen, CRDT-Status

Beispiele

Agent anlegen

POST /v1/agents
Authorization: Bearer <TOKEN>
Content-Type: application/json

{
  "name": "planner-01",
  "role": "planner",
  "resources": {"cpu":"500m","mem":"512Mi"},
  "policies": ["fleet.read","dispatch.write"]
}
200 OK
{
  "id":"agt_9f2x...","status":"ready",
  "created_at":"2025-08-30T10:00:00Z"
}

Event publizieren

POST /v1/streams/fleet.events
Authorization: Bearer <TOKEN>
Content-Type: application/json

{
  "type":"vehicle/arrived",
  "vehicle_id":"veh_123",
  "soc": 0.28,
  "location": {"lat":50.12,"lon":8.67}
}
202 Accepted
{"offset":"00000017-9abe","ingested":true}

Policy definieren

POST /v1/policies
{
  "name":"no_unverified_dispatch",
  "effect":"deny",
  "when":"context.user.verified == false && action == 'dispatch'"
}

Explainability abrufen

GET /v1/explain?plan_id=pln_7ab3...
Authorization: Bearer <TOKEN>
200 OK
{
  "plan_id":"pln_7ab3...",
  "causal_path":[{"step":"perceive"},{"step":"plan"},{"step":"execute"}],
  "artifacts":[{"type":"trace","uri":"aleph://..."}]
}

Webhooks

Benachrichtigungen zu wichtigen Events (Plan fertig, Policy-Verstoß, Telemetrie-Grenzen).

Registrierung

POST /v1/webhooks
{
  "url":"https://example.com/hooks/aleph",
  "events":["plan.completed","policy.violation","fleet.arrival"],
  "secret":"<HMAC-SECRET>"
}

Signaturprüfung

# X-Aleph-Signature: sha256=<HMAC>
# Body per HMAC-SHA256 mit 'secret' prüfen

Fehler & Statuscodes

CodeTypBeschreibung
400validation_errorRequest unvollständig/ungültig
401unauthorizedToken fehlt/ungültig
403forbiddenPolicy verbietet Aktion
409conflictConcurrent-Änderung/Versionskonflikt
429rate_limitedBitte Retry-After beachten
500server_errorUnerwarteter Fehler – Request-ID im Support angeben

Changelog (v1)

  • 2025-08-30
    Initiale Veröffentlichung: Agents, Streams, Policies, Plans, Explain, Telemetry, Webhooks.

Loslegen?

Sandbox-Zugang & Beispiel-Credentials innerhalb weniger Minuten.