Skip to main content

Documentation Index

Fetch the complete documentation index at: https://gotrebol.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

En esta forma, envías los documentos como tipo generic y Trébol detecta automáticamente el tipo real del documento (por ejemplo ac_mx, csf_mx, rut_co, etc.) y extrae la información correspondiente. Cuándo usar:
  • No sabes el tipo exacto del documento
  • Prefieres que Trébol clasifique en lugar de hardcodear el tipo
  • El usuario final puede subir cualquier documento válido y quieres procesarlo de todos modos
Cómo funciona:
  1. Envías el item con type: "generic" y el file_url
  2. Trébol analiza el documento y lo clasifica al tipo específico
  3. Una vez clasificado, Trébol extrae la información
  4. Si Trébol no puede clasificar, el item termina como unknown (documento no reconocido) o corrupted_file (archivo dañado)

​
Payload mínimo

{
  "country": "mx",
  "tag": "uuid-cliente-1234",
  "items": [
    {
      "type": "generic",
      "options": {
        "file_url": "https://www.ejemplo.com/documento.pdf"
      }
    }
  ]
}

​
Payload con client_item_type (hint)

Puedes darle a Trébol una pista del tipo esperado usando client_item_type. Trébol aún clasifica automáticamente, pero usa la pista para mejorar la precisión. 
{
  "country": "mx",
  "tag": "uuid-cliente-5678",
  "items": [
    {
      "type": "generic",
      "options": {
        "file_url": "https://www.ejemplo.com/acta-constitutiva.pdf",
        "client_item_type": "ac_mx"
      }
    }
  ]
}
Ver lista completa de valores válidos de client_item_type en las guías por caso de uso (ej: KYB México).

​
Resultado

Trébol devuelve el item_type final ya clasificado: 
{
  "items": [
    {
      "id": 12345,
      "item_type": "ac_mx",
      "item_status": "complete",
      "item_value": {
        /* estructura según ac_mx */
      }
    }
  ]
}
Si Trébol no pudo clasificar, verás item_type: "unknown" o item_type: "corrupted_file". Estos son tipos terminales — el item no cambiará más.

​
Siguientes pasos