Dokumentmetadaten abrufen

Rufen Sie die Metadatenwerte mehrerer Dokumente anhand ihrer IDs ab. Die Antwort enthält auto_metadata (vom System automatisch ausgefüllt und schreibgeschützt) sowie metadata (benutzerdefinierte Feldwerte). Pro Anfrage können bis zu 50 Dokumente abgerufen werden.

Anfragemethode

GET

Endpunkt

https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/detail

Authentifizierung

Informationen zur Authentifizierung finden Sie in der API-Übersicht.

Anfrage

Anfragebeispiel

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/detail?doc_ids=doc_001,doc_002' \ -H 'Authorization: Bearer ${API Key}'

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/detail?doc_ids=doc_001,doc_002' \
-H 'Authorization: Bearer ${API Key}'

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Bearer ${API Key}	Authentifizieren Sie sich mit `Authorization: Bearer ${API Key}`. Den API Key erhalten Sie auf der API-Schlüsselseite.

Anfrageparameter

Feld	Typ	Erforderlich	Beschreibung
doc_ids	String	Ja	Durch Kommas getrennte Dokument-IDs, bis zu 50 pro Anfrage. Jedes Dokument muss zum Agent gehören, der dem aktuellen API Key zugeordnet ist. Wenn ein Dokument nicht existiert oder nicht zum aktuellen Agent gehört, schlägt die gesamte Anfrage mit `one or more doc_ids do not exist or do not belong to the current bot` fehl.

Antwort

Antwortbeispiel

{ "documents": [ { "doc_id": "doc_001", "auto_metadata": { "document_name": "API-Spezifikation.pdf", "upload_time": "2026-01-15T10:30:00Z" }, "metadata": { "category": "Technik", "priority": "P1" } } ] }

                      
                      {
    "documents": [
        {
            "doc_id": "doc_001",
            "auto_metadata": {
                "document_name": "API-Spezifikation.pdf",
                "upload_time": "2026-01-15T10:30:00Z"
            },
            "metadata": {
                "category": "Technik",
                "priority": "P1"
            }
        }
    ]
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
documents	Array<Object>	Metadaten jedes Dokuments; Dokumente ohne Metadatensätze werden nicht zurückgegeben.
doc_id	String	Dokument-ID.
auto_metadata	Object	Vom System automatisch ausgefüllte Metadaten (Dokumentname/Upload-Zeitpunkt/Uploader/Quelle usw.), schreibgeschützt.
metadata	Object	Benutzerdefinierter Metadatenwert, das Format ist „Feldname → Wert“.

Fehlerantwort

Feld	Typ	Beschreibung
code	Integer	Fehlercode.
message	String	Fehlerdetails.