Saltar al contenido
API v1 · https://bentho.ai/api
POST/api/mod/fuentes/{espacio}/fichas

Arma una ficha

Le das un tema y una plantilla con los campos que quieres. Bentho busca en la web pública, lee las páginas y llena cada campo con el dato, la página de la que sale y la frase que lo respalda. Al terminar, la ficha se publica en los documentos del espacio.

  • PERMISOescribe
  • CRÉDITOSgasta créditos
  • AUTENTICACIÓNBearer bth_…

PARÁMETROS

CAMPOTIPOREQUERIDOQUÉ ES
espaciostringSÍEl id del espacio (sale en GET /api/companies). Tiene que tener el módulo Fuentes.

CUERPO · JSON

CAMPOTIPOREQUERIDOQUÉ ES
temastringSÍDe qué trata la ficha, de 2 a 120 caracteres.
plantillastringSÍLos campos, en markdown: ## por sección y una línea - Nombre: qué buscar por campo. Su forma, en la guía.
paginasintegernoCuántas páginas leer como mucho, de 1 a 5000. Por defecto 20.
urlsstring[]noPáginas que ya conoces sobre el caso, en HTTPS (una http se acepta, pero no se lee). Se leen además de lo que encuentre, y marcan dónde seguir buscando.
comoobjectnoCómo buscar: ver como.

RESPUESTA 202

La ficha recién creada, en recibido. Guarda su id.

CAMPOTIPOQUÉ ES
id · temastringEl id y el tema.
statusstringSu estado: ver estados.
pagesintegerPáginas leídas.
errorstringPor qué falló, en una frase: No se encontró ninguna página para el tema, No se pudo buscar el tema, La búsqueda no devolvió páginas o El buscador no respondió; cualquier otro fallo, No se pudo armar la ficha. Mientras el buscador no responde, la ficha vuelve a la cola y dice esperando al buscador. Vacío si no falló.
cuentastringLa cuenta que la pidió.
created_at · updated_atnumberSegundos desde 1970, con decimales.
urlsstring[]Las que diste al armarla.
comoobjectLas opciones con que se arma: las de como que mandaste.

COMO

CAMPOTIPOQUÉ ES
idiomastringEl idioma de la ficha y de la búsqueda. Por defecto "es".
dominiosstring[]Lee solo páginas de estos dominios (hasta 50). Vacío: toda la web pública.
rondasintegerVueltas de búsqueda, de 1 a 8 (por defecto 6). Cada una busca solo los campos que siguen vacíos.
paginas_por_rondaintegerPáginas nuevas que lee cada vuelta, de 1 a 12 (por defecto 4).
instruccionesstringIndicaciones para buscar, hasta 500 caracteres: «solo fuentes oficiales», «precios en pesos colombianos».
coherenciabooleanUna ficha, un caso: descarta los datos de páginas que hablan de otro caso parecido. Por defecto false.
cierre_externobooleanAl final, una búsqueda externa intenta llenar los campos que siguen vacíos. Si trae una página que respalda el dato, se cita como cualquier otro; si no, el campo sale marcado «completado por búsqueda externa, sin página que lo respalde». Gasta créditos a tarifa externa. Si no responde, la ficha se arma sin ella. Por defecto false.

ERRORES DE ESTA RUTA · SIEMPRE {"detail": …}

STATUSCUÁNDODETAIL LITERAL
403El espacio no tiene el módulo Fuentesmódulo no habilitado para este espacio.
403La clave es de solo lecturaTu cuenta es de solo lectura en este espacio.
402La cuenta agotó sus créditos del cicloLa cuenta de este espacio agotó sus créditos de este ciclo.
422La plantilla no tiene ninguna sección con camposLa plantilla no tiene secciones con campos
422Un campo fuera de su rango o de su tipo (detail es una lista)—

Y los de cualquier ruta —clave inválida, cuenta no al día, IP, límites—, en Errores, límites y créditos.

CONVIENE SABER

  • Responde enseguida: el trabajo sigue en segundo plano y suele tardar unos minutos. Consulta el estado cada 10 a 15 s.
  • Armar otra ficha con el mismo tema la reemplaza en los documentos del espacio: queda una versión nueva del mismo documento.
  • Si la web abierta da menos de la mitad de los campos, aportar 2 a 4 urls concretas del caso suele subir cuántos se llenan.