Saltar al contenido principal

Modelos de Respuesta Compartidos

Describe los esquemas de respuesta compartidos usados en la API de Aether.

JobIdResponse​

Devuelto por todos los endpoints POST que crean trabajos asíncronos.

Esquema​

CampoTipoDescripción
job_idstring (UUID)Identificador único del trabajo creado

Ejemplo​

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000"
}

Endpoints Utilizados​

  • POST /public/v1/generate/image
  • POST /public/v1/generate/effect/v1
  • POST /public/v1/generate/effect/v2
  • POST /public/v1/image-tune/upscale
  • POST /public/v1/image-tune/inpaint/v1
  • POST /public/v1/image-tune/inpaint/v2
  • POST /public/v1/image-tune/remove-background
  • POST /public/v1/image-tune/equip-variation
  • POST /public/v1/sprite/lite
  • POST /public/v1/sprite/plus
  • POST /public/v1/sprite/zenith
  • POST /public/v1/sprite/pulsar

GetJobStatusResponse​

Devuelto por el endpoint de consulta de estado del trabajo.

Esquema​

CampoTipoRequeridoDescripción
job_idstring (UUID)SíIdentificador único del trabajo
statusstringSíEstado del trabajo (Pending, Succeed, Failed)
image_urlsarray[string]NoLista de URLs de imágenes completadas (solo se proporciona en estado Succeed)

Ejemplos de Respuesta por Estado​

Pending​

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Pending",
  "image_urls": []
}

Succeed​

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Succeed",
  "image_urls": ["https://cdn.aetherforgeai.com/images/abc123.png"]
}

Failed​

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Failed",
  "image_urls": []
}

Endpoints Utilizados​

  • GET /public/v1/job/{job_id}

Documentación Relacionada​