aiAPI-Referenz

POST/v2/ai

Text mit KI-Vorlage erzeugen, optimieren oder übersetzen

Verarbeitet den Inhalt mit einer serverseitigen KI-Textvorlage. template_key und prompt sind Pflicht; prompt enthält content, title, description und/oder requirements. options.streaming=false fordert eine abschließende JSON-Antwort mit content, truncated und reason an. Standardmäßig schreibt der Legacy-Pfad data:-gerahmte Streamereignisse und protokolliert Provider-Nutzung; er speichert den erzeugten Text nicht als Angebot oder Vorlage. Der Inhalt wird vor dem Provideraufruf gefiltert. Dieser Legacy-Endpunkt ersetzt nicht den Vorschlag-/Freigabeablauf von aiassistant. Der Streaming-Zweig setzt zunächst Content-Type text/plain; charset=utf-8 und schreibt jeweils data: gefolgt von einem JSON-Ereignis und zwei Zeilenumbrüchen. Danach kehrt die Methode in den zentralen API_OUTPUT/respondOK-Pfad zurück, der einen abschließenden JSON-Umschlag schreibt und application/json zu setzen versucht. Bereits gesendete Header/Bytes können dadurch nicht zurückgenommen werden: die Gesamtantwort kann aus Frames und angehängtem JSON bestehen und darf nicht als durchgehend gültiges JSON geparst werden. Server-/Proxy-Pufferung beeinflusst die sichtbaren Header und Chunk-Grenzen; Optionen und erzeugte Abbruchereignisse bestimmen den Inhalt. content-Ereignisse liefern einzelne Textstücke; final wird bei Timeout oder max_tokens mit truncated=true, reason und dem bis dahin gesammelten content geschrieben; end beendet den Ereignisteil. Der zurückgegebene erfolgreiche Streaming-Array enthält streaming=true und content, setzt selbst aber kein error=false. Der zentrale success-Wert kann deshalb false sein, obwohl der Ereignisteil erzeugt wurde; immer den dokumentierten Modus und dessen Felder auswerten.

Operation-ID post_v2_ai

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: ai · ai
Levels: 2, 3, 4
Dispatcher-Prüfung: Ja

Parameter

Header

languageoptional

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

string

Schema-Beispiel

"de"

Vollständiges Schema als JSON

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

X-Edoobox-If-Revisionoptional

Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review.

string

pattern: "^[a-f0-9]{32}$"

Schema-Beispiel

"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$",
  "examples": [
    "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  ]
}

Request Body

erforderlich

`application/json`

object

data object erforderlich

template_key Typ nicht eingeschränkt erforderlich

Erlaubte Werte

"event_description_create""text_optimize""event_description_bootstrap""email_template_optimize""pdf_template_optimize""modern_event_description""translate"

prompt object erforderlich

content string

title string

description string

requirements string

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

options object

streaming boolean

use_cache boolean

response_profile string

speed, balanced oder quality; unbekannte Werte fallen auf das Standardprofil zurück.

output_size string

short, medium oder long; unbekannte Werte werden normalisiert.

target_language string

custom_instructions string

model string

max_tokens integer | string

retry_max_tokens integer | string

temperature number | string

resource_id string

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

pattern: "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"

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

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "template_key": {
          "enum": [
            "event_description_create",
            "text_optimize",
            "event_description_bootstrap",
            "email_template_optimize",
            "pdf_template_optimize",
            "modern_event_description",
            "translate"
          ]
        },
        "prompt": {
          "type": "object",
          "properties": {
            "content": {
              "type": "string"
            },
            "title": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "requirements": {
              "type": "string"
            }
          },
          "additionalProperties": true
        },
        "options": {
          "type": "object",
          "properties": {
            "streaming": {
              "type": "boolean"
            },
            "use_cache": {
              "type": "boolean"
            },
            "response_profile": {
              "type": "string",
              "description": "speed, balanced oder quality; unbekannte Werte fallen auf das Standardprofil zurück."
            },
            "output_size": {
              "type": "string",
              "description": "short, medium oder long; unbekannte Werte werden normalisiert."
            },
            "target_language": {
              "type": "string"
            },
            "custom_instructions": {
              "type": "string"
            },
            "model": {
              "type": "string"
            },
            "max_tokens": {
              "type": [
                "integer",
                "string"
              ]
            },
            "retry_max_tokens": {
              "type": [
                "integer",
                "string"
              ]
            },
            "temperature": {
              "type": [
                "number",
                "string"
              ]
            },
            "resource_id": {
              "type": "string",
              "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
            }
          },
          "additionalProperties": true
        }
      },
      "additionalProperties": true,
      "required": [
        "template_key",
        "prompt"
      ]
    }
  },
  "additionalProperties": true,
  "required": [
    "data"
  ]
}

Text mit KI-Vorlage erzeugen, optimieren oder übersetzen

{
  "data": {
    "template_key": "text_optimize",
    "prompt": {
      "content": "Willkommen zu unserem Kurs."
    },
    "options": {
      "streaming": false,
      "output_size": "short"
    }
  }
}

Antworten

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

