Zum Inhalt
edoobox Docs
Kostenlos testen 7 Tage unverbindlich testen
Menü
Kostenlos testen 7 Tage unverbindlich testen
OpenAPI herunterladen
aiassistantAPI-Referenz
POST/v2/aiassistant/conversations/{conversationId}/messages

KI-Nachricht senden und Entwurf zur Prüfung anfordern

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. Speichert die Benutzernachricht, reserviert das Tokenbudget und stellt einen asynchronen Entwurfslauf in die Queue. content muss nach Trimmen nicht leer und höchstens 60000 Bytes sein; request_id ist Pflicht. Gleiche ID mit abweichendem Gespräch/Inhalt/Kontext ergibt idempotency_conflict. Es darf nur ein aktiver Lauf je Gespräch existieren. Kontext und Anhänge gewähren keine zusätzlichen Rechte. Änderungen an edoobox werden zuerst als exakter Vorschlag bereitgestellt und erst nach ausdrücklicher Freigabe per approve ausgeführt. Anhänge: höchstens vier, einzeln 2000000 Bytes, zusammen 5 MiB; identische Bytes doppelt sind unzulässig. Nicht erneut mitgesendete Anhänge eines zuvor erfolgreichen Laufs können übernommen werden.

Operation-ID post_v2_aiassistant_conversations_conversationId_messages

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

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

Pfadparameter

conversationIderforderlich

Öffentliche, an Konto und Administrator gebundene aiassistantconversation-ID.

string

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

pattern
"^aiassistantconversation_[a-f0-9]{12}_-?[0-9]+$"
Vollständiges Schema als JSON
{
  "type": "string",
  "pattern": "^aiassistantconversation_[a-f0-9]{12}_-?[0-9]+$",
  "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
}

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
content string | number | boolean | null erforderlich

Nach String-Konvertierung/Trimming nicht leer; höchstens 60000 Bytes.

request_id string | number erforderlich

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}$"
context object

Höchstens 200000 JSON-Bytes. Nur route, entities und editor werden übernommen und sicherheitsgefiltert; unbekannte Kontextfelder werden verworfen.

route object
name string
maxLength
1000
path string
maxLength
1000
filters array
maxItems
4
Array-Elemente
object
surface Typ nicht eingeschränkt erforderlich
Erlaubte Werte
"offers""users""bookings""waitlist"
values object erforderlich

Bekannte boolesche Filter; status als Integer oder eindeutige Integerliste (0–999, höchstens 10), category nur für offers als öffentliche category_-ID, date_start/date_end als gültiges ISO-Datum/-Zeit.

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

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

selection object

Jede ausgewählte ID muss zusätzlich in entities enthalten sein; total_selected mindestens Anzahl ids.

ids array erforderlich
maxItems
20
uniqueItems
true
Array-Elemente
string

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

pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
total_selected integer erforderlich
maximum
100000

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

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

entities array
Array-Elemente
object
id string erforderlich

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

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

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

editor object

Optionaler unveröffentlichter Editor-Arbeitsstand. Bei language=css sind content (höchstens 20000 Bytes) und kontoeigene widget_-resource_id Pflicht; content_sha256 wird validiert/ergänzt. Kontext verleiht keine Speicher- oder Quellenberechtigung.

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

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

attachments array
maxItems
4
Array-Elemente
object
filename string erforderlich

Dateiname nur aus Unicode-Buchstaben/-Ziffern, _, Punkt, Leerzeichen und Bindestrich; weder . noch .. allein.

minLength
1
maxLength
160
mimeType string erforderlich
pattern
"^[A-Za-z0-9.+-]+/[A-Za-z0-9.+-]+$"
maxLength
120
dataBase64 string erforderlich

Kanonisches, nicht leeres Base64; decodiert höchstens 2000000 Bytes je Datei.

contentEncoding
"base64"

