Saltar al contenido
API v1 · https://bentho.org/api
API V1

La API de Bentho

Pregúntale a los documentos de un espacio, sube y quita documentos, ajusta cómo responde y consulta tus créditos. Todo por HTTP, con JSON y una clave. Los módulos de tu espacio suman sus propias rutas.

Lo básico

BASEhttps://bentho.org/api
CLAVEAuthorization: Bearer bth_<id>.<secreto> · Claves y permisos
FORMATOJSON (Content-Type: application/json), salvo la subida de documentos (multipart) y el stream (SSE).
DESDE DÓNDEDesde tu servidor. La API no admite llamadas desde el navegador de tus usuarios (CORS), y la clave nunca debe llegar ahí.
VERSIÓNv1: se agregan campos, nunca se quitan ni se renombran.

Las rutas

MÉTODORUTAPARA QUÉPERMISO
POST/rag/{espacio}/conversationsHaz una pregunta a tu espaciolee
SSE/rag/{espacio}/conversations/streamLa misma pregunta, en vivolee
GET/rag/{espacio}/documentsLos documentos del espaciolee
POST/rag/{espacio}/load_documentsSube documentosescribe
DEL/rag/{espacio}/documents/{archivo}Quita un documentoescribe
GET/rag/{espacio}/indexing_status¿Ya está listo lo que subí?lee
PATCH/rag/{espacio}/configAjusta cómo responde el Cerebroescribe
PATCH/companies/{espacio}/api-configLímites, cuota diaria e IPs del espacioescribe
GET/cuentas/{cuenta}/bolsaTus créditoslee

Módulos

Las rutas de un módulo cuelgan de /api/mod/{modulo}/{espacio}/, con la misma clave y los mismos límites. Solo responden en los espacios que tienen ese módulo (los ves en GET /api/companies); en los demás, 403.

Fuentes · /api/mod/fuentes/{espacio}

MÉTODORUTAPARA QUÉPERMISO
POST/fichasArma una fichaescribe
GET/fichas/{ficha}El estado de una fichalee
GET/fichas/{ficha}/markdownLa ficha armada y cómo se armólee
GET/fichasLas fichas del espaciolee
POST/fuentesCrea una fuenteescribe
POST/fuentes/{fuente}/lanzarLanza una fuenteescribe
GET/fuentes/{fuente}Una fuente y su última corridalee
GET/fuentesLas fuentes del espaciolee
POST/fuentes/{fuente}/cancelarCancela la corrida de una fuenteescribe
DEL/fuentes/{fuente}Borra una fuenteescribe

Landings · /api/mod/landing/{espacio}

MÉTODORUTAPARA QUÉPERMISO
POST/landingsCrea una landingescribe
GET/landingsLas landings del espaciolee
GET/landings/{landing}El estado de una landinglee
GET/landings/{landing}/htmlEl HTML de una landinglee
POST/landings/{landing}/completarResponde a lo que faltaescribe
POST/landings/{landing}/refinarPide cambios a una landingescribe
POST/landings/{landing}/validarValida un HTML editado a manoescribe
POST/landings/{landing}/cancelarCancela la versión en cursoescribe
DEL/landings/{landing}Borra una landingescribe

Otras rutas útiles

  • GET /api/companies: los espacios a los que llega tu clave, con su id y sus módulos.
  • GET /api/companies/{espacio}/cuenta: la cuenta del espacio (para consultar la bolsa de créditos).
  • GET /api/rag/{espacio}/documents/{archivo}: descarga un documento.
  • DELETE /api/rag/{espacio}/clear_cache: vacía la caché de respuestas del espacio (escribe).
  • /api/tokens: crear, listar y revocar claves. Ver Claves y permisos.

Antes de integrar