Upload

Método utilizado para subir un documento

Para subir un documento podemos generar la siguiente solicitud con el archivo payload.json:

curl "https://agents.boolfy.com/api/documents/upload" \ 
    -H "Authorization: Bearer BOOLFY_BEARER_KEY" \
    -H "Content-Type: application/json" \
    -d @payload.json

El archivo payload.json debe tener el siguiente formato:

{
    "agent": "Facturas",
    "document": "yJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1...",
    "externalcode": "123456",
    "filename": "0001-00003456.pdf",
    "bag": "{\"user\":\"[email protected]\",\"pass\":\"MD5 password\",...}",
    "cluster":[
        {
        "agent": "Recibo", 
        "document": "yJndgdenen...", 
        "filename":"photo.jpeg"
        }
    ]
}

Detallamos en forma completa los campos de la solicitud:

Campo	Descripción
Agent	Especifica el nombre del agente IA que se utilizará para procesar el documento
Document	Especifica en Base64 el Stream del documento. Los formatos de archivo aceptados son: PDF, PNG, JPEG y JPG
ExternalCode	Opcional. Especifica el identificador del documento en tu plataforma
Filename	Opcional. Especifica el nombre del documento. Si no se proporciona, se asume .pdf
Bag	Opcional. Permite enviar un JSON especifico para ser utilizado durante el proceso del documento.
Cluster	Opcional. Esta opción se debe habilitar desde el Agente principal. Permite adjuntar otros documentos al documento principal. La definición de campos es la misma que la principal.

Ejemplo de campo Bag

Detallamos un ejemplo del campo Bag aplicado al envio de los datos extraidos a un tercero:

{
    "user": "[email protected]",
    "pass": "MD5 password",
    "idEmpresa": "Enterprise identifier",
    "endPoint": "End point to call"
}

Respuesta

La respuesta exitosa para la operación de carga de documentos es:

{
    "code": 200,
    "msg": "Document uploaded",
    "response": "{\"Identifier\":\"5a37b2ab-551b-4380-aa88-b808e3352d66\"}"
}

La respuesta exitosa cuando se envia con Cluster es:

{
    "code": 200,
    "msg": "Document uploaded",
    "response": "{\"Identifier\":\"5a37b2ab-551b-4380-aa88-b808e3352d66\",
    \"Cluster\":[{\"Identifier\":\"54d542ab-451c-1855-t452-bse4rfse22211\"}]}"
}

Detallamos el contenido del campo Response:

Campo	Descripción
Identifier	Especifica el identificador único dentro de Boolfy para el documento