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/v1Alle 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
| Methode | Verwendung |
|---|---|
GET | Ressource lesen |
POST | Ressource anlegen oder Aktion auslösen |
PATCH | Ressource teilweise aktualisieren |
DELETE | Ressource löschen |
Status-Codes
| Code | Bedeutung |
|---|---|
200 OK | Erfolgreich |
201 Created | Ressource erfolgreich angelegt |
400 Bad Request | Ungültige Anfrage (fehlende/falsche Parameter) |
401 Unauthorized | Kein oder ungültiger Token |
403 Forbidden | Keine Berechtigung für diese Ressource |
404 Not Found | Ressource nicht gefunden |
422 Unprocessable Entity | Validierungsfehler |
500 Internal Server Error | Interner 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
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