Skip to main content

Inicio rápido

El endpoint nativo de imágenes es síncrono por defecto. Establece el booleano async en true para crear una tarea en segundo plano. El ejemplo usa qwen-image-2.0.

Cómo descubrir modelos multimedia asíncronos y obtener sus esquemas

El proceso de descubrimiento tiene dos pasos. Primero, obtén del catálogo público los modelos de texto a imagen o texto a video compatibles con las API asíncronas. Después, usa el model_id del modelo para obtener el esquema de solicitud de sus endpoints.

Listar modelos compatibles con las API asíncronas

El catálogo de modelos usa la misma fuente de datos que Playground. Usa type=image_generation para los modelos de texto a imagen y type=video para los modelos de texto a video. Al añadir schema_checked=true, la lista se limita a los modelos cuyo esquema de solicitud se ha publicado y revisado.
Ambas solicitudes usan el mismo endpoint. El filtro type acepta actualmente un solo valor, por lo que debes solicitar cada tipo de modelo por separado. La respuesta tiene la forma {success, message, data}. Los siguientes campos de data son relevantes para las integraciones multimedia asíncronas.

Obtener el esquema de solicitud de un modelo

Los campos, las enumeraciones y los rangos numéricos compatibles pueden variar según el modelo. Antes de enviar una solicitud de imagen o video, usa el siguiente endpoint público para obtener los endpoints disponibles y los esquemas JSON de solicitud del modelo seleccionado.
El valor de modality en la respuesta es image o video. Cada elemento del array endpoints describe un protocolo de llamada disponible. Un modelo puede devolver endpoints /ai/v1 y endpoints /v1 compatibles con OpenAI. Es posible que los endpoints compatibles con OpenAI todavía no admitan los modelos más recientes, por lo que se recomienda usar primero los endpoints /ai/v1. Para las API de tareas asíncronas, selecciona el elemento cuyo path sea /ai/v1/images/generations o /ai/v1/videos y utiliza su request.schema. No dependas de la posición de un elemento en el array endpoints. Los siguientes comandos extraen directamente el esquema de solicitud de cada endpoint de tareas asíncronas.
El endpoint devuelve 404 model_not_found si el modelo no existe o no tiene endpoints detectables. Devuelve 500 endpoints_unavailable cuando los datos de los endpoints no están disponibles temporalmente.

Cómo crear tareas de imagen

Imágenes síncronas

Cuando se omite async o se establece en false, el endpoint espera a que finalice la generación y devuelve un objeto de tarea:
Las tareas de imagen síncronas también guardan un registro de tarea. Si se interrumpe la conexión del cliente o se pierde la respuesta de creación, usa GET /ai/v1/images para encontrar la tarea correspondiente.

Imágenes asíncronas

Cuando async se establece en el valor booleano true, el endpoint devuelve inmediatamente un objeto de tarea y la generación continúa en segundo plano:
Usa GET /ai/v1/images/{id} para consultar una tarea de imagen asíncrona. Cuando termine, solicita directamente el content_url de cada elemento de output; esta URL ya contiene el result_id de la imagen correspondiente.
async en una solicitud de imagen debe ser un valor booleano. webhook_url y webhook_events_filter solo pueden usarse con async: true.

Campos estándar de imagen


Objeto de tarea multimedia

Los endpoints específicos de imagen y video devuelven la siguiente estructura:
Elemento output multimedia:

Estados de tarea

Los clientes pueden consultar el estado cada 15 segundos hasta que cambie a completed, failed o cancelled. Los 15 segundos son una recomendación de sondeo para el cliente, no un límite del protocolo del servidor.

Cómo consultar tareas multimedia

Consultar detalles multimedia

Los endpoints de detalles multimedia pueden devolver un estado actualizado de la tarea. Por ello, el sondeo multimedia debe usar el endpoint de detalles de imagen o video correspondiente.

Consultar la lista de tareas multimedia

Si se pierde la respuesta de creación, puedes recuperar el ID de la tarea mediante la lista multimedia correspondiente:
Las listas multimedia devuelven instantáneas de las tareas en el momento de la consulta y no actualizan activamente su estado.