Zusätzliche Felder sind in diesem Teilschema ausgeschlossen.

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": {
        "content": {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ],
          "description": "Nach String-Konvertierung/Trimming nicht leer; höchstens 60000 Bytes."
        },
        "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."
        },
        "context": {
          "type": "object",
          "properties": {
            "route": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "maxLength": 1000
                },
                "path": {
                  "type": "string",
                  "maxLength": 1000
                },
                "filters": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "surface": {
                        "enum": [
                          "offers",
                          "users",
                          "bookings",
                          "waitlist"
                        ]
                      },
                      "values": {
                        "type": "object",
                        "properties": {},
                        "additionalProperties": true,
                        "description": "Bekannte boolesche Filter; status als Integer oder eindeutige Integerliste (0–999, höchstens 10), category nur für offers als öffentliche category_-ID, date_start/date_end als gültiges ISO-Datum/-Zeit."
                      }
                    },
                    "additionalProperties": true,
                    "required": [
                      "surface",
                      "values"
                    ]
                  },
                  "maxItems": 4
                },
                "selection": {
                  "type": "object",
                  "properties": {
                    "ids": {
                      "type": "array",
                      "items": {
                        "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."
                      },
                      "maxItems": 20,
                      "uniqueItems": true
                    },
                    "total_selected": {
                      "type": "integer",
                      "maximum": 100000
                    }
                  },
                  "additionalProperties": true,
                  "required": [
                    "ids",
                    "total_selected"
                  ],
                  "description": "Jede ausgewählte ID muss zusätzlich in entities enthalten sein; total_selected mindestens Anzahl ids."
                }
              },
              "additionalProperties": true
            },
            "entities": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "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."
                  },
                  "name": {
                    "type": "string"
                  },
                  "type": {
                    "type": "string"
                  }
                },
                "additionalProperties": true,
                "required": [
                  "id"
                ]
              }
            },
            "editor": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "Optionaler unveröffentlichter Editor-Arbeitsstand. Bei language=css sind content (höchstens 20000 Bytes) und kontoeigene widget_-resource_id Pflicht; content_sha256 wird validiert/ergänzt. Kontext verleiht keine Speicher- oder Quellenberechtigung."
            }
          },
          "additionalProperties": true,
          "description": "Höchstens 200000 JSON-Bytes. Nur route, entities und editor werden übernommen und sicherheitsgefiltert; unbekannte Kontextfelder werden verworfen."
        },
        "attachments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "filename": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160,
                "description": " Dateiname nur aus Unicode-Buchstaben/-Ziffern, _, Punkt, Leerzeichen und Bindestrich; weder . noch .. allein."
              },
              "mimeType": {
                "type": "string",
                "maxLength": 120,
                "pattern": "^[A-Za-z0-9.+-]+/[A-Za-z0-9.+-]+$"
              },
              "dataBase64": {
                "type": "string",
                "contentEncoding": "base64",
                "description": "Kanonisches, nicht leeres Base64; decodiert höchstens 2000000 Bytes je Datei."
              }
            },
            "additionalProperties": false,
            "required": [
              "filename",
              "mimeType",
              "dataBase64"
            ]
          },
          "maxItems": 4
        }
      },
      "additionalProperties": true,
      "required": [
        "content",
        "request_id"
      ]
    }
  },
  "additionalProperties": true,
  "required": [
    "data"
  ]
}
KI-Nachricht senden und Entwurf zur Prüfung anfordern
{
  "data": {
    "content": "Zeige die Kurse im November.",
    "request_id": "review-message-0001",
    "context": {
      "route": {
        "name": "offers",
        "path": "/offers"
      },
      "entities": []
    }
  }
}
05

Antworten

9

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

200application/json

Neu gespeicherte Nachricht und Lauf; bei identischer Wiederholung ist message=null und run der vorhandene Lauf.

application/json

object
success boolean
error boolean | string
error_code string
data object
message Typ nicht eingeschränkt erforderlich
anyOf · Mindestens eine Variante muss passen
Variante 1 object
id string

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

pattern
"^aiassistantmessage_[a-f0-9]{12}_-?[0-9]+$"
role string
content string
blocks array
Array-Elemente
object

