logo
Desarrollo
Buscar
Obtener metadatos del documento

Obtener metadatos del documento

Obtiene por lotes los metadatos de los documentos mediante sus ID y devuelve auto_metadata (completado automáticamente por el sistema y de solo lectura) y metadata (valores de campos personalizados). Se pueden consultar hasta 50 documentos por solicitud.

Método de solicitud

GET

Endpoint

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

Autenticación

Para obtener información sobre la autenticación, consulte Visión general de la API.

Solicitud

Ejemplo de solicitud

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

                    
Este bloque de código en una ventana flotante

Encabezados de solicitud

Campo Tipo Descripción
Authorization Bearer ${API Key} Autentíquese con Authorization: Bearer ${API Key}. Obtenga la API Key en la página de claves API.

Parámetros de solicitud

Campo Tipo Obligatorio Descripción
doc_ids String ID de documentos separados por comas, hasta 50 por solicitud. Todos los documentos deben pertenecer al Agent asociado con la API Key actual. Si algún documento no existe o no pertenece al Agent actual, la solicitud completa falla con one or more doc_ids do not exist or do not belong to the current bot.

Respuesta

Ejemplo de respuesta

{ "documents": [ { "doc_id": "doc_001", "auto_metadata": { "document_name": "Especificación de API.pdf", "upload_time": "2026-01-15T10:30:00Z" }, "metadata": { "category": "Técnico", "priority": "P1" } } ] }
                      
                      {
    "documents": [
        {
            "doc_id": "doc_001",
            "auto_metadata": {
                "document_name": "Especificación de API.pdf",
                "upload_time": "2026-01-15T10:30:00Z"
            },
            "metadata": {
                "category": "Técnico",
                "priority": "P1"
            }
        }
    ]
}

                    
Este bloque de código en una ventana flotante

Respuesta correcta

Campo Tipo Descripción
documents Array<Object> Metadatos de cada documento. No se devuelven los documentos que no tienen registros de metadatos.
doc_id String ID del documento.
auto_metadata Object Metadatos completados automáticamente por el sistema (nombre del documento/hora de carga/cargador/fuente, etc.), de solo lectura.
metadata Object Valor de metadatos personalizado, el formato es "nombre de campo → valor".

Respuesta de error

Campo Tipo Descripción
code Integer Código de error.
message String Detalles del error.