Zum Inhalt
edoobox Docs
Kostenlos testen 7 Tage unverbindlich testen
Menü
Kostenlos testen 7 Tage unverbindlich testen
OpenAPI herunterladen
aiassistantAPI-Referenz
GET/v2/aiassistant/status

KI-Assistent: Aktivierung, Budget und Fähigkeiten lesen

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. Liefert Aktivierung, Providerstatus, Tokenbudget, Kaufverfügbarkeit und Berechtigungsanzeigen. Initialisiert bei Bedarf Konto-Einstellungen und Monatsverbrauch und gleicht serverseitig bestätigte Zahlungen ab; dadurch kann bezahltes Token-Guthaben gutgeschrieben oder überprüft werden. Gibt keinen OpenAI-Schlüssel oder sonstige Provider-Zugangsdaten zurück.

Operation-ID get_v2_aiassistant_status

01

Vertrag & Verhalten

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

Dieser GET-Aufruf kann Zustand verändern. Die HTTP-Methode allein kennzeichnet hier keinen reinen Lesezugriff.

GET-Verhalten laut Spezifikation

business-mutation

02

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.

03

Parameter

Header

languageoptional

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

string
Schema-Beispiel
"de"
Vollständiges Schema als JSON
{
  "type": "string",
  "examples": [
    "de"
  ]
}
04

Request Body

Kein Request Body in der Spezifikation beschrieben.

05

Antworten

9

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

200application/json

Statusobjekt mit enabled, provider, quota, byok, purchase, retention_days und permissions.

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.

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,
    "permissions": {
      "can_configure": true,
      "can_purchase": false,
      "can_activate": true
    }
  }
}
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"
}
06

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Aiassistant.php:10getAiassistant()

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-server-authorization
true
x-edoobox-server-authorization-source
{
  "file": "application/models/v2/Aiassistant.php",
  "line": 26,
  "reason": "Dedicated administrator/account identity, ownership, plugin and action-specific settings/billing checks. No legacy permission.short exists; maintenance side effects remain conservatively classified and must not acquire fictitious legacy write permission."
}
x-edoobox-runtimeMutationGuard
false
x-edoobox-get-effect
"business-mutation"
x-edoobox-documentationReview
{
  "file": "docs/openapi/operation-contracts/09-messages-ai.json",
  "notes": []
}
x-edoobox-source
{
  "file": "application/models/v2/Aiassistant.php",
  "method": "getAiassistant",
  "line": 10
}
x-edoobox-documentationStatus
"reviewed"
x-edoobox-readOnly
false
x-edoobox-safeForAutomation
false
x-edoobox-permission
{
  "resource": "aiassistant",
  "short": null,
  "checkedByDispatcher": false,
  "levels": [
    1,
    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": "get_v2_aiassistant_status",
  "summary": "KI-Assistent: Aktivierung, Budget und Fähigkeiten lesen",
  "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. Liefert Aktivierung, Providerstatus, Tokenbudget, Kaufverfügbarkeit und Berechtigungsanzeigen. Initialisiert bei Bedarf Konto-Einstellungen und Monatsverbrauch und gleicht serverseitig bestätigte Zahlungen ab; dadurch kann bezahltes Token-Guthaben gutgeschrieben oder überprüft werden. Gibt keinen OpenAI-Schlüssel oder sonstige Provider-Zugangsdaten zurück.",
  "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": "Statusobjekt mit enabled, provider, quota, byok, purchase, retention_days und permissions.",
      "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,
              "permissions": {
                "can_configure": true,
                "can_purchase": false,
                "can_activate": true
              }
            }
          },
          "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,
  "x-edoobox-server-authorization": true,
  "x-edoobox-server-authorization-source": {
    "file": "application/models/v2/Aiassistant.php",
    "line": 26,
    "reason": "Dedicated administrator/account identity, ownership, plugin and action-specific settings/billing checks. No legacy permission.short exists; maintenance side effects remain conservatively classified and must not acquire fictitious legacy write permission."
  },
  "x-edoobox-runtimeMutationGuard": false,
  "x-edoobox-get-effect": "business-mutation",
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/09-messages-ai.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Aiassistant.php",
    "method": "getAiassistant",
    "line": 10
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "aiassistant",
    "short": null,
    "checkedByDispatcher": false,
    "levels": [
      1,
      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."
  }
}