|
Documentación
Agenda una demoPlataforma
PlataformaMCPCLIAPI
Flujos de trabajo
GuíasRegistro de cambios

Bienvenida

  • Descripción general
  • Autenticación
  • Errores y códigos de estado
  • Firmas de webhook

Localización

  • Descripción general
  • Crear trabajos
  • Bloquea las claves no traducibles
  • Monitorear un grupo de trabajos
  • Obtener un trabajo
  • Listar trabajos
  • Entrega de webhooks
  • Progreso en tiempo real (WebSocket)

Pipeline

  • Descripción general
  • Edición con IA previa a la localización
  • Revisión humana
  • evaluación de IA (post-edición)
  • Reescribe para que suene natural
  • Verificación de retrotraducción
  • Configura el pipeline
  • Ver ejecuciones del pipeline

Aprovisionamiento

  • Descripción general
  • Crear un trabajo de aprovisionamiento
  • Tipos de fuente
  • Lo que extrae la IA
  • Entrega de webhooks
  • Progreso en vivo (WebSocket)

Síncrono

  • Localize
  • Recognize

Gestión del motor

  • Sugerencias del motor

Crear un trabajo de aprovisionamiento

Envía las fuentes que ya tienes y recibe un motor. POST /jobs/provisioning toma un nombre para un motor nuevo y hasta 10 fuentes — enlaces para rastrear o texto sin formato — y devuelve 202 Accepted con el ID del motor. No tienes que esperar a que la IA termine de leer tu contenido: el motor existe desde el momento en que responde la llamada, y su configuración se va aplicando mientras se ejecuta el trabajo.

text
POST /jobs/provisioning

Esta página cubre la llamada de creación: sus parámetros, la estructura de la solicitud y la respuesta 202. ¿Eres nuevo en el aprovisionamiento asíncrono? Empieza por la Descripción general de la API de aprovisionamiento asíncrono para entender el modelo. Qué se considera una buena fuente tiene su propia página — Tipos de fuente — y lo que la IA extrae de ellas está en Lo que extrae la IA.

Autenticación

Pasa tu clave de API en el encabezado X-API-Key. Las claves tienen alcance a nivel de organización y dan acceso a todos los motores de la organización. Consulta Autenticación para más detalles.

Parámetros#

Solo engine.name es obligatorio. Todo lo demás define lo que aprende el motor o, si lo omites por completo, te deja con un motor limpio y con la configuración predeterminada.

ParámetroTipoDescripción
engine.namestringNombre del nuevo motor de localización.
engine.descriptionstring (opcional)Descripción de texto libre para el motor.
localesstring[] (opcional)Idiomas de destino en BCP-47 para configurar, por ejemplo, ["es", "ja", "de"].
sourcesarray (opcional)Hasta 10 fuentes para analizar. Cada una puede ser link (una URL que la plataforma rastrea) o content (texto sin formato o markdown). Consulta Tipos de fuente.
callbackUrlstring (opcional)URL HTTPS del webhook para el resultado final. Solo HTTPS: las URL de callback HTTP se rechazan. Consulta Entrega de webhooks.

Solicitud#

Una fuente es un objeto { type, payload }. Apunta las fuentes link a páginas con contexto real — lineamientos de marca, guías de estilo, documentación del producto — y usa content para terminología y reglas de tono que puedas pegar directamente. La solicitud de abajo combina ambas: dos páginas para rastrear y un bloque de reglas explícitas.

javascript
const response = await fetch("https://api.lingo.dev/jobs/provisioning", {
  method: "POST",
  headers: {
    "X-API-Key": process.env.LINGO_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    engine: {
      name: "Acme Corp Engine",
      description: "Production localization engine for acme.com",
    },
    locales: ["de", "fr", "ja", "es"],
    sources: [
      { type: "link", payload: "https://acme.com/brand-guidelines" },
      { type: "link", payload: "https://acme.com/docs/style-guide" },
      {
        type: "content",
        payload:
          "Brand name 'Acme' is never translated. Use formal tone in German (Sie-form). Product names: AcmeFlow, AcmeSync, AcmeVault - always keep in English.",
      },
    ],
    callbackUrl: "https://your-app.com/webhooks/provisioning",
  }),
});

const { jobId, engineId, status } = await response.json();
// 202 back right away.
// status: "in_progress" – the AI is reading your sources.
console.log(engineId); // "eng_X1y2Z3a4B5c6D7e8" – usable right now

Respuesta (202 Accepted)#

La llamada responde sin esperar al rastreo ni al análisis: te entrega un ID de trabajo para darle seguimiento y un ID de motor que queda activo desde ese momento.

json
{
  "jobId": "pjb_A1b2C3d4E5f6G7h8",
  "engineId": "eng_X1y2Z3a4B5c6D7e8",
  "status": "in_progress"
}
CampoDescripción
jobIdID del trabajo de aprovisionamiento (prefijo pjb_). Dale seguimiento al trabajo conectando un WebSocket para ver el progreso en vivo, o recibe el resultado en tu webhook cuando termine.
engineIdID del nuevo motor (prefijo eng_). Se puede usar de inmediato: la configuración que la IA extrae se le aplica mientras se ejecuta el trabajo.
statusin_progress cuando proporcionas fuentes; completed cuando no las proporcionas (ver abajo).

El detalle que hace que esta llamada asíncrona valga la pena, en lugar de ponerse a esperar, es este: engineId vuelve en el mismo 202 y apunta de inmediato a un motor real. Puedes guardarlo, enviar una solicitud Localize sincrónica a través de él o integrarlo en tu app antes de que la IA haya terminado de leer una sola fuente. A medida que se extraen voces de marca, términos del glosario e instrucciones, la plataforma aplica cada uno a ese mismo motor: el motor existe antes que su configuración. Para saber exactamente qué creó el trabajo, consulta Lo que extrae la IA.

¿Sin fuentes? Obtienes un motor, no una espera.

Si omites sources, no hay nada que rastrear, así que el motor se crea con la configuración predeterminada del modelo y se devuelve con status: "completed" en la misma respuesta. Ese es el camino rápido cuando quieres un motor vacío para configurarlo tú mismo: una sola llamada, un engineId listo, sin trabajo en segundo plano al que haya que darle seguimiento.

Siguientes pasos#

Tipos de fuente
Fuentes de enlace vs. de contenido, y qué hace que una fuente valga la pena analizar.
Lo que extrae la IA
Voces de marca, términos del glosario e instrucciones, además del resumen que devuelve el trabajo.
Entrega de webhooks
Recibe el resultado final en tu URL de callback y verifica la firma.

¿Te resultó útil esta página?

Max PrilutskiyMax Prilutskiy·Actualizado hace 12 días·4 min de lectura