Typabhängige Anzeige-, Referenz- und Anhangsblöcke.

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

created_at string
format
"date-time"
context object

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

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

Variante 2 null
run object erforderlich
id string erforderlich

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

pattern
"^aiassistantrun_[a-f0-9]{12}_-?[0-9]+$"
conversation_id string erforderlich

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

pattern
"^aiassistantconversation_[a-f0-9]{12}_-?[0-9]+$"
status string erforderlich
Erlaubte Werte
"queued""running""succeeded""awaiting_approval""failed""cancelled""authorization_required"
phase string erforderlich
proposal Typ nicht eingeschränkt erforderlich
anyOf · Mindestens eine Variante muss passen
Variante 1 object
summary string erforderlich
hash string erforderlich
pattern
"^[a-f0-9]{64}$"
actions array erforderlich
maxItems
20
Array-Elemente
object
tool Typ nicht eingeschränkt erforderlich
Erlaubte Werte
"editor.replace""edoobox_execute""edoobox_upload_transfer"
arguments object erforderlich

Exakte serverseitig normalisierte, aktionsabhängige Argumente. Keine vom Client erfundenen Freigabe- oder Zugangsdaten.

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

description string erforderlich

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

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

Variante 2 null
approved_at string | null
format
"date-time"
error_code string | null
simulation boolean
usage object erforderlich
input_tokens integer
output_tokens integer

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

usage_status string
unresolved_reserved_tokens integer
estimated_usage object | null
created_at string erforderlich
format
"date-time"
updated_at string erforderlich
format
"date-time"
retry_after_seconds integer
activity array
Array-Elemente
object
code string
sequence integer
at integer

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

editor_context object
language Typ nicht eingeschränkt

Fester Wert: "css"

resource_id string

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

pattern
"^widget_[a-f0-9]{12}_-?[0-9]+$"
content_sha256 string
pattern
"^[a-f0-9]{64}$"

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

execution object
total_actions integer
completed_actions integer
started_actions integer
partial boolean
uncertain boolean
results array
Array-Elemente
object
sequence integer
status string
entities array
Array-Elemente
object
id string

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

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

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

