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

Obtener un banner

Lee el spec, la versión actual, las piezas y los textos de un concepto, o lista los conceptos de tu workspace.

Devuelve solo datos: el spec del concepto, la versión actual, el estado de cada pieza (tamaño por idioma) y los textos por idioma. No devuelve HTML ni enlaces de vista previa. Requiere el permiso read (o cualquiera de los otros, que lo incluyen).

Parámetros de la ruta

CampoRequisitoDescripción
idstring
Obligatorio
El creativeId: lo ves en el trabajo terminado y en el webhook banner.generated.

Respuesta

CampoQué es
id, campaignId, name
Identifican el concepto, su campaña y su nombre.
variantNo, versionNo
Número de alternativa (variant) y de versión.
appUrl
Enlace absoluto al concepto en el estudio de la app. null con una clave de pruebas.
specVersion, engineVersion, modelId
Con qué versión del spec, del motor y de modelo se generó esta versión.
spec
La descripción técnica del concepto en JSON: composición, textos y animación.
pieces
Una entrada por pieza (un tamaño en un idioma), con size, locale y status.
translations
Los textos por idioma.
createdAt
Fecha de creación en formato ISO 8601.

El status de una pieza es draft, in_review, changes, approved o needs_review.

Listar conceptos

GET /api/v1/banners lista los conceptos del workspace, del más nuevo al más viejo, con paginación por cursor (cursor y limit, de 1 a 100; por defecto 50). Filtra con campaignId. Cada elemento trae id, campaignId, name, variantNo, versionNo, url y appUrl.

Errores

Un id que no existe, o que es de otro workspace, responde 404. Los ids de prueba (crt_test_…) solo se leen con claves bm_test_.

Estado de un trabajoConsulta un trabajo de generación o síguelo en vivo con eventos SSE.CampañasLista las campañas de tu workspace, archívalas y agrega o quita idiomas.Corregir y adaptar un bannerCorrige un concepto con una instrucción en lenguaje natural o agrégale tamaños nuevos. Responden 202 con un trabajo.
¿Te sirvió esta página?