Crear mi primera campaña
Menú de la documentación
GET/api/v1/jobs/:id

Estado de un trabajo

Consulta un trabajo de generación o síguelo en vivo con eventos SSE.

Generar, corregir, adaptar o traducir no es instantáneo: la API devuelve un trabajo (job) y la IA lo termina después. Puedes consultar su estado cuando quieras, escucharlo en vivo o esperar el webhook. Requiere el permiso read (o cualquiera de los otros).

Consultar el estado

El campo status es queued, running, succeeded, failed o canceled. Cuando termina bien, creativeId es el concepto que puedes leer con GET /api/v1/banners/:id y appUrl abre ese concepto en el estudio de la app. Si falla, error trae un code y un message, y los créditos se devuelven.

CampoQué es
id, type
El id del trabajo y su tipo: generate, edit, adapt o translate.
status
El estado del trabajo.
creativeId, versionNo
El concepto resultante y su versión, cuando termina.
appUrl
Enlace absoluto al concepto en el estudio. null mientras corre, si falló o con una clave de pruebas.
error
null o el motivo del fallo.
creditsCharged
Créditos cobrados por el trabajo completo (todos los tamaños e idiomas).
createdAt, startedAt, finishedAt
Fechas en formato ISO 8601.

Eventos en vivo (SSE)

SSE (Server-Sent Events) es un flujo de avisos en vivo sobre HTTP: abres la conexión y el servidor te va enviando el progreso.

El endpoint GET /api/v1/jobs/:id/events abre un flujo text/event-stream. Primero llega un evento status con el estado actual y después, mientras avance, queued, running, progress (con step y pct) y por último succeeded o failed, y el servidor cierra el flujo.

  • El flujo envía una línea de pulso (: ping) cada 15 segundos para mantener la conexión.
  • Se cierra solo a los 5 minutos como máximo: vuelve a conectar o consulta GET /api/v1/jobs/:id.
  • Si el trabajo ya había terminado, recibes status y el flujo se cierra.
  • Una clave sin permiso o un id ajeno responden 401, 403 o 404 antes de abrir el flujo.
Nota. Con una clave bm_test_, los ids job_test_… ya vienen como succeeded, con test: true y sin créditos cobrados.
Eventos de webhooksLos 13 eventos, todos emitidos hoy: cuándo salen, qué trae el campo data y un ejemplo de cada uno.Obtener un bannerLee el spec, la versión actual, las piezas y los textos de un concepto, o lista los conceptos de tu workspace.
¿Te sirvió esta página?