Explorar el centro de ayuda

Automatice Transept con la API

Mantenido por Vitalii VlasiukCo-founder

Cualquier acción del editor puede realizarse también mediante un script. La API sirve para integrar Transept en su cadena de procesos —un CMS, una tarea de localización o una etapa de CI—, de modo que la traducción se ejecute sin necesidad de abrir la aplicación.

En esta página

¿Cómo obtengo una clave de API?

Cree una clave de API personal en Configuración → Desarrollador. Está disponible en todos los planes, incluido el gratuito; no hay barreras de acceso adicionales, el uso está limitado únicamente por su saldo de palabras. Asigne un nombre a la clave, establezca opcionalmente una fecha de caducidad y copie el secreto cuando se muestre: aparece una sola vez y no podrá recuperarse después. Puede revocar una clave en cualquier momento desde esa misma página.

Las solicitudes se autentican con la clave en un encabezado Authorization: Bearer tsk_live_… — solo en el encabezado, nunca en la URL.

¿Cuál es el camino más corto de la clave a la traducción?

Bastan seis llamadas breves para pasar de una clave de API al contenido traducido. Solo la ejecución de la traducción en sí consume palabras; las estimaciones son gratuitas y, si se reintenta una llamada con la misma Idempotency-Key, se devuelve el resultado original en lugar de cobrar dos veces.

Estas mismas llamadas, con explicaciones más detalladas, están disponibles en transept.ai/developers. La guía de la API de localización detalla el resto: catálogos de cadenas, plantillas de correo electrónico, glosarios, equipos y etapas de revisión.

export KEY="tsk_live_…"                          # minted under Settings → Developer
BASE="https://app.transept.ai/api/public/v1"

# 1. Check the key: your account, its permissions, your word balance
curl -s $BASE/me -H "Authorization: Bearer $KEY"

# 2. Create a document; Transept creates one language version per target
curl -s -X POST $BASE/documents \
  -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d '{"title": "Welcome email", "content": "# Welcome…", "content_type": "markdown",
       "source_language": "en", "target_languages": ["de", "fr", "uk"]}'

# 3. Estimate: the word cost, free, with no side effects
curl -s -X POST $BASE/group-runs/estimate \
  -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d '{"document_id": "<master>", "template_id": "end_to_end", "target_languages": "all"}'

# 4. Run: the same body starts it
curl -s -X POST $BASE/group-runs \
  -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -H "Idempotency-Key: welcome-1" \
  -d '{"document_id": "<master>", "template_id": "end_to_end", "target_languages": "all"}'

# 5. Wait: poll for per-language progress (or get pushed an event; see below)
curl -s $BASE/group-runs/<group-run-id> -H "Authorization: Bearer $KEY"

# 6. Read each language back in the format you need (the table below lists them)
curl -s "$BASE/documents/<version-id>/content?format=markdown" \
  -H "Authorization: Bearer $KEY"
Lo que devuelve cada valor de format= del endpoint de contenido.
format=Devuelve
jsonTexto original por bloque + traducción activa (predeterminado para la API)
stringsEl catálogo completo con todos los idiomas indexados por ID de unidad, en una sola llamada
markdown / htmlTexto renderizado (html para documentos de origen HTML)
sourceLa exportación fiel en el formato original del documento
docx / pdfUn archivo de Word con las traducciones reinsertadas en el original o un PDF renderizado.
xliff / tmx / csvIntercambio para herramientas TAO, memorias de traducción y hojas de cálculo

¿Cómo importo documentos a través de la API?

Cree un documento a partir de texto sin formato, HTML o markdown, o suba un archivo (los mismos formatos que acepta la aplicación). También puede importar una tabla de strings (.tstrings.json), un formato estructurado para textos de interfaz o strings de videojuegos en el que cada string es una unidad con una clave estable y su propio contexto: una nota sobre qué es, dónde aparece, el límite de caracteres y el significado de sus marcadores. Toda esa información llega al modelo; los marcadores como {name} están protegidos para evitar que se eliminen o se renombren, y los plurales se expanden según el idioma (una forma en inglés se convierte en dos en alemán y en cuatro en ucraniano). Cualquier traducción que el archivo ya incluya se importa tal cual, sin coste, y alimenta la memoria de traducción de inmediato.

¿Cómo ejecuto procesos en varios idiomas con una sola llamada?

Una ejecución grupal traduce a varios idiomas a la vez. Especifique el documento, el flujo de trabajo o la plantilla y los idiomas de destino; Transept creará las versiones de idioma que falten y ejecutará el flujo en cada una. Un único ID rastrea todo el proceso: consúltelo para ver el progreso de cada idioma y si alguno está pendiente de revisión.