mutationResult object
insert boolean
update boolean
delete boolean

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

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

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

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": {
        "message": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "pattern": "^aiassistantmessage_[a-f0-9]{12}_-?[0-9]+$",
                  "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                },
                "role": {
                  "type": "string"
                },
                "content": {
                  "type": "string"
                },
                "blocks": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {},
                    "additionalProperties": true,
                    "description": "Typabhängige Anzeige-, Referenz- und Anhangsblöcke."
                  }
                },
                "created_at": {
                  "type": "string",
                  "format": "date-time"
                },
                "context": {
                  "type": "object",
                  "properties": {},
                  "additionalProperties": true
                }
              },
              "additionalProperties": true
            },
            {
              "type": "null"
            }
          ]
        },
        "run": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "pattern": "^aiassistantrun_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
            },
            "conversation_id": {
              "type": "string",
              "pattern": "^aiassistantconversation_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
            },
            "status": {
              "type": "string",
              "enum": [
                "queued",
                "running",
                "succeeded",
                "awaiting_approval",
                "failed",
                "cancelled",
                "authorization_required"
              ]
            },
            "phase": {
              "type": "string"
            },
            "proposal": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "summary": {
                      "type": "string"
                    },
                    "hash": {
                      "type": "string",
                      "pattern": "^[a-f0-9]{64}$"
                    },
                    "actions": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "tool": {
                            "enum": [
                              "editor.replace",
                              "edoobox_execute",
                              "edoobox_upload_transfer"
                            ]
                          },
                          "arguments": {
                            "type": "object",
                            "properties": {},
                            "additionalProperties": true,
                            "description": "Exakte serverseitig normalisierte, aktionsabhängige Argumente. Keine vom Client erfundenen Freigabe- oder Zugangsdaten."
                          },
                          "description": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": true,
                        "required": [
                          "tool",
                          "arguments",
                          "description"
                        ]
                      },
                      "maxItems": 20
                    }
                  },
                  "additionalProperties": true,
                  "required": [
                    "summary",
                    "actions",
                    "hash"
                  ]
                },
                {
                  "type": "null"
                }
              ]
            },
            "approved_at": {
              "type": [
                "string",
                "null"
              ],
              "format": "date-time"
            },
            "error_code": {
              "type": [
                "string",
                "null"
              ]
            },
            "simulation": {
              "type": "boolean"
            },
            "usage": {
              "type": "object",
              "properties": {
                "input_tokens": {
                  "type": "integer"
                },
                "output_tokens": {
                  "type": "integer"
                }
              },
              "additionalProperties": true
            },
            "usage_status": {
              "type": "string"
            },
            "unresolved_reserved_tokens": {
              "type": "integer"
            },
            "estimated_usage": {
              "type": [
                "object",
                "null"
              ]
            },
            "created_at": {
              "type": "string",
              "format": "date-time"
            },
            "updated_at": {
              "type": "string",
              "format": "date-time"
            },
            "retry_after_seconds": {
              "type": "integer"
            },
            "activity": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "sequence": {
                    "type": "integer"
                  },
                  "at": {
                    "type": "integer"
                  }
                },
                "additionalProperties": true
              }
            },
            "editor_context": {
              "type": "object",
              "properties": {
                "language": {
                  "const": "css"
                },
                "resource_id": {
                  "type": "string",
                  "pattern": "^widget_[a-f0-9]{12}_-?[0-9]+$",
                  "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                },
                "content_sha256": {
                  "type": "string",
                  "pattern": "^[a-f0-9]{64}$"
                }
              },
              "additionalProperties": true
            },
            "execution": {
              "type": "object",
              "properties": {
                "total_actions": {
                  "type": "integer"
                },
                "completed_actions": {
                  "type": "integer"
                },
                "started_actions": {
                  "type": "integer"
                },
                "partial": {
                  "type": "boolean"
                },
                "uncertain": {
                  "type": "boolean"
                },
                "results": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "sequence": {
                        "type": "integer"
                      },
                      "status": {
                        "type": "string"
                      },
                      "entities": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "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."
                            },
                            "type": {
                              "type": "string"
                            },
                            "name": {
                              "type": "string"
                            }
                          },
                          "additionalProperties": true
                        }
                      },
                      "mutationResult": {
                        "type": "object",
                        "properties": {
                          "insert": {
                            "type": "boolean"
                          },
                          "update": {
                            "type": "boolean"
                          },
                          "delete": {
                            "type": "boolean"
                          }
                        },
                        "additionalProperties": true
                      }
                    },
                    "additionalProperties": true
                  }
                }
              },
              "additionalProperties": true
            }
          },
          "additionalProperties": true,
          "required": [
            "id",
            "conversation_id",
            "status",
            "phase",
            "proposal",
            "usage",
            "created_at",
            "updated_at"
          ]
        }
      },
      "additionalProperties": true,
      "required": [
        "message",
        "run"
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
Beispiel
{
  "success": true,
  "error": false,
  "data": {
    "message": {
      "id": "aiassistantmessage_012345abcdef_123456",
      "role": "user",
      "content": "Zeige die Kurse im November.",
      "blocks": [],
      "created_at": "2026-10-22T10:00:00+00:00"
    },
    "run": {
      "id": "aiassistantrun_012345abcdef_123456",
      "conversation_id": "aiassistantconversation_012345abcdef_123456",
      "status": "queued",
      "phase": "draft",
      "proposal": null,
      "approved_at": null,
      "error_code": null,
      "simulation": false,
      "usage": {
        "input_tokens": 0,
        "output_tokens": 0
      },
      "usage_status": "measured",
      "unresolved_reserved_tokens": 0,
      "estimated_usage": null,
      "activity": [],
      "created_at": "2026-10-22T10:00:00+00:00",
      "updated_at": "2026-10-22T10:00:00+00:00"
    }
  }
}
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:14postAiassistant()

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": "postAiassistant",
  "line": 14
}
x-edoobox-documentationStatus
"reviewed"
x-edoobox-readOnly
false
x-edoobox-safeForAutomation
false
x-edoobox-permission
{
  "resource": "aiassistant",
  "short": null,
  "checkedByDispatcher": false,
  "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_aiassistant_conversations_conversationId_messages",
  "summary": "KI-Nachricht senden und Entwurf zur Prüfung anfordern",
  "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. Speichert die Benutzernachricht, reserviert das Tokenbudget und stellt einen asynchronen Entwurfslauf in die Queue. content muss nach Trimmen nicht leer und höchstens 60000 Bytes sein; request_id ist Pflicht. Gleiche ID mit abweichendem Gespräch/Inhalt/Kontext ergibt idempotency_conflict. Es darf nur ein aktiver Lauf je Gespräch existieren. Kontext und Anhänge gewähren keine zusätzlichen Rechte. Änderungen an edoobox werden zuerst als exakter Vorschlag bereitgestellt und erst nach ausdrücklicher Freigabe per approve ausgeführt. Anhänge: höchstens vier, einzeln 2000000 Bytes, zusammen 5 MiB; identische Bytes doppelt sind unzulässig. Nicht erneut mitgesendete Anhänge eines zuvor erfolgreichen Laufs können übernommen werden.",
  "tags": [
    "aiassistant"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "conversationId",
      "in": "path",
      "required": true,
      "description": "Öffentliche, an Konto und Administrator gebundene aiassistantconversation-ID.",
      "schema": {
        "type": "string",
        "pattern": "^aiassistantconversation_[a-f0-9]{12}_-?[0-9]+$",
        "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
      }
    },
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Neu gespeicherte Nachricht und Lauf; bei identischer Wiederholung ist message=null und run der vorhandene Lauf.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "message": {
                "id": "aiassistantmessage_012345abcdef_123456",
                "role": "user",
                "content": "Zeige die Kurse im November.",
                "blocks": [],
                "created_at": "2026-10-22T10:00:00+00:00"
              },
              "run": {
                "id": "aiassistantrun_012345abcdef_123456",
                "conversation_id": "aiassistantconversation_012345abcdef_123456",
                "status": "queued",
                "phase": "draft",
                "proposal": null,
                "approved_at": null,
                "error_code": null,
                "simulation": false,
                "usage": {
                  "input_tokens": 0,
                  "output_tokens": 0
                },
                "usage_status": "measured",
                "unresolved_reserved_tokens": 0,
                "estimated_usage": null,
                "activity": [],
                "created_at": "2026-10-22T10:00:00+00:00",
                "updated_at": "2026-10-22T10:00:00+00:00"
              }
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "message": {
                    "anyOf": [
                      {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "pattern": "^aiassistantmessage_[a-f0-9]{12}_-?[0-9]+$",
                            "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                          },
                          "role": {
                            "type": "string"
                          },
                          "content": {
                            "type": "string"
                          },
                          "blocks": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {},
                              "additionalProperties": true,
                              "description": "Typabhängige Anzeige-, Referenz- und Anhangsblöcke."
                            }
                          },
                          "created_at": {
                            "type": "string",
                            "format": "date-time"
                          },
                          "context": {
                            "type": "object",
                            "properties": {},
                            "additionalProperties": true
                          }
                        },
                        "additionalProperties": true
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "run": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "pattern": "^aiassistantrun_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                      },
                      "conversation_id": {
                        "type": "string",
                        "pattern": "^aiassistantconversation_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                      },
                      "status": {
                        "type": "string",
                        "enum": [
                          "queued",
                          "running",
                          "succeeded",
                          "awaiting_approval",
                          "failed",
                          "cancelled",
                          "authorization_required"
                        ]
                      },
                      "phase": {
                        "type": "string"
                      },
                      "proposal": {
                        "anyOf": [
                          {
                            "type": "object",
                            "properties": {
                              "summary": {
                                "type": "string"
                              },
                              "hash": {
                                "type": "string",
                                "pattern": "^[a-f0-9]{64}$"
                              },
                              "actions": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "tool": {
                                      "enum": [
                                        "editor.replace",
                                        "edoobox_execute",
                                        "edoobox_upload_transfer"
                                      ]
                                    },
                                    "arguments": {
                                      "type": "object",
                                      "properties": {},
                                      "additionalProperties": true,
                                      "description": "Exakte serverseitig normalisierte, aktionsabhängige Argumente. Keine vom Client erfundenen Freigabe- oder Zugangsdaten."
                                    },
                                    "description": {
                                      "type": "string"
                                    }
                                  },
                                  "additionalProperties": true,
                                  "required": [
                                    "tool",
                                    "arguments",
                                    "description"
                                  ]
                                },
                                "maxItems": 20
                              }
                            },
                            "additionalProperties": true,
                            "required": [
                              "summary",
                              "actions",
                              "hash"
                            ]
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "approved_at": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "format": "date-time"
                      },
                      "error_code": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "simulation": {
                        "type": "boolean"
                      },
                      "usage": {
                        "type": "object",
                        "properties": {
                          "input_tokens": {
                            "type": "integer"
                          },
                          "output_tokens": {
                            "type": "integer"
                          }
                        },
                        "additionalProperties": true
                      },
                      "usage_status": {
                        "type": "string"
                      },
                      "unresolved_reserved_tokens": {
                        "type": "integer"
                      },
                      "estimated_usage": {
                        "type": [
                          "object",
                          "null"
                        ]
                      },
                      "created_at": {
                        "type": "string",
                        "format": "date-time"
                      },
                      "updated_at": {
                        "type": "string",
                        "format": "date-time"
                      },
                      "retry_after_seconds": {
                        "type": "integer"
                      },
                      "activity": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "code": {
                              "type": "string"
                            },
                            "sequence": {
                              "type": "integer"
                            },
                            "at": {
                              "type": "integer"
                            }
                          },
                          "additionalProperties": true
                        }
                      },
                      "editor_context": {
                        "type": "object",
                        "properties": {
                          "language": {
                            "const": "css"
                          },
                          "resource_id": {
                            "type": "string",
                            "pattern": "^widget_[a-f0-9]{12}_-?[0-9]+$",
                            "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                          },
                          "content_sha256": {
                            "type": "string",
                            "pattern": "^[a-f0-9]{64}$"
                          }
                        },
                        "additionalProperties": true
                      },
                      "execution": {
                        "type": "object",
                        "properties": {
                          "total_actions": {
                            "type": "integer"
                          },
                          "completed_actions": {
                            "type": "integer"
                          },
                          "started_actions": {
                            "type": "integer"
                          },
                          "partial": {
                            "type": "boolean"
                          },
                          "uncertain": {
                            "type": "boolean"
                          },
                          "results": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "sequence": {
                                  "type": "integer"
                                },
                                "status": {
                                  "type": "string"
                                },
                                "entities": {
                                  "type": "array",
                                  "items": {
                                    "type": "object",
                                    "properties": {
                                      "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."
                                      },
                                      "type": {
                                        "type": "string"
                                      },
                                      "name": {
                                        "type": "string"
                                      }
                                    },
                                    "additionalProperties": true
                                  }
                                },
                                "mutationResult": {
                                  "type": "object",
                                  "properties": {
                                    "insert": {
                                      "type": "boolean"
                                    },
                                    "update": {
                                      "type": "boolean"
                                    },
                                    "delete": {
                                      "type": "boolean"
                                    }
                                  },
                                  "additionalProperties": true
                                }
                              },
                              "additionalProperties": true
                            }
                          }
                        },
                        "additionalProperties": true
                      }
                    },
                    "additionalProperties": true,
                    "required": [
                      "id",
                      "conversation_id",
                      "status",
                      "phase",
                      "proposal",
                      "usage",
                      "created_at",
                      "updated_at"
                    ]
                  }
                },
                "additionalProperties": true,
                "required": [
                  "message",
                  "run"
                ]
              },
              "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": {
                "content": {
                  "type": [
                    "string",
                    "number",
                    "boolean",
                    "null"
                  ],
                  "description": "Nach String-Konvertierung/Trimming nicht leer; höchstens 60000 Bytes."
                },
                "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."
                },
                "context": {
                  "type": "object",
                  "properties": {
                    "route": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string",
                          "maxLength": 1000
                        },
                        "path": {
                          "type": "string",
                          "maxLength": 1000
                        },
                        "filters": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "surface": {
                                "enum": [
                                  "offers",
                                  "users",
                                  "bookings",
                                  "waitlist"
                                ]
                              },
                              "values": {
                                "type": "object",
                                "properties": {},
                                "additionalProperties": true,
                                "description": "Bekannte boolesche Filter; status als Integer oder eindeutige Integerliste (0–999, höchstens 10), category nur für offers als öffentliche category_-ID, date_start/date_end als gültiges ISO-Datum/-Zeit."
                              }
                            },
                            "additionalProperties": true,
                            "required": [
                              "surface",
                              "values"
                            ]
                          },
                          "maxItems": 4
                        },
                        "selection": {
                          "type": "object",
                          "properties": {
                            "ids": {
                              "type": "array",
                              "items": {
                                "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."
                              },
                              "maxItems": 20,
                              "uniqueItems": true
                            },
                            "total_selected": {
                              "type": "integer",
                              "maximum": 100000
                            }
                          },
                          "additionalProperties": true,
                          "required": [
                            "ids",
                            "total_selected"
                          ],
                          "description": "Jede ausgewählte ID muss zusätzlich in entities enthalten sein; total_selected mindestens Anzahl ids."
                        }
                      },
                      "additionalProperties": true
                    },
                    "entities": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "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."
                          },
                          "name": {
                            "type": "string"
                          },
                          "type": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": true,
                        "required": [
                          "id"
                        ]
                      }
                    },
                    "editor": {
                      "type": "object",
                      "properties": {},
                      "additionalProperties": true,
                      "description": "Optionaler unveröffentlichter Editor-Arbeitsstand. Bei language=css sind content (höchstens 20000 Bytes) und kontoeigene widget_-resource_id Pflicht; content_sha256 wird validiert/ergänzt. Kontext verleiht keine Speicher- oder Quellenberechtigung."
                    }
                  },
                  "additionalProperties": true,
                  "description": "Höchstens 200000 JSON-Bytes. Nur route, entities und editor werden übernommen und sicherheitsgefiltert; unbekannte Kontextfelder werden verworfen."
                },
                "attachments": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "filename": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 160,
                        "description": " Dateiname nur aus Unicode-Buchstaben/-Ziffern, _, Punkt, Leerzeichen und Bindestrich; weder . noch .. allein."
                      },
                      "mimeType": {
                        "type": "string",
                        "maxLength": 120,
                        "pattern": "^[A-Za-z0-9.+-]+/[A-Za-z0-9.+-]+$"
                      },
                      "dataBase64": {
                        "type": "string",
                        "contentEncoding": "base64",
                        "description": "Kanonisches, nicht leeres Base64; decodiert höchstens 2000000 Bytes je Datei."
                      }
                    },
                    "additionalProperties": false,
                    "required": [
                      "filename",
                      "mimeType",
                      "dataBase64"
                    ]
                  },
                  "maxItems": 4
                }
              },
              "additionalProperties": true,
              "required": [
                "content",
                "request_id"
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "data"
          ]
        },
        "examples": {
          "request": {
            "summary": "KI-Nachricht senden und Entwurf zur Prüfung anfordern",
            "value": {
              "data": {
                "content": "Zeige die Kurse im November.",
                "request_id": "review-message-0001",
                "context": {
                  "route": {
                    "name": "offers",
                    "path": "/offers"
                  },
                  "entities": []
                }
              }
            }
          }
        }
      }
    }
  },
  "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": 14
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "aiassistant",
    "short": null,
    "checkedByDispatcher": false,
    "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."
  }
}