200application/json · text/plain

Bei streaming=false oberste JSON-Felder content/truncated/reason; Legacy-Streaming schreibt data:-Frames und kann danach eine API-JSON-Antwort anhängen.

Response Header

`X-Edoobox-Revision`

Rotated account revision supplied for the next action in one reviewed sequence.

string

pattern: "^[a-f0-9]{32}$"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$"
}

`application/json`

object

success boolean

error boolean | string

content string | null

truncated boolean

reason string | null

error_message string

streaming boolean

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

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "boolean",
        "string"
      ]
    },
    "content": {
      "type": [
        "string",
        "null"
      ]
    },
    "truncated": {
      "type": "boolean"
    },
    "reason": {
      "type": [
        "string",
        "null"
      ]
    },
    "error_message": {
      "type": "string"
    },
    "streaming": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "content": "Herzlich willkommen zu unserem Kurs.",
  "truncated": false,
  "reason": null
}

`text/plain`

string

Vollständiges Schema als JSON

{
  "type": "string"
}

Beispiel

"data: {\"type\":\"content\",\"content\":\"Herzlich willkommen.\"}\n\ndata: {\"type\":\"end\"}\n\n{\"success\":false,\"streaming\":true,\"truncated\":false,\"reason\":null,\"content\":\"Herzlich willkommen.\"}"

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

409application/json

The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.

`application/json`

object

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

Vollständiges Schema als JSON

{
  "type": "object",
  "additionalProperties": true
}

Beispiel

{
  "error": "ED40901",
  "error_code": "mutation_revision_conflict"
}

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

503application/json

The account mutation lock or revision store is unavailable. No unprotected fallback is executed.

Response Header

`application/json`

object

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

Vollständiges Schema als JSON

{
  "type": "object",
  "additionalProperties": true
}

Beispiel

{
  "error": "ED50301",
  "error_code": "mutation_revision_busy"
}

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Ai.php:25postAi()

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

true

x-edoobox-documentationReview

{
  "file": "docs/openapi/operation-contracts/09-messages-ai.json",
  "notes": []
}

x-edoobox-source