Para ejecuciones recurrentes, vuelva a enviar el archivo actual de una tabla de strings y Transept detectará qué ha cambiado: las strings que no hayan variado conservarán sus traducciones (y cualquier revisión previa), y la ejecución solo afectará a las unidades nuevas o que realmente hayan cambiado; es la versión para API de Ejecutar solo lo que ha cambiado. Todo el ciclo basado en claves, desde la primera importación hasta las ejecuciones incrementales, se explica en Localizar un catálogo de strings a través de la API.

¿Cómo recibo eventos mediante webhooks?

En lugar de realizar consultas periódicas (polling), registre una URL y Transept enviará automáticamente un evento cuando una ejecución finalice o falle, cuando una revisión esté lista para examinarse, cuando una carga termine de procesarse o cuando una exportación esté disponible. Cada envío incluye un encabezado HMAC-SHA256 X-Transept-Signature: t=…,v1=… para que su servidor pueda verificar que el mensaje realmente proviene de nosotros; si un endpoint falla, se reintentará el envío con una estrategia de espera (backoff) antes de desactivarlo.

# register once; every matching event is POSTed to your URL, signed
curl -s -X POST $BASE/webhooks \
  -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/transept-events",
       "events": ["group_run.completed", "run.gate_ready", "run.failed"]}'
# → the endpoint, including its ONE-TIME secret; verify X-Transept-Signature with it

Activadores de Notion: conceda a Transept acceso a la página

Un flujo de trabajo también puede ejecutarse automáticamente desde una automatización de base de datos de Notion: dirija el webhook de la automatización a la URL del activador y Transept ejecutará el flujo en la página que haya cambiado. El inconveniente es que los webhooks de Notion nunca incluyen el contenido de la página; solo indican qué página se activó. Transept lee esa página a través de su conexión de Notion, por lo que deben cumplirse dos condiciones o, de lo contrario, cada activación se rechazará con un error de acceso y la tarjeta del activador mostrará el mensaje «no se pudo leer la página de Notion»:

  • Conecte Notion en Transept — en Ajustes → Integraciones. Este es el enlace OAuth que se realiza una sola vez para que Transept pueda leer en su nombre.
  • Comparta la base de datos de origen con la integración dentro de Notion: abra la base de datos (o página), haga clic en su menú •••, elija Conexiones y añada Transept. Conectar Notion en Ajustes no otorga acceso por sí solo a una base de datos específica; sin este paso, la conexión estará activa pero la página seguirá sin poder leerse.
  • Actívelo mediante un cambio de propiedad, no solo editando el cuerpo. Las automatizaciones de Notion se activan con cambios en las propiedades (y al añadir páginas), por lo que editar solo el cuerpo de una página puede no disparar nada. El método más fiable es usar una propiedad de Estado que la automatización vigile: cámbiela (por ejemplo, a «Listo para traducir») y ese cambio será lo que active el disparador.

¿Dónde está la referencia de la API?

La lista completa de endpoints está publicada como una especificación OpenAPI que puede importar en n8n, Zapier o un generador de código: explore la referencia interactiva o descargue el JSON original. ¿Prefiere una guía paso a paso? En transept.ai/developers encontrará la guía de inicio rápido con ejemplos para copiar y pegar, y la guía de la API de localización explica todo el ciclo en profundidad. Las ejecuciones iniciadas a través de la API facturan las palabras exactamente igual que el editor de la aplicación.

¿Puede mi asistente de IA usar Transept directamente?

Sí; Transept cuenta con un endpoint MCP al que se conectan los asistentes de IA: https://app.transept.ai/api/public/v1/mcp. La conexión utiliza el estándar OAuth: añada la URL a Claude Code, Claude Desktop, Cursor o cualquier cliente MCP, y se abrirá una ventana del navegador para que apruebe el acceso; no hace falta copiar ninguna clave (aunque las claves de API como encabezado Bearer siguen funcionando para entornos de CI y configuraciones sin interfaz). A partir de ahí, el asistente dispondrá de herramientas para todo el ciclo: importar documentos, ejecutar flujos de trabajo en varios idiomas, gestionar glosarios y guías de estilo, consultar la memoria de traducción y recuperar los resultados. Se han incluido dos medidas de protección: cada herramienta respeta los permisos concedidos y cualquier acción que consuma palabras responderá primero con una estimación; el asistente debe confirmar explícitamente antes de iniciar la ejecución, por lo que un agente nunca podrá facturarle por accidente. En la página de Integraciones de la aplicación encontrará fragmentos de configuración listos para usar para cada cliente; la guía completa, desde la pantalla de consentimiento hasta la desconexión, está en Conectar su asistente de IA.

Explorar funciones

¿Necesita más ayuda? Pregunte a Literess en la aplicación o escriba a [email protected].