Skip to content

API-Überblick

Der AI Application Layer stellt eine vollständige REST-API bereit. Damit lassen sich alle Funktionen der Plattform automatisieren: Anwendungen anlegen und deployen, Konfiguration aktualisieren, Logs abrufen und Deployments steuern.


Base URL

https://coolai.btc-ag.cloud/api/v1

Alle Endpunkte sind relativ zu dieser Base URL. Alle Anfragen erfolgen über HTTPS.


Format

  • Request-Body: application/json
  • Response: application/json
  • Zeichensatz: UTF-8

Authentifizierung

Alle API-Aufrufe erfordern einen Bearer-Token im Authorization-Header:

Authorization: Bearer <euer-api-token>

Details zur Token-Erstellung: Authentifizierung


HTTP-Methoden

MethodeVerwendung
GETRessource lesen
POSTRessource anlegen oder Aktion auslösen
PATCHRessource teilweise aktualisieren
DELETERessource löschen

Status-Codes

CodeBedeutung
200 OKErfolgreich
201 CreatedRessource erfolgreich angelegt
400 Bad RequestUngültige Anfrage (fehlende/falsche Parameter)
401 UnauthorizedKein oder ungültiger Token
403 ForbiddenKeine Berechtigung für diese Ressource
404 Not FoundRessource nicht gefunden
422 Unprocessable EntityValidierungsfehler
500 Internal Server ErrorInterner Fehler

Fehler-Response

Fehler werden einheitlich im folgenden Format zurückgegeben:

{
"message": "The application was not found.",
"errors": {
"uuid": ["The UUID does not exist."]
}
}

Paginierung

Endpunkte, die Listen zurückgeben, unterstützen derzeit keine Paginierung — alle Einträge werden auf einmal zurückgegeben.


Beispiel-Aufruf

Terminal window
curl -s https://coolai.btc-ag.cloud/api/v1/applications \
-H "Authorization: Bearer $COOLIFY_TOKEN" \
| jq '.[].name'

Vollständige API-Referenz (Swagger)

Die interaktive Swagger-Dokumentation mit allen Endpunkten und Schemas ist über die Plattform-Oberfläche erreichbar. Loggt euch ein und navigiert zu: Einstellungen → API → API-Referenz öffnen