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

KI-Artefakt prüfen oder geschützt herunterladen

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. Ohne download=1 werden nur Metadaten geliefert. Mit download=1 werden Datei-Bytes mit private,no-store und Download-Headern gestreamt; Rechte werden vor und während gewöhnlicher Downloads erneut geprüft. Nur Artefakte nicht abgebrochener, erfolgreicher oder awaiting_approval-Läufe sind lesbar. Sensible Artefakte sind verschlüsselte einmalige Benutzerdownloads: der Download verbraucht das Artefakt dauerhaft und darf niemals von einem Modell oder automatisch abgerufen werden. X-Edoobox-MCP-Consumer:model wird bei sensiblen Downloads explizit abgelehnt. Ein fehlgeschlagener oder abgebrochener sensibler Download ist nicht automatisch wiederholbar.

Operation-ID get_v2_aiassistant_artifacts_artifactId

01

Vertrag & Verhalten

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

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

GET-Verhalten laut Spezifikation

business-mutation

02

Authentifizierung

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

Alternative 1

bearerAuthhttp · bearer

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

Format: JWT

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

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

header: edid

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

Alternative 2

sessionCookieapiKey

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

cookie: _edlogin

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

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

header: edid

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

Berechtigungen

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

03

Parameter

Pfadparameter

artifactIderforderlich

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

string

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

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

Query-Parameter

downloadoptional

Nur exakt 1 startet den Download; sonst Metadaten. Sensible Einmaldateien ausschließlich durch expliziten Benutzerdownload.

string

Standardwert: "0"

Erlaubte Werte
"0""1"
Vollständiges Schema als JSON
{
  "type": "string",
  "enum": [
    "0",
    "1"
  ],
  "default": "0"
}

Header

languageoptional

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

string
Schema-Beispiel
"de"
Vollständiges Schema als JSON
{
  "type": "string",
  "examples": [
    "de"
  ]
}
X-Edoobox-MCP-Consumeroptional

Kennzeichnet Modellzugriff; sensible Downloads sind dafür verboten.

string
Erlaubte Werte
"model"
Vollständiges Schema als JSON
{
  "type": "string",
  "enum": [
    "model"
  ]
}
04

Request Body

Kein Request Body in der Spezifikation beschrieben.

05

Antworten

9

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

200application/json · application/octet-stream · text/csv

Metadaten oder bei download=1 direkte Datei-Bytes; sensible Dateien können nur einmal vom Benutzer heruntergeladen werden.

Response Header

Cache-Control

string

Fester Wert: "private, no-store"

Vollständiges Schema als JSON
{
  "type": "string",
  "const": "private, no-store"
}

Content-Disposition

attachment mit URL-kodiertem Dateinamen beim Download.

string
Vollständiges Schema als JSON
{
  "type": "string"
}

Content-Length

integer
Vollständiges Schema als JSON
{
  "type": "integer"
}

X-Edoobox-Sensitive-Artifact

Nur bei sensiblen Einmal-Downloads.

string

Fester Wert: "one-time"

Vollständiges Schema als JSON
{
  "type": "string",
  "const": "one-time"
}

application/json

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

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

pattern
"^aiassistantartifact_[a-f0-9]{12}_-?[0-9]+$"
name string erforderlich
mime_type string erforderlich
size integer erforderlich
sensitive boolean
one_time boolean

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

error_code 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"
      ]
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "pattern": "^aiassistantartifact_[a-f0-9]{12}_-?[0-9]+$",
          "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
        },
        "name": {
          "type": "string"
        },
        "mime_type": {
          "type": "string"
        },
        "size": {
          "type": "integer"
        },
        "sensitive": {
          "type": "boolean"
        },
        "one_time": {
          "type": "boolean"
        }
      },
      "additionalProperties": true,
      "required": [
        "id",
        "name",
        "mime_type",
        "size"
      ]
    },
    "error_code": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
