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

Vertrag & Verhalten

Dokumentationsstand: reviewed
Ändert Zustand: Ja
Als readOnly markiert: Nein
Für Automation markiert: Nein

Authentifizierung

Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).

Alternative 1

bearerAuthhttp · bearer

Existing edoobox v2 access token. Never substitute API key/secret headers.

Format: JWT

Security-Schema als JSON

{
  "type": "http",
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "description": "Existing edoobox v2 access token. Never substitute API key/secret headers."
}

accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON

{
  "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."
}

Alternative 2

sessionCookieapiKey

Existing browser login session, with the same permission checks as Bearer authentication.

cookie: _edlogin

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "cookie",
  "name": "_edlogin",
  "description": "Existing browser login session, with the same permission checks as Bearer authentication."
}

accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON

{
  "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."
}

Berechtigungen

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.

Ressource: aiassistant
Levels: 3, 4
Dispatcher-Prüfung: Nein

Parameter

Header

languageoptional

Account language code, where the resource supports setLanguage().

string

Schema-Beispiel

"de"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "de"
  ]
}

Request Body

optional

`application/json`

object

data object

provider Typ nicht eingeschränkt

Erlaubte Werte

"platform""byok"

openai_key string | null writeOnly

Kontoweiter BYOK-Schlüssel; null entfernt ihn. Niemals Antworten, Logs oder Beispielen mit echten Schlüsseln hinzufügen.

pattern: "^sk-[A-Za-z0-9_-]{16,500}$"

enabled boolean

request_id string | number

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.

pattern: "^[A-Za-z0-9_.:-]{8,160}$"

allOf · Alle Teilschemas müssen gemeinsam passen

Variante 1 Typ nicht eingeschränkt

Schema-Regel if

Typ nicht eingeschränkt

Zusätzlich erforderlich, ohne eigenes Feldschema: enabled

Schema-Regel then

Typ nicht eingeschränkt

Zusätzlich erforderlich, ohne eigenes Feldschema: request_id

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "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
}

KI-Assistent konfigurieren

{
  "data": {
    "provider": "platform"
  }
}

Antworten

HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.

200application/json

Aktualisierter Status wie GET status; bei configure enthält der Service keine permissions-Ergänzung des GET-Controllers.

`application/json`

object

success boolean

error boolean | string

error_code string

data object

enabled boolean

provider object

mode Typ nicht eingeschränkt

Erlaubte Werte

"platform""byok"

configured boolean

simulation boolean

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

quota object

free_limit integer

input_tokens integer

output_tokens integer

total_tokens integer

reserved_tokens integer

byok_input_tokens integer

byok_output_tokens integer

paid_balance_tokens integer

paid_reserved_tokens integer

paid_available_tokens integer

free_remaining_tokens integer

remaining_tokens integer

month string

payment_review_required boolean

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

byok object

configured boolean

scope Typ nicht eingeschränkt

Fester Wert: "account"

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

purchase object

available boolean

route_name Typ nicht eingeschränkt

Fester Wert: "system.accounting"

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

retention_days integer

permissions object

can_configure boolean

can_purchase boolean

can_activate boolean

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

type string

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "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
}

Beispiel

{
  "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
  }
}

400application/json

Invalid request.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40006"
}

401application/json

Missing/expired token, missing account context, account paused or model-specific authorization failure.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40103"
}

402application/json

Missing/invalid action data or subscription/operation restriction.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80100"
}

403application/json

Permission denied. Browser CORS rejection may have an empty body.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40340"
}

404application/json

Unknown resource/action or unsupported method.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80019"
}

422application/json

Validation failed.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80020"
}

429application/json

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.

Response Header

`Retry-After`

Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.

string

Schema-Beispiel

"30"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "30"
  ]
}

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED42902"
}

502application/json

Server-side operation failed.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED50201"
}

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Aiassistant.php:18updateAiassistant()

Diese Angaben stammen unverändert aus der gelieferten OpenAPI-Datei. Zusätzliche Freigaben, Vorbedingungen, sensible Felder und Hinweise stehen in den Erweiterungen.

x-edoobox-mutates-state

true

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."
}

Vollständige Operation als 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."
  }
}

Aufruf vorbereiten

Beispiel

Platzhalter ersetzen und Vertragsangaben prüfen. Die Beispiele werden hier nicht ausgeführt.

cURL

# 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

// 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

# 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.

Ohne JavaScript können Sie die weiteren Aufrufbeispiele hier aufklappen und den Code manuell kopieren.

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

# 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.

Server aus der Spezifikation

https://app2.edoobox.com

edoobox API

Verwenden Sie die für Ihre Integration bestätigte API-Basis-URL. Ein lokaler Entwicklungsserver ist keine Produktionsadresse.

Als Markdown lesenEin Endpunkt. Vollständig. Für Menschen und LLM.