Saltar a contenido

Acceso a la API

n-Infinite expone una API REST para que pueda gestionar proyectos desde sus propios sistemas: crear un proyecto, seguir su progreso y extraer los conjuntos de datos cuando finalice.

  • Base URL: https://tools.api.livepanel.ai/api/v2
  • Referencia interactiva: tools.api.livepanel.ai/v2/docs/ — siempre el contrato autorizado y actualizado (este capítulo lo resume).
  • Soporte: support@livepanel.ai

Autenticación

Genere su clave en Settings → API:

Configuración de la API

  • API Key — presione el botón de la derecha para generarla. La clave se muestra solo mientras está en pantalla: cópiela inmediatamente y guárdela de forma segura. Si la pierde, genere una nueva.
  • Callback URL — un endpoint de su lado que recibe eventos del proyecto.

Envíe la clave en cada solicitud en el encabezado Authorization, con el prefijo Api-Key:

Authorization: Api-Key YOUR_GENERATED_TOKEN

Ciclo de vida del proyecto

La creación de un proyecto es asíncrona. POST /projects responde con un proyecto en estado INITIALIZING; cuando el procesamiento inicial finaliza, pasa a CREATED. A partir de ahí:

INITIALIZING → CREATED → (enqueue) → TRAINING_AND_PREDICTING → FINISHED
                  ↑                          ↓ pause
            PERFORMING_ACTION              PAUSED → (restart)
                                             ↓
                          POST_PROCESSING → POST_PROCESSING_COMPLETE

Un proyecto informa su progreso solo mientras se encuentra en TRAINING_AND_PREDICTING, PREDICTING, PAUSED, FINISHED, POST_PROCESSING o POST_PROCESSING_COMPLETE.

Endpoints

Projects

Method Path Qué hace
GET /projects Listar proyectos
POST /projects Crear un proyecto (asíncrono — ver abajo)
GET /projects/{id} Recuperar un proyecto
DELETE /projects/{id} Eliminar el proyecto y todos sus componentes
POST /projects/{id}/enqueue Enviar el proyecto al pipeline de ML
POST /projects/{id}/pause Pausar un proyecto que está siendo procesado
POST /projects/{id}/restart Reiniciar un proyecto — solo desde PAUSED
GET /projects/{id}/progress Progreso detallado
POST /projects/{id}/move-to-folder Mover a una carpeta (folder_id, o folder_name para crear una)
GET /projects/compare Resumen de calidad entre proyectos — la vista Compare projects
GET/POST/DELETE /projects/{id}/members Leer, añadir y eliminar usuarios asignados
POST /projects/projects-lite Crear un proyecto Lite
POST /projects/peek-columns Nombres de columna (y etiquetas, para .sav) de un archivo subido — para poblar selectores de columna, necesario para SPSS que el navegador no puede analizar
POST /projects/parse-datafile Leer un archivo subido completo (cualquier formato soportado, incluyendo SPSS .sav) y devolver sus columnas y cada fila

Creación de un proyecto

POST /projects acepta datos de formulario multipart:

Field Required Significado
datafile yes El archivo del conjunto de datos
predict no Conjunto de datos de predicción separado (Advanced mode)
name no Nombre del proyecto
multiple_choice_delimiter no Separador utilizado para respuestas de selección múltiple
smart_match no Aplicar Smart Match a los campos automáticamente
force_enqueue no Poner en cola para procesamiento inmediatamente, omitiendo la llamada de encolado separada
swift no Crear en modo de impulso Swift — entrena automáticamente de inmediato, sin encolado separado
first_question no Columna donde comienza el cuestionario; todo lo anterior es el perfil del encuestado
express_preset no ID o nombre de un preset de coincidencia Express guardado
factor no Factor de amplificación Express N
country no Slug de país Express (con express_preset, cuando sea necesario)

Note

Los proyectos Express se crean a partir de un preset guardado — un express_spec en bruto no se acepta aquí. Guarde el preset una vez (en la UI o a través de los endpoints de presets), luego refiérase a él por ID o nombre en cada creación.

Datasets

Method Path Qué hace
GET /projects/{id}/datasets/get_file Descargar un conjunto de datos (ver tipos abajo)
POST /projects/{id}/datasets/get_merged_postprocessed Archivo Merged con los pasos de post-procesamiento aplicados
POST /projects/{id}/datasets/dedup_analysis Análisis de duplicados — lo que muestra la vista previa de deduplicación
GET /projects/{id}/datasets/dashboard_report Los datos del panel de gráficos
GET /projects/{id}/datasets/profiling_distribution Distribuciones de perfilado (Train vs. Predict)
POST /projects/{id}/swift-target Swift Target File: el conjunto de datos sintético deduplicado, seleccionado por cuotas y ponderado por balance. Disponible una vez FINISHED; devuelve un binario xlsx, no se necesita cuerpo
POST /projects/{id}/express-target Equivalente Express, sobre el pool amplificado por censo (deduplicación solo dentro de Predict — las filas impulsadas son personas reales distintas)

Tipos de conjuntos de datos para get_file, todos devueltos como .xlsx:

Type Contenido
Train El conjunto de datos utilizado para entrenar los modelos
Predict Datos de perfilado utilizados como entrada para generar datos sintéticos
Predicted Todos los datos sintéticos generados, con la misma forma que Train
Merged Train + Predicted concatenados

Fields

Method Path Qué hace
GET /projects/{id}/fields Todos los campos de un proyecto
GET /projects/{id}/fields/{field_id} Un campo
POST /projects/{id}/fields/apply_smart_match Aplicar Smart Match a las predicciones de cada campo
POST /projects/{id}/fields/perform_action Ejecutar una acción en los campos (asíncrono)

perform_action soporta:

  • REMOVE_CLASS — elimina una clase específica de un campo.
  • CLEAN_TEXT_BRANDS — normaliza campos de texto sobre marcas.

Mientras se ejecuta una acción, el estado del proyecto pasa a PERFORMING_ACTION y vuelve a CREATED cuando finaliza.

Express presets

Method Path Qué hace
GET /express/presets Listar los presets de coincidencia Express guardados de su empresa. Filtro opcional ?country=<slug>
POST /express/presets Crear o sobrescribir un preset — name + country lo identifican, por lo que guardar un nombre existente para ese país reemplaza su matching
GET /express/presets/{id} Recuperar un preset
DELETE /express/presets/{id} Eliminar un preset

Un preset contiene la parte reutilizable de una especificación Express: las asignaciones de columnas y valores descritas en Modos de impulso.