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

KI-Tokenpaket gegen Rechnung bestellen

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. Erstellt eine Kontorechnung und einen ausstehenden Tokenkauf aus dem aktuellen serverseitigen Paketkatalog. package_key und request_id sind Pflicht und echte Strings. Preis, Währung, Tokenzahl und Zahlungsstatus kommen ausschließlich vom Server; clientseitige Angaben dazu werden ignoriert. Identische request_id für denselben Admin und dasselbe Paket ist idempotent; andere Wiederverwendung wird abgelehnt. Erfordert aktivierte Kauf-Funktion sowie setti- und edsu-Rechte. Guthaben entsteht erst nach bestätigtem Zahlungsabgleich.

Operation-ID post_v2_aiassistant_purchases

01

Vertrag & Verhalten

Dokumentationsstand
reviewed
Ändert Zustand
Ja
Als readOnly markiert
Nein
Für Automation markiert
Nein
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

Authenticated administrator required by Aiassistant::handle; billing routes also check the listed existing resource rights.

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

erforderlich

application/json

object
data object erforderlich
package_key string erforderlich
request_id string erforderlich
pattern
"^[A-Za-z0-9_.:-]{8,160}$"

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

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

Vollständiges Schema als JSON
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "package_key": {
          "type": "string"
        },
        "request_id": {
          "type": "string",
          "pattern": "^[A-Za-z0-9_.:-]{8,160}$"
        }
      },
      "additionalProperties": true,
      "required": [
        "package_key",
        "request_id"
      ]
    }
  },
  "additionalProperties": true,
  "required": [
    "data"
  ]
}
KI-Tokenpaket gegen Rechnung bestellen
{
  "data": {
    "package_key": "example_package",
    "request_id": "review-purchase-0001"
  }
}
05

Antworten

9

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

200application/json

Kaufobjekt mit öffentlicher Kauf-/Rechnungs-ID und serverseitigem Zahlungsbezug; pending ist noch keine Gutschrift.

application/json

object
success boolean
error boolean | string
error_code string
data object
id string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

pattern
"^aiassistantpurchase_[a-f0-9]{12}_-?[0-9]+$"
package_key string
tokens integer
price_amount string | number
currency_iso string
status string
created_at integer
credited_at integer
invoice object
id string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

pattern
"^edinvoice_[a-f0-9]{12}_-?[0-9]+$"
url string

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

payment object
type Typ nicht eingeschränkt

Fester Wert: "invoice"

token string
invoice_id string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

pattern
"^edinvoice_[a-f0-9]{12}_-?[0-9]+$"
route_name Typ nicht eingeschränkt