Beispiel
{
  "success": true,
  "error": false,
  "data": {
    "id": "aiassistantartifact_012345abcdef_123456",
    "name": "Auswertung.csv",
    "mime_type": "text/csv",
    "size": 1200
  }
}

application/octet-stream

string
format
"binary"
Vollständiges Schema als JSON
{
  "type": "string",
  "format": "binary"
}

text/csv

string
Vollständiges Schema als JSON
{
  "type": "string"
}
400application/json

Invalid request.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED40006"
}
401application/json

Missing/expired token, missing account context, account paused or model-specific authorization failure.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED40103"
}
402application/json

Missing/invalid action data or subscription/operation restriction.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED80100"
}
403application/json

Permission denied. Browser CORS rejection may have an empty body.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED40340"
}
404application/json

Unknown resource/action or unsupported method.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED80019"
}
422application/json

Validation failed.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED80020"
}
429application/json

Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.

Response Header

Retry-After

Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.

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

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED42902"
}
502application/json

Server-side operation failed.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED50201"
}
06

Quelle & Metadaten

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

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

x-edoobox-mutates-state
true
x-edoobox-server-authorization
true
x-edoobox-server-authorization-source
{
  "file": "application/models/v2/Aiassistant.php",
  "line": 26,
  "reason": "Dedicated administrator/account identity, ownership, plugin and action-specific settings/billing checks. No legacy permission.short exists; maintenance side effects remain conservatively classified and must not acquire fictitious legacy write permission."
}
x-edoobox-runtimeMutationGuard
false
x-edoobox-get-effect
"business-mutation"
x-edoobox-documentationReview
{
  "file": "docs/openapi/operation-contracts/09-messages-ai.json",
  "notes": []
}
x-edoobox-sensitive-download
"Einmaliger Benutzerdownload; niemals als Modellinhalt abrufen, in Modelltext einfügen oder automatisch konsumieren."
x-edoobox-source
{
  "file": "application/models/v2/Aiassistant.php",
  "method": "getAiassistant",
  "line": 10
}
x-edoobox-documentationStatus
"reviewed"
x-edoobox-readOnly
false
x-edoobox-safeForAutomation
false
x-edoobox-permission
{
  "resource": "aiassistant",
  "short": null,
  "checkedByDispatcher": false,
  "levels": [
    1,
    3,
    4
  ],
  "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
}
Vollständige Operation als JSON
{
  "operationId": "get_v2_aiassistant_artifacts_artifactId",
  "summary": "KI-Artefakt prüfen oder geschützt herunterladen",
  "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. Ohne download=1 werden nur Metadaten geliefert. Mit download=1 werden Datei-Bytes mit private,no-store und Download-Headern gestreamt; Rechte werden vor und während gewöhnlicher Downloads erneut geprüft. Nur Artefakte nicht abgebrochener, erfolgreicher oder awaiting_approval-Läufe sind lesbar. Sensible Artefakte sind verschlüsselte einmalige Benutzerdownloads: der Download verbraucht das Artefakt dauerhaft und darf niemals von einem Modell oder automatisch abgerufen werden. X-Edoobox-MCP-Consumer:model wird bei sensiblen Downloads explizit abgelehnt. Ein fehlgeschlagener oder abgebrochener sensibler Download ist nicht automatisch wiederholbar.",
  "tags": [
    "aiassistant"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "artifactId",
      "in": "path",
      "required": true,
      "description": "Öffentliche, an Konto und Administrator gebundene aiassistantartifact-ID.",
      "schema": {
        "type": "string",
        "pattern": "^aiassistantartifact_[a-f0-9]{12}_-?[0-9]+$",
        "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
      }
    },
    {
      "name": "download",
      "in": "query",
      "required": false,
      "description": "Nur exakt 1 startet den Download; sonst Metadaten. Sensible Einmaldateien ausschließlich durch expliziten Benutzerdownload.",
      "schema": {
        "type": "string",
        "enum": [
          "0",
          "1"
        ],
        "default": "0"
      }
    },
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    },
    {
      "name": "X-Edoobox-MCP-Consumer",
      "in": "header",
      "required": false,
      "schema": {
        "type": "string",
        "enum": [
          "model"
        ]
      },
      "description": "Kennzeichnet Modellzugriff; sensible Downloads sind dafür verboten."
    }
  ],
  "responses": {
    "200": {
      "description": "Metadaten oder bei download=1 direkte Datei-Bytes; sensible Dateien können nur einmal vom Benutzer heruntergeladen werden.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "data": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^aiassistantartifact_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                  },
                  "name": {
                    "type": "string"
                  },
                  "mime_type": {
                    "type": "string"
                  },
                  "size": {
                    "type": "integer"
                  },
                  "sensitive": {
                    "type": "boolean"
                  },
                  "one_time": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": true,
                "required": [
                  "id",
                  "name",
                  "mime_type",
                  "size"
                ]
              },
              "error_code": {
                "type": "string"
              }
            },
            "additionalProperties": true
          },
          "example": {
            "success": true,
            "error": false,
            "data": {
              "id": "aiassistantartifact_012345abcdef_123456",
              "name": "Auswertung.csv",
              "mime_type": "text/csv",
              "size": 1200
            }
          }
        },
        "application/octet-stream": {
          "schema": {
            "type": "string",
            "format": "binary"
          },
          "description": "download=1: tatsächlicher Content-Type entspricht mime_type; keine JSON-Verpackung."
        },
        "text/csv": {
          "schema": {
            "type": "string"
          }
        }
      },
      "headers": {
        "Cache-Control": {
          "schema": {
            "type": "string",
            "const": "private, no-store"
          }
        },
        "Content-Disposition": {
          "schema": {
            "type": "string"
          },
          "description": "attachment mit URL-kodiertem Dateinamen beim Download."
        },
        "Content-Length": {
          "schema": {
            "type": "integer"
          }
        },
        "X-Edoobox-Sensitive-Artifact": {
          "schema": {
            "type": "string",
            "const": "one-time"
          },
          "description": "Nur bei sensiblen Einmal-Downloads."
        }
      }
    },
    "400": {
      "description": "Invalid request.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40006"
          }
        }
      }
    },
    "401": {
      "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40103"
          }
        }
      }
    },
    "402": {
      "description": "Missing/invalid action data or subscription/operation restriction.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80100"
          }
        }
      }
    },
    "403": {
      "description": "Permission denied. Browser CORS rejection may have an empty body.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40340"
          }
        }
      }
    },
    "404": {
      "description": "Unknown resource/action or unsupported method.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80019"
          }
        }
      }
    },
    "422": {
      "description": "Validation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80020"
          }
        }
      }
    },
    "429": {
      "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED42902"
          }
        }
      },
      "headers": {
        "Retry-After": {
          "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
          "schema": {
            "type": "string",
            "examples": [
              "30"
            ]
          }
        }
      }
    },
    "502": {
      "description": "Server-side operation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED50201"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": true,
  "x-edoobox-server-authorization": true,
  "x-edoobox-server-authorization-source": {
    "file": "application/models/v2/Aiassistant.php",
    "line": 26,
    "reason": "Dedicated administrator/account identity, ownership, plugin and action-specific settings/billing checks. No legacy permission.short exists; maintenance side effects remain conservatively classified and must not acquire fictitious legacy write permission."
  },
  "x-edoobox-runtimeMutationGuard": false,
  "x-edoobox-get-effect": "business-mutation",
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/09-messages-ai.json",
    "notes": []
  },
  "x-edoobox-sensitive-download": "Einmaliger Benutzerdownload; niemals als Modellinhalt abrufen, in Modelltext einfügen oder automatisch konsumieren.",
  "x-edoobox-source": {
    "file": "application/models/v2/Aiassistant.php",
    "method": "getAiassistant",
    "line": 10
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "aiassistant",
    "short": null,
    "checkedByDispatcher": false,
    "levels": [
      1,
      3,
      4
    ],
    "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
  }
}