Volver al inicio
Documentación de API
1. Validar token
API para validar token. Pasa el token API para comprobar si está configurado correctamente.
POSThttps://api.vuela.ai/generate/validate-token
Autorización
Cada solicitud debe enviar el token de autorización como token Bearer. Este token se puede generar desde el panel de control.
2. Generación de artículo informativo
Genera un artículo informativo enfocado en SEO y en la satisfacción de la intención del usuario.
POSThttps://api.vuela.ai/generate/article
| Parámetro | Requerido | Tipo | Descripción |
|---|---|---|---|
| projectSmall | Opcional | Cadena | ID del proyecto al que deseas vincular este contenido |
| titleSmall | Requerido | Cadena | El título del artículo. Requerido si no se proporciona una palabra clave. |
| keywordSmall | Requerido | Cadena | La palabra clave o tema del artículo. Requerido si no se proporciona el título. |
| languageSmall | Opcional | Cadena | Por defecto es inglés ('en'): El idioma en el que se debe redactar el artículo. |
| countrySmall | Opcional | Cadena | Por defecto es Estados Unidos ('US'): El contexto geográfico específico del artículo. |
| focusSmall | Opcional | Cadena | Enfoque o contexto adicional para el artículo. |
| addInternalLinksSmall | Opcional | Booleano | Por defecto es falso: Indica si se deben agregar enlaces internos al artículo. |
| projectWebsiteSmall | Condicional | Cadena | La URL del sitio web para enlaces internos. **Requerido si add_internal_links es verdadero. |
| addExternalLinksSmall | Opcional | Booleano | Por defecto es falso: Indica si se deben agregar enlaces externos al artículo. |
* Importante: Al menos se debe proporcionar el título o la palabra clave.
* Creación en lotes: La API permite generar un contenido por llamada. Puedes enviar múltiples llamadas para generar varios contenidos simultáneamente.
3. Generación de video
Genera un video basado en un guion o palabra clave con varias opciones de personalización.
POSThttps://api.vuela.ai/generate/video
| Parámetro | Requerido | Tipo | Descripción |
|---|---|---|---|
| modeSmall | Requerido | Cadena | Modo de generación de video. Valores permitidos: 'single_voice', 'scenes', 'avatar'. |
| qualityTier | Opcional | Cadena | Nivel de calidad. Valores permitidos: 'basic', 'premium'. El valor predeterminado es 'premium'. Los estilos personalizados solo están disponibles en el nivel premium. |
| videoScript | Requerido | Cadena | El guion del video. Los saltos de línea deben indicarse con \n. Para el modo `scenes`, debe seguir un formato específico con bloques [characters], [scene:] y [end] (ver ejemplo multicarácter). |
| languageSmall | Opcional | Cadena | El idioma en el que se debe generar el video. El predeterminado es 'en'. Debe ser un código de 2 caracteres. |
| countrySmall | Opcional | Cadena | El país objetivo del contenido del video. El predeterminado es 'US'. Debe ser un código de 2 caracteres. |
| aspectRatioSmall | Requerido | Cadena | La relación de aspecto del video. Valores permitidos: '16:9' (horizontal), '9:16' (vertical). El valor predeterminado es '16:9'. |
| animationTypeSmall | Requerido | Cadena | Tipo de animación. Valores permitidos: 'moving_image' (efecto Ken Burns), 'ai_video' (animación generada por IA). 'ai_video' no es compatible con el modo 'scenes'. |
| voiceId | Condicional | Cadena | El ID de la voz que se utilizará para la narración. Requerido en los modos `single_voice` y `avatar`. No se utiliza en el modo `scenes` (utilice `voices` en su lugar). |
| voiceStyleSmall | Opcional | Cadena | El estilo de la voz. Valores permitidos: 'narrative', 'expressive', 'dynamic'. El predeterminado es 'expressive'. |
| voiceSpeedSmall | Opcional | Cadena | La velocidad de la narración de la voz. Valores permitidos: 'standard', 'fast', 'very_fast'. El valor predeterminado es 'standard'. |
| voices | Condicional | Array de Objetos | Mapeo de voces para personajes. Requerido en el modo `scenes`. Cada objeto debe contener: { 'character': 'NOMBRE_DEL_PERSONAJE', 'voice_id': 'ID_DE_VOZ' }. Máximo 8 personajes permitidos. Todos los personajes mencionados en el guion deben tener asignación de voz. |
| mediaType | Condicional | Cadena | El tipo de medio a generar. Valores permitidos: 'ai_image', 'google_image', 'custom_image'. Requerido excepto para el modo `avatar` con disposición 'full_screen'. En el modo `scenes`, debe ser 'ai_image'. |
| style | Condicional | Cadena | El estilo visual para imágenes generadas por IA. Requerido cuando `media_type` es 'ai_image'. Valor predeterminado: 'photorealistic'. Valores permitidos: 'photorealistic', 'flat_design', 'comic', 'minimal', 'anime', '3d', 'cyber', 'classic_bw', 'dark', 'watercolor', 'bw_sketch', 'retro_80s', 'pop', 'pixel', 'papercut', 'doodle', 'sticker', 'fairytale', 'low_poly', 'fantasy', 'impressionist', 'surreal', 'minecraft', 'street_art', 'lego', 'barbie', 'retro_cartoon', 'psychedelic', 'gothic', 'art_nouveau', 'origami', 'metallic', 'glitch_art', 'wool_craft', 'stop_motion', 'clay_model', '80s_sitcom'. |
| styleId | Condicional | Cadena | El ID de un estilo personalizado. Requerido cuando `style` es 'custom' y `media_type` es 'ai_image'. Solo disponible en el nivel 'premium'. |
| imagesPerMinute | Opcional | Entero | Número de imágenes generadas por minuto de video. Acepta valores entre 8 y 40. Valor predeterminado: 8. No aplicable cuando `media_type` es 'custom_image'. Para el modo `scenes`, se calcula automáticamente según la longitud del guion. |
| customImageUrls | Condicional | Arreglo de cadenas | Lista de URLs de imágenes. Requerido cuando `media_type` es 'custom_image'. Para el tipo de animación 'ai_video', el número exacto de imágenes requeridas depende de la longitud del guion (1 imagen por cada 8 palabras). |
| avatarId | Condicional | Cadena | El ID del avatar. Requerido cuando el `modo` es 'avatar'. Nota: No todos los avatares son compatibles con todas las disposiciones. Verifique los avatares disponibles en su cuenta y su compatibilidad con diferentes disposiciones. |
| avatarLayout | Condicional | Cadena | Disposición del avatar. Requerido cuando el `modo` es 'avatar'. Valores permitidos: 'full_screen' (solo avatar visible), 'combined' (avatar con medios). |
| avatarLayoutStyle | Condicional | Cadena | Estilo de disposición del avatar. Requerido cuando `avatar_layout` es 'combined'. Valores permitidos: 'split_screen' (solo compatible con relación 9:16), 'overlay' (solo compatible con 9:16), 'overlay_corner' (compatible con 9:16 o 16:9), 'presentation' (solo compatible con 16:9). |
| avatarLayoutOptions | Condicional | Objeto | Opciones adicionales de disposición. Requerido para estilo 'presentation'. El objeto debe contener: { 'perspective': booleano (por defecto: false), 'background_id': entero (1-10) }. |
| addSubtitles | Opcional | Booleano | Indica si se deben agregar subtítulos al video. El valor predeterminado es false. |
| captionFontSmall | Condicional | Cadena | La fuente a usar para los subtítulos. Requerido si `add_subtitles` es true. Valor predeterminado: 'Roboto'. Use 'custom' para especificar una fuente personalizada con `caption_font_url`. |
| captionFontUrl | Condicional | Cadena | URL de la fuente personalizada. Requerido cuando `caption_font` es 'custom' y `add_subtitles` es true. |
| captionAlignmentSmall | Condicional | Cadena | La alineación de los subtítulos. Requerido si `add_subtitles` es true. Valores permitidos: 'top', 'top_middle', 'middle', 'bottom_middle', 'bottom'. Predeterminado: 'bottom'. |
| subtitleHighlightColor | Condicional | Cadena | El color utilizado para resaltar palabras en los subtítulos. Requerido si desea resaltado de palabras. Valores permitidos: 'purple', 'blue', 'orange', 'yellow', 'red', 'deepskyblue', 'green', 'teal', 'pink', 'cyan', 'magenta', 'lime', 'navy', 'maroon', 'olive', 'silver', 'gold', 'indigo', 'coral', 'turquoise', 'darkgreen', 'darkorange', 'crimson', 'skyblue', 'violet', 'khaki', 'salmon', 'plum', 'orchid', 'sienna'. |
| subTitleStrokeWidth | Opcional | Número | El grosor del contorno del texto del subtítulo. Valores permitidos: 0 (Oculto), 1 (Ligero), 2 (Estándar), 3 (Grueso). Predeterminado: 0. |
| subtitleHighlightMode | Condicional | Cadena | El modo de resaltado en subtítulos. Requerido si se proporciona `subtitle_highlight_color`. Valores permitidos: 'background' (resaltado detrás del texto), 'text' (texto coloreado). Predeterminado: 'background' cuando se proporciona color. |
| addBackgroundMusicSmall | Opcional | Booleano | Indica si se debe añadir música de fondo al video. El valor predeterminado es false. |
| backgroundMusicId | Condicional | Cadena | El ID de la pista de música de fondo. Requerido si `add_background_music` es true. |
* Creación en lotes: La API permite generar un contenido por llamada. Puedes enviar múltiples llamadas para generar varios contenidos simultáneamente.
4. Obtener mis proyectos
Obtiene una lista de todos los proyectos que has creado. A continuación, los parámetros de consulta para filtrar los datos.
GEThttps://api.vuela.ai/my-projects
| Parámetro | Requerido | Tipo | Descripción |
|---|---|---|---|
| pageSmall | Opcional | Número | Número de página a obtener |
| limit | Opcional | Número | Número de elementos por página. |
| search | Requerido | Cadena | Término de búsqueda por nombre de proyecto o dominio |
5. Detalles del proyecto
Obtiene los detalles de un solo proyecto. Reemplaza projectId en la URL con el ID real del proyecto.
GEThttps://api.vuela.ai/my-projects/{projectId}
| Parámetro | Requerido | Tipo | Descripción |
|---|---|---|---|
| projectId | Requerido | Cadena | ID del proyecto para obtener detalles. Debe pasarse como un parámetro de URL. |
6. Obtener mis contenidos
Obtiene una lista de contenidos que has añadido para generar. A continuación, los parámetros de consulta para filtrar los datos.
GEThttps://api.vuela.ai/my-content
| Parámetro | Requerido | Tipo | Descripción |
|---|---|---|---|
| pageSmall | Opcional | Número | Número de página a obtener |
| limit | Opcional | Número | Número de elementos por página. |
| search | Requerido | Cadena | Término de búsqueda por título o ID de contenido |
| statusSmall | Opcional | Cadena | Filtrar por estado del contenido. Los estados son: creating/failed/completed |
| typeSmall | Opcional | Cadena | Filtrar por tipo de contenido. El tipo es: article |
7. Detalles del contenido
Obtiene los detalles de un contenido. Reemplaza contentId en la URL con el ID real del contenido.
GEThttps://api.vuela.ai/my-content/{contentId}
| Parámetro | Requerido | Tipo | Descripción |
|---|---|---|---|
| contentIdSmall | Requerido | Cadena | ID del contenido para obtener detalles. Debe pasarse como un parámetro de URL. |
8. Obtener mis videos
Obtiene una lista de videos que has creado. A continuación, los parámetros de consulta para filtrar los datos.
GEThttps://api.vuela.ai/my-videos
| Parámetro | Requerido | Tipo | Descripción |
|---|---|---|---|
| page | Opcional | Número | Número de página a obtener |
| limit | Opcional | Número | Número de videos por página |
| search | Opcional | Cadena | Término de búsqueda para campos relevantes de video |
9. Detalles del video
Obtiene los detalles de un video. Reemplaza videoId en la URL con el ID real del video.
GEThttps://api.vuela.ai/my-videos/{videoId}
| Parámetro | Requerido | Tipo | Descripción |
|---|---|---|---|
| videoId | Requerido | Cadena | ID del video para obtener detalles. Debe pasarse como un parámetro de URL. |
10. Consumo de créditos
Para usar Vuela's API, debes tener créditos en tu cuenta. Nuestro sistema de créditos garantiza un uso justo y ayuda a mantener la calidad de nuestros servicios.
Ten en cuenta: En caso de error en la API o si Vuela no se puede generar contenido, no se te cobrarán créditos. Solo se descuentan créditos por operaciones exitosas que entregan contenido.