# PUT /v2/aiassistant/config KI-Assistent konfigurieren Erfordert einen authentifizierten Administrator im ausgewählten Konto. Gespräche, Läufe und Artefakte sind zusätzlich an diesen Administrator gebunden; Quellenberechtigungen und Ablaufzeit werden erneut geprüft. Ändert Provider und optional den kontoweit verschlüsselt gespeicherten OpenAI-Schlüssel. provider=byok erfordert einen wirksamen Schlüssel; openai_key=null entfernt ihn. enabled muss ein JSON-Boolean sein; Aktivierung/Deaktivierung erfordert zusätzlich Plugin-Rechte und request_id. Aktivierung ist nur für das verfügbare kostenlose Assistent-Plugin erlaubt. Einstellungen erfordern setti-Rechte. Schlüssel sind reine Eingabe und erscheinen nie in der Antwort. Alle Änderungsfelder und der JSON-Body sind optional; ein leerer Aufruf aktualisiert nur technische Einstellungen und liest den Status. - Operation-ID: put_v2_aiassistant_config - Dokumentation: /docs/api/v2/operations/put-v2-aiassistant-config-fde2efdb91f3/ - OpenAPI-Version: 3.2.1 - Vollständige Spezifikation: /docs/api/v2/openapi.json - Dokumentationsstatus: reviewed - Ändert Zustand: ja - Für Automation freigegeben: nein ## Server Serverwerte stammen unverändert aus der Datei. Eine lokale Entwicklungsadresse ist keine bestätigte Produktionsadresse. `API_ORIGIN` muss auf die passende Instanz gesetzt werden. ```json [ { "url": "https://app2.edoobox.com", "description": "edoobox API" } ] ``` ## Authentifizierung Eine der folgenden Alternativen genügt (ODER). Innerhalb einer Alternative müssen alle Verfahren gemeinsam erfüllt sein (UND). 1. **bearerAuth** (HTTP bearer) — Existing edoobox v2 access token. Never substitute API key/secret headers. **UND** **accountContext** (header: edid) — Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account. 2. **sessionCookie** (cookie: _edlogin) — Existing browser login session, with the same permission checks as Bearer authentication. **UND** **accountContext** (header: edid) — Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account. ### Wirksame Security Requirements und vollständige Verfahren ```json { "security": [ { "bearerAuth": [], "accountContext": [] }, { "sessionCookie": [], "accountContext": [] } ], "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Existing edoobox v2 access token. Never substitute API key/secret headers." }, "accountContext": { "type": "apiKey", "in": "header", "name": "edid", "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account." }, "sessionCookie": { "type": "apiKey", "in": "cookie", "name": "_edlogin", "description": "Existing browser login session, with the same permission checks as Bearer authentication." } } } ``` ## Parameter | Name | Ort | Pflicht | Beschreibung | | --- | --- | --- | --- | | language | header | nein | Account language code, where the resource supports setLanguage(). | ### Vollständige wirksame Parameterdefinitionen ```json [ { "name": "language", "in": "header", "required": false, "description": "Account language code, where the resource supports setLanguage().", "schema": { "type": "string", "examples": [ "de" ] } } ] ``` ## Anfrage ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "provider": { "enum": [ "platform", "byok" ] }, "openai_key": { "type": [ "string", "null" ], "pattern": "^sk-[A-Za-z0-9_-]{16,500}$", "writeOnly": true, "description": "Kontoweiter BYOK-Schlüssel; null entfernt ihn. Niemals Antworten, Logs oder Beispielen mit echten Schlüsseln hinzufügen." }, "enabled": { "type": "boolean" }, "request_id": { "type": [ "string", "number" ], "pattern": "^[A-Za-z0-9_.:-]{8,160}$", "description": "Nach String-Konvertierung 8–160 Zeichen aus A–Z, a–z, 0–9, _, ., :, -. Pro logisch neuem Auftrag einen neuen Schlüssel wählen; nur identische Wiederholung darf denselben Schlüssel verwenden." } }, "additionalProperties": true, "allOf": [ { "if": { "required": [ "enabled" ] }, "then": { "required": [ "request_id" ] } } ] } }, "additionalProperties": true }, "examples": { "request": { "summary": "KI-Assistent konfigurieren", "value": { "data": { "provider": "platform" } } } } } } } ``` ## Antworten HTTP-Status und Antwortinhalt gemeinsam auswerten. Die folgenden Beschreibungen und Schemata sind die Angaben der Quelldatei. ```json { "200": { "description": "Aktualisierter Status wie GET status; bei configure enthält der Service keine permissions-Ergänzung des GET-Controllers.", "content": { "application/json": { "example": { "success": true, "error": false, "data": { "enabled": true, "provider": { "mode": "platform", "configured": true, "simulation": false }, "quota": { "month": "2026-10", "free_limit": 100000, "input_tokens": 0, "output_tokens": 0, "total_tokens": 0, "reserved_tokens": 0, "byok_input_tokens": 0, "byok_output_tokens": 0, "paid_balance_tokens": 0, "paid_reserved_tokens": 0, "paid_available_tokens": 0, "free_remaining_tokens": 100000, "remaining_tokens": 100000, "payment_review_required": false }, "byok": { "configured": false, "scope": "account" }, "purchase": { "available": false, "route_name": "system.accounting" }, "retention_days": 30 } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": [ "boolean", "string" ] }, "error_code": { "type": "string" }, "data": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "provider": { "type": "object", "properties": { "mode": { "enum": [ "platform", "byok" ] }, "configured": { "type": "boolean" }, "simulation": { "type": "boolean" } }, "additionalProperties": true }, "quota": { "type": "object", "properties": { "free_limit": { "type": "integer" }, "input_tokens": { "type": "integer" }, "output_tokens": { "type": "integer" }, "total_tokens": { "type": "integer" }, "reserved_tokens": { "type": "integer" }, "byok_input_tokens": { "type": "integer" }, "byok_output_tokens": { "type": "integer" }, "paid_balance_tokens": { "type": "integer" }, "paid_reserved_tokens": { "type": "integer" }, "paid_available_tokens": { "type": "integer" }, "free_remaining_tokens": { "type": "integer" }, "remaining_tokens": { "type": "integer" }, "month": { "type": "string" }, "payment_review_required": { "type": "boolean" } }, "additionalProperties": true }, "byok": { "type": "object", "properties": { "configured": { "type": "boolean" }, "scope": { "const": "account" } }, "additionalProperties": true }, "purchase": { "type": "object", "properties": { "available": { "type": "boolean" }, "route_name": { "const": "system.accounting" } }, "additionalProperties": true }, "retention_days": { "type": "integer" }, "permissions": { "type": "object", "properties": { "can_configure": { "type": "boolean" }, "can_purchase": { "type": "boolean" }, "can_activate": { "type": "boolean" } }, "additionalProperties": true } }, "additionalProperties": true }, "type": { "type": "string" } }, "additionalProperties": true } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "example": { "success": false, "error": "ED40006" } } } }, "401": { "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.", "content": { "application/json": { "example": { "success": false, "error": "ED40103" } } } }, "402": { "description": "Missing/invalid action data or subscription/operation restriction.", "content": { "application/json": { "example": { "success": false, "error": "ED80100" } } } }, "403": { "description": "Permission denied. Browser CORS rejection may have an empty body.", "content": { "application/json": { "example": { "success": false, "error": "ED40340" } } } }, "404": { "description": "Unknown resource/action or unsupported method.", "content": { "application/json": { "example": { "success": false, "error": "ED80019" } } } }, "422": { "description": "Validation failed.", "content": { "application/json": { "example": { "success": false, "error": "ED80020" } } } }, "429": { "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.", "content": { "application/json": { "example": { "success": false, "error": "ED42902" } } }, "headers": { "Retry-After": { "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.", "schema": { "type": "string", "examples": [ "30" ] } } } }, "502": { "description": "Server-side operation failed.", "content": { "application/json": { "example": { "success": false, "error": "ED50201" } } } } } ``` ## Aufrufbeispiele Anpassen vor dem Ausführen. Platzhalter und veröffentlichte Beispiele sind synthetisch. Die Beispiele senden hier keine Anfrage; sie ergänzen keine unbekannten Pflichtfelder. ### cURL ```sh # Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich. # Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen. : "${API_ORIGIN:?API_ORIGIN setzen}" : "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}" : "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}" cat > payload.json <<'EDOOBOX_JSON_EXAMPLE' { "data": { "provider": "platform" } } EDOOBOX_JSON_EXAMPLE curl --request 'PUT' \ --url "${API_ORIGIN%/}"'/v2/aiassistant/config' \ --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \ --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" \ --header 'Content-Type: application/json' \ --data-binary '@payload.json' ``` ### JavaScript (Node.js) ```javascript // Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich. // Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen. const required = (name) => { const value = process.env[name]; if (!value) throw new Error(`Set ${name}`); return value; }; let path = "/v2/aiassistant/config"; const origin = required('API_ORIGIN'); const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path); const headers = {}; headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH"); headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT"); headers['Content-Type'] = "application/json"; const body = JSON.stringify({ "data": { "provider": "platform" } }); const response = await fetch(url, { method: "PUT", headers, body, redirect: 'manual' }); const text = await response.text(); console.log(response.status, text); // HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen. ``` ### Python ```python # Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich. # Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen. import os import urllib.parse import urllib.request import urllib.error path = "/v2/aiassistant/config" url = os.environ["API_ORIGIN"].rstrip("/") + path headers = {} headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"] headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"] headers["Content-Type"] = "application/json" body = "{\"data\":{\"provider\":\"platform\"}}".encode("utf-8") # Redirects nicht automatisch verfolgen. class NoRedirect(urllib.request.HTTPRedirectHandler): def redirect_request(self, req, fp, code, msg, headers, newurl): return None request = urllib.request.Request(url, headers=headers, method="PUT", data=body) try: response = urllib.request.build_opener(NoRedirect).open(request, timeout=30) except urllib.error.HTTPError as error: response = error print(response.status, response.read().decode("utf-8", errors="replace")) # HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen. ``` ## Vollständige Operationsdefinition und edoobox-Hinweise Alle Originalfelder einschliesslich `x-edoobox-*`, requestBody und responses bleiben erhalten. Teilweise dokumentierte Schemata sind kein vollständiger Validierungsvertrag. ```json { "operationId": "put_v2_aiassistant_config", "summary": "KI-Assistent konfigurieren", "description": "Erfordert einen authentifizierten Administrator im ausgewählten Konto. Gespräche, Läufe und Artefakte sind zusätzlich an diesen Administrator gebunden; Quellenberechtigungen und Ablaufzeit werden erneut geprüft. Ändert Provider und optional den kontoweit verschlüsselt gespeicherten OpenAI-Schlüssel. provider=byok erfordert einen wirksamen Schlüssel; openai_key=null entfernt ihn. enabled muss ein JSON-Boolean sein; Aktivierung/Deaktivierung erfordert zusätzlich Plugin-Rechte und request_id. Aktivierung ist nur für das verfügbare kostenlose Assistent-Plugin erlaubt. Einstellungen erfordern setti-Rechte. Schlüssel sind reine Eingabe und erscheinen nie in der Antwort. Alle Änderungsfelder und der JSON-Body sind optional; ein leerer Aufruf aktualisiert nur technische Einstellungen und liest den Status.", "tags": [ "aiassistant" ], "security": [ { "bearerAuth": [], "accountContext": [] }, { "sessionCookie": [], "accountContext": [] } ], "parameters": [ { "name": "language", "in": "header", "required": false, "description": "Account language code, where the resource supports setLanguage().", "schema": { "type": "string", "examples": [ "de" ] } } ], "responses": { "200": { "description": "Aktualisierter Status wie GET status; bei configure enthält der Service keine permissions-Ergänzung des GET-Controllers.", "content": { "application/json": { "example": { "success": true, "error": false, "data": { "enabled": true, "provider": { "mode": "platform", "configured": true, "simulation": false }, "quota": { "month": "2026-10", "free_limit": 100000, "input_tokens": 0, "output_tokens": 0, "total_tokens": 0, "reserved_tokens": 0, "byok_input_tokens": 0, "byok_output_tokens": 0, "paid_balance_tokens": 0, "paid_reserved_tokens": 0, "paid_available_tokens": 0, "free_remaining_tokens": 100000, "remaining_tokens": 100000, "payment_review_required": false }, "byok": { "configured": false, "scope": "account" }, "purchase": { "available": false, "route_name": "system.accounting" }, "retention_days": 30 } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": [ "boolean", "string" ] }, "error_code": { "type": "string" }, "data": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "provider": { "type": "object", "properties": { "mode": { "enum": [ "platform", "byok" ] }, "configured": { "type": "boolean" }, "simulation": { "type": "boolean" } }, "additionalProperties": true }, "quota": { "type": "object", "properties": { "free_limit": { "type": "integer" }, "input_tokens": { "type": "integer" }, "output_tokens": { "type": "integer" }, "total_tokens": { "type": "integer" }, "reserved_tokens": { "type": "integer" }, "byok_input_tokens": { "type": "integer" }, "byok_output_tokens": { "type": "integer" }, "paid_balance_tokens": { "type": "integer" }, "paid_reserved_tokens": { "type": "integer" }, "paid_available_tokens": { "type": "integer" }, "free_remaining_tokens": { "type": "integer" }, "remaining_tokens": { "type": "integer" }, "month": { "type": "string" }, "payment_review_required": { "type": "boolean" } }, "additionalProperties": true }, "byok": { "type": "object", "properties": { "configured": { "type": "boolean" }, "scope": { "const": "account" } }, "additionalProperties": true }, "purchase": { "type": "object", "properties": { "available": { "type": "boolean" }, "route_name": { "const": "system.accounting" } }, "additionalProperties": true }, "retention_days": { "type": "integer" }, "permissions": { "type": "object", "properties": { "can_configure": { "type": "boolean" }, "can_purchase": { "type": "boolean" }, "can_activate": { "type": "boolean" } }, "additionalProperties": true } }, "additionalProperties": true }, "type": { "type": "string" } }, "additionalProperties": true } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "example": { "success": false, "error": "ED40006" } } } }, "401": { "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.", "content": { "application/json": { "example": { "success": false, "error": "ED40103" } } } }, "402": { "description": "Missing/invalid action data or subscription/operation restriction.", "content": { "application/json": { "example": { "success": false, "error": "ED80100" } } } }, "403": { "description": "Permission denied. Browser CORS rejection may have an empty body.", "content": { "application/json": { "example": { "success": false, "error": "ED40340" } } } }, "404": { "description": "Unknown resource/action or unsupported method.", "content": { "application/json": { "example": { "success": false, "error": "ED80019" } } } }, "422": { "description": "Validation failed.", "content": { "application/json": { "example": { "success": false, "error": "ED80020" } } } }, "429": { "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.", "content": { "application/json": { "example": { "success": false, "error": "ED42902" } } }, "headers": { "Retry-After": { "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.", "schema": { "type": "string", "examples": [ "30" ] } } } }, "502": { "description": "Server-side operation failed.", "content": { "application/json": { "example": { "success": false, "error": "ED50201" } } } } }, "x-edoobox-mutates-state": true, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "provider": { "enum": [ "platform", "byok" ] }, "openai_key": { "type": [ "string", "null" ], "pattern": "^sk-[A-Za-z0-9_-]{16,500}$", "writeOnly": true, "description": "Kontoweiter BYOK-Schlüssel; null entfernt ihn. Niemals Antworten, Logs oder Beispielen mit echten Schlüsseln hinzufügen." }, "enabled": { "type": "boolean" }, "request_id": { "type": [ "string", "number" ], "pattern": "^[A-Za-z0-9_.:-]{8,160}$", "description": "Nach String-Konvertierung 8–160 Zeichen aus A–Z, a–z, 0–9, _, ., :, -. Pro logisch neuem Auftrag einen neuen Schlüssel wählen; nur identische Wiederholung darf denselben Schlüssel verwenden." } }, "additionalProperties": true, "allOf": [ { "if": { "required": [ "enabled" ] }, "then": { "required": [ "request_id" ] } } ] } }, "additionalProperties": true }, "examples": { "request": { "summary": "KI-Assistent konfigurieren", "value": { "data": { "provider": "platform" } } } } } } }, "x-edoobox-runtimeMutationGuard": false, "x-edoobox-documentationReview": { "file": "docs/openapi/operation-contracts/09-messages-ai.json", "notes": [] }, "x-edoobox-source": { "file": "application/models/v2/Aiassistant.php", "method": "updateAiassistant", "line": 18 }, "x-edoobox-documentationStatus": "reviewed", "x-edoobox-readOnly": false, "x-edoobox-safeForAutomation": false, "x-edoobox-permission": { "resource": "aiassistant", "short": null, "checkedByDispatcher": false, "levels": [ 3, 4 ], "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope." } } ```