Saltar al contenido principal

Endpoints

MétodoEndpointDescripción
POST/api/v1/generateTask/seedream-5-0Crear tarea de generación
GET/api/v1/statusTask/seedream-5-0Consultar estado de la tarea

Autenticación

Todas las solicitudes requieren una clave de API en el encabezado:
Authorization: Bearer YOUR_API_KEY

Cuerpo de la solicitud

{
  "request_type": "async",
  "callback_url": "https://...",
  "provider": "auto",
  "input": {
    "mode": "text-to-image",
    "prompt": "...",
    "max_images": 4,
    "resolution": "2K",
    "aspect_ratio": "16:9",
    "sequential_image_generation": "disabled",
    "web_search": false,
    "output_format": "jpeg",
    "image_urls": ["..."]
  }
}

Parámetros

request_type
string
predeterminado:"async"
async (polling) o callback (webhook)
callback_url
string
URL de callback, requerida cuando request_type=callback (condicional)
provider
string
predeterminado:"auto"
Estrategia de enrutamiento: auto, value u official
input
object
requerido
Parámetros de entrada del modelo
Opciones de modo:
  • text-to-image — Generar desde descripción de texto
  • image-to-image — Generar con imágenes de referencia
Generación secuencial:
  • disabled — Imágenes independientes
  • auto — Generar imágenes secuenciales con continuidad según max_images

Ejemplo

Text-to-Image
curl -X POST "https://api.apixo.ai/api/v1/generateTask/seedream-5-0" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "request_type": "async",
    "provider": "value",
    "input": {
      "mode": "text-to-image",
      "prompt": "a cozy cyberpunk cafe with neon lights, ultra detailed",
      "max_images": 4,
      "resolution": "2K",
      "aspect_ratio": "16:9",
      "sequential_image_generation": "disabled",
      "output_format": "jpeg"
    }
  }'
Image-to-Image (múltiples referencias)
curl -X POST "https://api.apixo.ai/api/v1/generateTask/seedream-5-0" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "request_type": "async",
    "provider": "official",
    "input": {
      "mode": "image-to-image",
      "prompt": "make this scene look like sunrise with warm colors",
      "max_images": 3,
      "resolution": "3K",
      "aspect_ratio": "3:4",
      "sequential_image_generation": "auto",
      "output_format": "png",
      "image_urls": [
        "https://example.com/ref1.jpg",
        "https://example.com/ref2.jpg"
      ]
    }
  }'
Búsqueda web habilitada
curl -X POST "https://api.apixo.ai/api/v1/generateTask/seedream-5-0" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "request_type": "async",
    "provider": "value",
    "input": {
      "mode": "text-to-image",
      "prompt": "latest flagship smartphone design trends 2024",
      "max_images": 1,
      "resolution": "2K",
      "web_search": true,
      "output_format": "jpeg"
    }
  }'

Respuesta

POST /api/v1/generateTask/seedream-5-0

Devuelve taskId en caso de éxito. Éxito:
{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678"
  }
}
Error:
{
  "code": 400,
  "message": "Insufficient credits",
  "data": null
}

GET /api/v1/statusTask/seedream-5-0

Consulta el estado de ejecución y resultados vía taskId.
curl -X GET "https://api.apixo.ai/api/v1/statusTask/seedream-5-0?taskId=task_12345678" \
  -H "Authorization: Bearer YOUR_API_KEY"
Éxito:
{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678",
    "state": "success",
    "resultJson": "{\"resultUrls\":[\"https://r2.apixo.ai/img1.png\",\"https://r2.apixo.ai/img2.png\"]}",
    "createTime": 1767965610929,
    "completeTime": 1767965652317,
    "costTime": 41388
  }
}
Fallido:
{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678",
    "state": "failed",
    "failCode": "CONTENT_VIOLATION",
    "failMsg": "Content does not meet safety guidelines",
    "createTime": 1767965610929,
    "completeTime": 1767965652317,
    "costTime": 41388
  }
}

Campos de respuesta de estado

taskId
string
Identificador único de la tarea.
state
string
Estado actual: pending, processing, success o failed.
resultJson
string
Cadena JSON que contiene el array resultUrls. Solo presente en éxito. Parsea con JSON.parse().
failCode
string
Código de error. Solo presente cuando state es failed. Consulta Códigos de error.
failMsg
string
Mensaje de error legible. Solo presente cuando state es failed.
createTime
integer
Marca temporal de creación (Unix milisegundos).
completeTime
integer
Marca temporal de finalización (Unix milisegundos).
costTime
integer
Duración del procesamiento en milisegundos.

Códigos de error

CódigoDescripción
400Parámetros inválidos o error de solicitud
401Clave de API inválida o ausente
429Límite de tasa superado
Código de falloDescripción
CONTENT_VIOLATIONEl contenido viola directrices de seguridad
INVALID_IMAGE_URLNo se puede acceder a la URL de imagen proporcionada

Límites de tasa

LímiteValor
Solicitudes60 / minuto
Tareas simultáneas10
Superar los límites devuelve error 429. Espera y reintenta.

Consejos

  • Tiempo de generación: 2K ~25-35s, 3K ~35-50s. Espera 20s y consulta cada 3s.
  • Modo callback: Para alta concurrencia o alta resolución, usa modo callback.
  • Caducidad: URLs válidas 15 días.
  • Moderación: Violaciones devuelven CONTENT_VIOLATION.
  • Resolución: Seedream 5.0 soporta 2K y 3K.
  • Búsqueda web: web_search: true para información en tiempo real; ideal para temas de actualidad.
  • Formato de salida: jpeg (por defecto) o png.
  • Generación por lotes: max_images 1-10, facturación por imagen generada.
  • Imágenes secuenciales: disabled independientes, auto con continuidad.
  • Fusión de referencias: Hasta 14 imágenes en image-to-image.
  • Proporciones: 16:9/21:9 apaisado, 9:16 retrato, 1:1 cuadrado.
  • Formatos: image_urls soporta JPG, PNG, WebP, GIF, máx. 10MB por imagen.

Las URLs de resultado caducan tras 15 días. Descarga y almacena salidas importantes con prontitud.

Relacionado