GET/v2/aiassistant/runs/{runId}

KI-Laufstatus und geprüften Änderungsvorschlag lesen

Erfordert einen authentifizierten Administrator im ausgewählten Konto. Gespräche, Läufe und Artefakte sind zusätzlich an diesen Administrator gebunden; Quellenberechtigungen und Ablaufzeit werden erneut geprüft. Liest Status, öffentliche Lauf-/Gesprächs-ID, Verbrauch, sichere Fortschrittscodes und gegebenenfalls einen konkreten Vorschlag samt Hash. Der interne Status approved wird öffentlich als queued ausgegeben. Nach Freigabe kann execution Einzelergebnisse, partial und uncertain enthalten; ein erfolgreich empfangener HTTP-Request beweist keine vollständige Mutation. Quellenberechtigungen werden erneut geprüft.

Operation-ID get_v2_aiassistant_runs_runId

Vertrag & Verhalten

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

GET-Verhalten laut Spezifikation

read

Authentifizierung

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

Alternative 1

bearerAuthhttp · bearer

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

Format: JWT

Security-Schema als JSON

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

accountContextapiKey

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

header: edid

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Alternative 2

sessionCookieapiKey

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

cookie: _edlogin

Security-Schema als JSON

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

accountContextapiKey

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

header: edid

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Berechtigungen

Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope.

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

Parameter

Pfadparameter

runIderforderlich

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

string

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

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

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^aiassistantrun_[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"
  ]
}

Request Body

Kein Request Body in der Spezifikation beschrieben.

Antworten

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

200application/json

Laufobjekt; proposal ist null oder der zur expliziten Prüfung anstehende Vorschlag mit Hash.

`application/json`

object

success boolean

error boolean | string

error_code string

data object

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.

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.

type string

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

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "boolean",
        "string"
      ]
    },
    "error_code": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "pattern": "^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"
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": {
    "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"
}

Quelle & Metadaten

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

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

x-edoobox-mutates-state

false

x-edoobox-server-authorization

true

x-edoobox-server-authorization-source

{
  "file": "application/models/v2/Aiassistant.php",
  "line": 26,
  "reason": "Dedicated administrator/account identity, ownership, plugin and action-specific settings/billing checks. No legacy permission.short exists; maintenance side effects remain conservatively classified and must not acquire fictitious legacy write permission."
}

x-edoobox-runtimeMutationGuard

false

x-edoobox-get-effect

"read"

x-edoobox-documentationReview

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

x-edoobox-source

{
  "file": "application/models/v2/Aiassistant.php",
  "method": "getAiassistant",
  "line": 10
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

true

x-edoobox-safeForAutomation

false

x-edoobox-permission

{
  "resource": "aiassistant",
  "short": null,
  "checkedByDispatcher": false,
  "levels": [
    1,
    3,
    4
  ],
  "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
}

Vollständige Operation als JSON

{
  "operationId": "get_v2_aiassistant_runs_runId",
  "summary": "KI-Laufstatus und geprüften Änderungsvorschlag lesen",
  "description": "Erfordert einen authentifizierten Administrator im ausgewählten Konto. Gespräche, Läufe und Artefakte sind zusätzlich an diesen Administrator gebunden; Quellenberechtigungen und Ablaufzeit werden erneut geprüft. Liest Status, öffentliche Lauf-/Gesprächs-ID, Verbrauch, sichere Fortschrittscodes und gegebenenfalls einen konkreten Vorschlag samt Hash. Der interne Status approved wird öffentlich als queued ausgegeben. Nach Freigabe kann execution Einzelergebnisse, partial und uncertain enthalten; ein erfolgreich empfangener HTTP-Request beweist keine vollständige Mutation. Quellenberechtigungen werden erneut geprüft.",
  "tags": [
    "aiassistant"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "runId",
      "in": "path",
      "required": true,
      "description": "Öffentliche, an Konto und Administrator gebundene aiassistantrun-ID.",
      "schema": {
        "type": "string",
        "pattern": "^aiassistantrun_[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": "Laufobjekt; proposal ist null oder der zur expliziten Prüfung anstehende Vorschlag mit Hash.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "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": {
                  "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"
                ]
              },
              "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": false,
  "x-edoobox-server-authorization": true,
  "x-edoobox-server-authorization-source": {
    "file": "application/models/v2/Aiassistant.php",
    "line": 26,
    "reason": "Dedicated administrator/account identity, ownership, plugin and action-specific settings/billing checks. No legacy permission.short exists; maintenance side effects remain conservatively classified and must not acquire fictitious legacy write permission."
  },
  "x-edoobox-runtimeMutationGuard": false,
  "x-edoobox-get-effect": "read",
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/09-messages-ai.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Aiassistant.php",
    "method": "getAiassistant",
    "line": 10
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": true,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "aiassistant",
    "short": null,
    "checkedByDispatcher": false,
    "levels": [
      1,
      3,
      4
    ],
    "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
  }
}

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.
# cURL: PATH_* bereits URL-kodiert setzen. JavaScript/Python kodieren die unveränderten Pfadwerte selbst.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
: "${PATH_RUNID:?PATH_RUNID setzen}"
curl --request 'GET' \
  --url "${API_ORIGIN%/}"'/v2/aiassistant/runs/'"${PATH_RUNID}"'' \
  --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \
  --header 'edid: '"${AUTH_ACCOUNTCONTEXT}"

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/aiassistant/runs/{runId}";
path = path.replaceAll("{runId}", encodeURIComponent(required("PATH_RUNID")));
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");
const response = await fetch(url, { method: "GET", headers, 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.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/aiassistant/runs/{runId}"
path = path.replace("{runId}", urllib.parse.quote(os.environ["PATH_RUNID"], safe=""))
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]

# 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="GET")
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.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/aiassistant/runs/{runId}";
path = path.replaceAll("{runId}", encodeURIComponent(required("PATH_RUNID")));
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");
const response = await fetch(url, { method: "GET", headers, 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.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/aiassistant/runs/{runId}"
path = path.replace("{runId}", urllib.parse.quote(os.environ["PATH_RUNID"], safe=""))
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]

# 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="GET")
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.