Cómo usar el endpoint de tareas unificadas

El endpoint de tareas unificadas admite los siguientes filtros:
Detalles de una tarea unificada:
Elemento output unificado de una tarea multimedia:
Para una tarea de un solo artefacto, solicita directamente /ai/v1/tasks/{id}/content. Para una tarea con varios artefactos, solicita /ai/v1/tasks/{id}/content/{result_id}. Si no se especifica el ID del resultado, se devuelve 400 result_id_required.
Los endpoints de lista, detalles y contenido de tareas unificadas están aislados por el Bearer Token usado para crear la tarea. Otras API Keys de la misma cuenta no pueden leerla.

Cómo descargar resultados multimedia

Descargar imágenes

Cuando termine la tarea de imagen, solicita cada output[].content_url del objeto de tarea multimedia:
La ruta de descarga multimedia de imágenes es /ai/v1/images/{id}/content/{result_id}. El objeto de tarea multimedia no expone result_id por separado, por lo que el cliente puede usar directamente content_url. Cuando b64_json no esté vacío, puede descodificarse directamente desde Base64.

Cómo usar Webhooks

Las imágenes y los videos asíncronos admiten Webhooks a nivel de tarea:
webhook_url admite hasta 512 caracteres y no puede apuntar a localhost, redes privadas ni otras direcciones restringidas. Cuando se omite webhook_events_filter, la plataforma envía completed, failed y cancelled. Cuando se proporciona explícitamente, la matriz no puede estar vacía ni contener duplicados, y debe usarse junto con webhook_url. Cuando la solicitud no incluye webhook_url, las imágenes y los videos asíncronos intentan usar la URL de devolución de llamada predeterminada configurada en la cuenta. Una URL predeterminada no válida se ignora y no impide la creación de la tarea.

Solicitud de devolución de llamada

results solo aparece cuando los resultados se han archivado. Las descargas siguen requiriendo un Bearer Token.

Reintentos y deduplicación

La plataforma usa una entrega al menos una vez, por lo que el mismo evento puede entregarse más de una vez:
  • HTTP 2xx indica que se recibió correctamente.
  • HTTP 5xx, los errores de red o los tiempos de espera agotados activan un reintento.
  • HTTP 3xx y 4xx no se vuelven a intentar.
  • Se realizan hasta 6 intentos de entrega, con intervalos de 1, 4, 16, 64 y 256 segundos.
El receptor debe guardar event_id y devolver 2xx inmediatamente cuando vuelva a recibir el mismo evento.
Los Webhooks a nivel de tarea no incluyen una clave de firma independiente. Si se requiere verificar la firma, configura una suscripción de Webhook a nivel de cuenta y conserva la consulta de detalles de la tarea como método para confirmar los resultados.

Respuestas y códigos de error