Fester Wert: "system.accounting"

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": {
        "id": {
          "type": "string",
          "pattern": "^aiassistantpurchase_[a-f0-9]{12}_-?[0-9]+$",
          "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
        },
        "package_key": {
          "type": "string"
        },
        "tokens": {
          "type": "integer"
        },
        "price_amount": {
          "type": [
            "string",
            "number"
          ]
        },
        "currency_iso": {
          "type": "string"
        },
        "status": {
          "type": "string"
        },
        "created_at": {
          "type": "integer"
        },
        "credited_at": {
          "type": "integer"
        },
        "invoice": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "pattern": "^edinvoice_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
            },
            "url": {
              "type": "string"
            }
          },
          "additionalProperties": true
        },
        "payment": {
          "type": "object",
          "properties": {
            "type": {
              "const": "invoice"
            },
            "token": {
              "type": "string"
            },
            "invoice_id": {
              "type": "string",
              "pattern": "^edinvoice_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
            },
            "route_name": {
              "const": "system.accounting"
            }
          },
          "additionalProperties": true
        }
      },
      "additionalProperties": true
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
Beispiel
{
  "success": true,
  "error": false,
  "data": {
    "id": "aiassistantpurchase_012345abcdef_123456",
    "package_key": "example_package",
    "tokens": 100000,
    "price_amount": "10.00",
    "currency_iso": "CHF",
    "status": "pending",
    "created_at": 1792663200,
    "credited_at": 0,
    "invoice": {
      "id": "edinvoice_012345abcdef_123456",
      "url": "/v2/edsubscription/synthetic-reference/pay/invoice.pdf"
    },
    "payment": {
      "type": "invoice",
      "token": "synthetic-reference",
      "invoice_id": "edinvoice_012345abcdef_123456",
      "route_name": "system.accounting"
    }
  }
}
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:64postAiassistant()

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-examplePrerequisite
"Enabled account catalog must contain the exact key. Values mirror tests/V2/AiAssistantTokenPurchaseTest.php; client amounts/paid flags are not trusted."
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": "postAiassistant",
  "line": 64
}
x-edoobox-documentationStatus
"reviewed"
x-edoobox-readOnly
false
x-edoobox-safeForAutomation
false
x-edoobox-permission
{
  "resource": "aiassistant",
  "checkedByDispatcher": false,
  "description": "Authenticated administrator required by Aiassistant::handle; billing routes also check the listed existing resource rights.",
  "requiredRights": {
    "setti": [
      3,
      4
    ],
    "edsu": [
      2,
      3,
      4
    ]
  }
}
Vollständige Operation als JSON
{
  "operationId": "post_v2_aiassistant_purchases",
  "summary": "KI-Tokenpaket gegen Rechnung bestellen",
  "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. Erstellt eine Kontorechnung und einen ausstehenden Tokenkauf aus dem aktuellen serverseitigen Paketkatalog. package_key und request_id sind Pflicht und echte Strings. Preis, Währung, Tokenzahl und Zahlungsstatus kommen ausschließlich vom Server; clientseitige Angaben dazu werden ignoriert. Identische request_id für denselben Admin und dasselbe Paket ist idempotent; andere Wiederverwendung wird abgelehnt. Erfordert aktivierte Kauf-Funktion sowie setti- und edsu-Rechte. Guthaben entsteht erst nach bestätigtem Zahlungsabgleich.",
  "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": "Kaufobjekt mit öffentlicher Kauf-/Rechnungs-ID und serverseitigem Zahlungsbezug; pending ist noch keine Gutschrift.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "id": "aiassistantpurchase_012345abcdef_123456",
              "package_key": "example_package",
              "tokens": 100000,
              "price_amount": "10.00",
              "currency_iso": "CHF",
              "status": "pending",
              "created_at": 1792663200,
              "credited_at": 0,
              "invoice": {
                "id": "edinvoice_012345abcdef_123456",
                "url": "/v2/edsubscription/synthetic-reference/pay/invoice.pdf"
              },
              "payment": {
                "type": "invoice",
                "token": "synthetic-reference",
                "invoice_id": "edinvoice_012345abcdef_123456",
                "route_name": "system.accounting"
              }
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^aiassistantpurchase_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                  },
                  "package_key": {
                    "type": "string"
                  },
                  "tokens": {
                    "type": "integer"
                  },
                  "price_amount": {
                    "type": [
                      "string",
                      "number"
                    ]
                  },
                  "currency_iso": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string"
                  },
                  "created_at": {
                    "type": "integer"
                  },
                  "credited_at": {
                    "type": "integer"
                  },
                  "invoice": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "pattern": "^edinvoice_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                      },
                      "url": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": true
                  },
                  "payment": {
                    "type": "object",
                    "properties": {
                      "type": {
                        "const": "invoice"
                      },
                      "token": {
                        "type": "string"
                      },
                      "invoice_id": {
                        "type": "string",
                        "pattern": "^edinvoice_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                      },
                      "route_name": {
                        "const": "system.accounting"
                      }
                    },
                    "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": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "package_key": {
                  "type": "string"
                },
                "request_id": {
                  "type": "string",
                  "pattern": "^[A-Za-z0-9_.:-]{8,160}$"
                }
              },
              "additionalProperties": true,
              "required": [
                "package_key",
                "request_id"
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "data"
          ]
        },
        "examples": {
          "request": {
            "summary": "KI-Tokenpaket gegen Rechnung bestellen",
            "value": {
              "data": {
                "package_key": "example_package",
                "request_id": "review-purchase-0001"
              }
            }
          }
        }
      }
    }
  },
  "x-edoobox-examplePrerequisite": "Enabled account catalog must contain the exact key. Values mirror tests/V2/AiAssistantTokenPurchaseTest.php; client amounts/paid flags are not trusted.",
  "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": "postAiassistant",
    "line": 64
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "aiassistant",
    "checkedByDispatcher": false,
    "description": "Authenticated administrator required by Aiassistant::handle; billing routes also check the listed existing resource rights.",
    "requiredRights": {
      "setti": [
        3,
        4
      ],
      "edsu": [
        2,
        3,
        4
      ]
    }
  }
}