{
  "file": "application/models/v2/Ai.php",
  "method": "postAi",
  "line": 25,
  "branch": {
    "file": "application/models/v2/Ai.php",
    "line": 46
  }
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

false

x-edoobox-safeForAutomation

false

x-edoobox-permission

{
  "resource": "ai",
  "short": "ai",
  "checkedByDispatcher": true,
  "levels": [
    2,
    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": "post_v2_ai",
  "summary": "Text mit KI-Vorlage erzeugen, optimieren oder übersetzen",
  "description": "Verarbeitet den Inhalt mit einer serverseitigen KI-Textvorlage. template_key und prompt sind Pflicht; prompt enthält content, title, description und/oder requirements. options.streaming=false fordert eine abschließende JSON-Antwort mit content, truncated und reason an. Standardmäßig schreibt der Legacy-Pfad data:-gerahmte Streamereignisse und protokolliert Provider-Nutzung; er speichert den erzeugten Text nicht als Angebot oder Vorlage. Der Inhalt wird vor dem Provideraufruf gefiltert. Dieser Legacy-Endpunkt ersetzt nicht den Vorschlag-/Freigabeablauf von aiassistant. Der Streaming-Zweig setzt zunächst Content-Type text/plain; charset=utf-8 und schreibt jeweils data: gefolgt von einem JSON-Ereignis und zwei Zeilenumbrüchen. Danach kehrt die Methode in den zentralen API_OUTPUT/respondOK-Pfad zurück, der einen abschließenden JSON-Umschlag schreibt und application/json zu setzen versucht. Bereits gesendete Header/Bytes können dadurch nicht zurückgenommen werden: die Gesamtantwort kann aus Frames und angehängtem JSON bestehen und darf nicht als durchgehend gültiges JSON geparst werden. Server-/Proxy-Pufferung beeinflusst die sichtbaren Header und Chunk-Grenzen; Optionen und erzeugte Abbruchereignisse bestimmen den Inhalt. content-Ereignisse liefern einzelne Textstücke; final wird bei Timeout oder max_tokens mit truncated=true, reason und dem bis dahin gesammelten content geschrieben; end beendet den Ereignisteil. Der zurückgegebene erfolgreiche Streaming-Array enthält streaming=true und content, setzt selbst aber kein error=false. Der zentrale success-Wert kann deshalb false sein, obwohl der Ereignisteil erzeugt wurde; immer den dokumentierten Modus und dessen Felder auswerten.",
  "tags": [
    "ai"
  ],
  "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"
        ]
      }
    },
    {
      "name": "X-Edoobox-If-Revision",
      "in": "header",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^[a-f0-9]{32}$",
        "examples": [
          "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        ]
      },
      "description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review."
    }
  ],
  "responses": {
    "200": {
      "description": "Bei streaming=false oberste JSON-Felder content/truncated/reason; Legacy-Streaming schreibt data:-Frames und kann danach eine API-JSON-Antwort anhängen.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "content": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "truncated": {
                "type": "boolean"
              },
              "reason": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "error_message": {
                "type": "string"
              },
              "streaming": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          },
          "example": {
            "success": true,
            "error": false,
            "content": "Herzlich willkommen zu unserem Kurs.",
            "truncated": false,
            "reason": null
          }
        },
        "text/plain": {
          "schema": {
            "type": "string"
          },
          "example": "data: {\"type\":\"content\",\"content\":\"Herzlich willkommen.\"}\n\ndata: {\"type\":\"end\"}\n\n{\"success\":false,\"streaming\":true,\"truncated\":false,\"reason\":null,\"content\":\"Herzlich willkommen.\"}",
          "description": "Legacy-Stream mit data:-JSON-Frames (content, optional final, end), gefolgt vom zentralen JSON-Abschluss. Der tatsächlich bereits gesendete Content-Type kann text/plain bleiben."
        }
      },
      "headers": {
        "X-Edoobox-Revision": {
          "schema": {
            "type": "string",
            "pattern": "^[a-f0-9]{32}$"
          },
          "description": "Rotated account revision supplied for the next action in one reviewed sequence."
        }
      }
    },
    "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"
          }
        }
      }
    },
    "409": {
      "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED40901",
            "error_code": "mutation_revision_conflict"
          }
        }
      }
    },
    "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"
          }
        }
      }
    },
    "503": {
      "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "const": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED50301",
            "error_code": "mutation_revision_busy"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": true,
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "template_key": {
                  "enum": [
                    "event_description_create",
                    "text_optimize",
                    "event_description_bootstrap",
                    "email_template_optimize",
                    "pdf_template_optimize",
                    "modern_event_description",
                    "translate"
                  ]
                },
                "prompt": {
                  "type": "object",
                  "properties": {
                    "content": {
                      "type": "string"
                    },
                    "title": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    },
                    "requirements": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": true
                },
                "options": {
                  "type": "object",
                  "properties": {
                    "streaming": {
                      "type": "boolean"
                    },
                    "use_cache": {
                      "type": "boolean"
                    },
                    "response_profile": {
                      "type": "string",
                      "description": "speed, balanced oder quality; unbekannte Werte fallen auf das Standardprofil zurück."
                    },
                    "output_size": {
                      "type": "string",
                      "description": "short, medium oder long; unbekannte Werte werden normalisiert."
                    },
                    "target_language": {
                      "type": "string"
                    },
                    "custom_instructions": {
                      "type": "string"
                    },
                    "model": {
                      "type": "string"
                    },
                    "max_tokens": {
                      "type": [
                        "integer",
                        "string"
                      ]
                    },
                    "retry_max_tokens": {
                      "type": [
                        "integer",
                        "string"
                      ]
                    },
                    "temperature": {
                      "type": [
                        "number",
                        "string"
                      ]
                    },
                    "resource_id": {
                      "type": "string",
                      "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                    }
                  },
                  "additionalProperties": true
                }
              },
              "additionalProperties": true,
              "required": [
                "template_key",
                "prompt"
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "data"
          ]
        },
        "examples": {
          "request": {
            "summary": "Text mit KI-Vorlage erzeugen, optimieren oder übersetzen",
            "value": {
              "data": {
                "template_key": "text_optimize",
                "prompt": {
                  "content": "Willkommen zu unserem Kurs."
                },
                "options": {
                  "streaming": false,
                  "output_size": "short"
                }
              }
            }
          }
        }
      }
    }
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/09-messages-ai.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Ai.php",
    "method": "postAi",
    "line": 25,
    "branch": {
      "file": "application/models/v2/Ai.php",
      "line": 46
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "ai",
    "short": "ai",
    "checkedByDispatcher": true,
    "levels": [
      2,
      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": {
    "template_key": "text_optimize",
    "prompt": {
      "content": "Willkommen zu unserem Kurs."
    },
    "options": {
      "streaming": false,
      "output_size": "short"
    }
  }
}
EDOOBOX_JSON_EXAMPLE
curl --request 'POST' \
  --url "${API_ORIGIN%/}"'/v2/ai' \
  --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/ai";
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": {
    "template_key": "text_optimize",
    "prompt": {
      "content": "Willkommen zu unserem Kurs."
    },
    "options": {
      "streaming": false,
      "output_size": "short"
    }
  }
});
const response = await fetch(url, { method: "POST", 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/ai"
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\":{\"template_key\":\"text_optimize\",\"prompt\":{\"content\":\"Willkommen zu unserem Kurs.\"},\"options\":{\"streaming\":false,\"output_size\":\"short\"}}}".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="POST", 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/ai";
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": {
    "template_key": "text_optimize",
    "prompt": {
      "content": "Willkommen zu unserem Kurs."
    },
    "options": {
      "streaming": false,
      "output_size": "short"
    }
  }
});
const response = await fetch(url, { method: "POST", 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/ai"
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\":{\"template_key\":\"text_optimize\",\"prompt\":{\"content\":\"Willkommen zu unserem Kurs.\"},\"options\":{\"streaming\":false,\"output_size\":\"short\"}}}".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="POST", 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.