Esta sección se aplica a /ai/v1/images/* y a las tareas de imagen. Para los errores de vídeo, consulta la API de vídeo.
  • Fallo de la solicitud actual: un estado HTTP distinto de 2xx indica que ha fallado la creación, consulta o descarga actual. Consulta Fallos de solicitudes HTTP.
  • Fallo de ejecución de la tarea: la consulta devuelve HTTP 200, pero la tarea tiene status=failed y el motivo aparece en su campo error. Consulta Fallos de ejecución de tareas.
  • Fallo al leer el resultado de una entrada: la lista devuelve HTTP 200, pero una tarea incluye output_error. Consulta Fallos al leer resultados individuales.
La columna message muestra el texto en inglés devuelto por la API; la columna de explicación describe su significado y cómo actuar. Los errores de validación muestran mensajes generales; la respuesta real puede precisar los campos y las restricciones. Usa code para identificar el tipo de error, sin depender de una coincidencia exacta con el texto completo de message.

Notificar un error HTTP 5xx

Si la solicitud devuelve HTTP 5xx, envía un informe e incluye error.tid.

Fallos de solicitudes HTTP

Los estados HTTP de las tablas siguientes corresponden al fallo de la solicitud actual. Los fallos de ejecución de tareas ya creadas se describen en la tabla de fallos de ejecución de tareas.

Parámetros de la solicitud y medios de entrada

Límites de tamaño
  • Tamaño del medio: las tareas de imagen que superan el límite devuelven image_too_large. Consulta el límite en el mensaje de error o en error.details.max_bytes.
  • Tamaño total de la solicitud: request_too_large indica que el cuerpo HTTP supera los 32 MiB, incluidos el texto, los parámetros y los medios codificados. Si solo envías una URL, el enlace cuenta como parte del cuerpo; el archivo de destino debe seguir cumpliendo los límites multimedia del modelo.
  • Tamaño real: error.details.actual_bytes solo se incluye cuando se conoce el tamaño completo. Puede omitirse si la lectura de una URL se detiene al alcanzar el límite de lectura.
Formatos compatibles Dependen del modelo seleccionado. Consulta primero error.details.allowed_mime_types o la lista de formatos del mensaje de error. Si no hay lista, consulta el Schema del modelo. Marcadores de posición de los mensajes
  • {media_kind}: tipo real de medio. Cuando se conoce, los mensajes de invalid_media_data y media_url_unreachable también usan image o video.
  • {max_bytes}: límite en bytes. Si no se conoce el límite de la imagen, el mensaje es The image is too large. Reduce the image size and try again.
  • {allowed_formats}: lista de formatos permitidos. Los errores de formato pueden añadir Use one of: {allowed_formats}.

Solicitudes de generación y resultados devueltos

Cuenta y permisos

Disponibilidad del servicio y límites de solicitudes

provider_unavailable indica un fallo confirmado del proveedor de modelos. Un estado genérico 429 o 4xx no permite identificar por sí solo problemas de cuota, moderación de contenido o parámetros.

Consulta de tareas y descarga de resultados

Fallos de ejecución de tareas

Cuando una tarea ya creada falla durante la generación, se indica mediante status=failed y el campo error de la tarea. Una consulta correcta sigue devolviendo HTTP 200.
Los errores de medios de entrada también pueden aparecer en una Task fallida y tienen el mismo significado que en la tabla anterior. Una consulta correcta sigue devolviendo HTTP 200. El message de los errores de tamaño termina en submit a new task., indicando que debes reducir el tamaño y enviar una nueva tarea. output_blocked indica un bloqueo confirmado sin imagen utilizable; esta generación no se cobra. Para output_policy_violation se aplican las reglas de cobro existentes para moderación. Consulta los registros de facturación para los cargos anteriores.

Fallos al leer resultados individuales

Algunas entradas de las listas de tareas de imagen y vídeo pueden incluir output_error:
Este campo indica que no se pudo leer el resultado de esa entrada en esta consulta. La lista sigue devolviendo HTTP 200 y esa entrada tiene output=[]. Se conservan su id, status, error y la paginación, y las demás tareas legibles no se ven afectadas. Comprueba output_error incluso con status=completed antes de considerar disponible el resultado. Contacta con soporte e indica output_error.tid. Si el campo no incluye tid, proporciona el ID de solicitud de las cabeceras de la respuesta actual. Este error no cambia el estado de la tarea ni los cargos y no activa un Webhook. Las listas de imágenes y vídeos conservan el expires_at obtenido. Las entradas con errores de lectura en la lista unificada /ai/v1/tasks pueden devolver expires_at=null; los resultados siguen sujetos al periodo de conservación original. Este tratamiento solo se aplica cuando no se puede leer el resultado de una entrada y no hay una alternativa disponible. Un fallo de consulta de todo el lote en la API unificada de tareas sigue devolviendo un error HTTP; el mismo fallo al consultar detalles sigue devolviendo HTTP 500. Documentación relacionada: API de imágenes · API de vídeo · Tareas asíncronas

Ejemplo completo

Estos ejemplos crean una tarea asíncrona, la consultan y guardan todas las imágenes devueltas.