Récupérer les métadonnées du document

Récupérez par lots les métadonnées des documents à partir de leurs ID. La réponse contient auto_metadata (renseigné automatiquement par le système et en lecture seule) ainsi que metadata (valeurs des champs personnalisés). Une requête peut porter sur 50 documents au maximum.

Méthode de requête

GET

Endpoint

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

Authentification

Pour plus d'informations sur l'authentification, consultez l'Aperçu de l'API.

Requête

Exemple de requête

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

Ce bloc de code dans la fenêtre flottante

En-têtes de requête

Champ	Type	Description
Authorization	Bearer ${API Key}	Authentifiez-vous avec `Authorization: Bearer ${API Key}`. Obtenez l'API Key depuis la page des clés API.

Paramètres de requête

Champ	Type	Obligatoire	Description
doc_ids	String	Oui	ID de documents séparés par des virgules, jusqu'à 50 par requête. Tous les documents doivent appartenir à l'Agent associé à l'API Key actuelle. Si un document n'existe pas ou n'appartient pas à l'Agent actuel, toute la requête échoue avec `one or more doc_ids do not exist or do not belong to the current bot`.

Réponse

Exemple de réponse

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

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

Ce bloc de code dans la fenêtre flottante

Réponse réussie

Champ	Type	Description
documents	Array<Object>	Métadonnées de chaque document ; les documents sans enregistrements de métadonnées ne seront pas renvoyés.
doc_id	String	ID du document.
auto_metadata	Object	Métadonnées renseignées automatiquement par le système (nom du document/heure de téléchargement/uploader/source, etc.), en lecture seule.
metadata	Object	Valeur de métadonnées personnalisée, le format est "nom du champ → valeur".

Réponse d'erreur

Champ	Type	Description
code	Integer	Code d'erreur.
message	String	Détails de l'erreur.