Ir para o conteúdo principal

Modelos de Resposta Compartilhados

Esta página descreve os schemas de resposta compartilhados usados na API Aether.

JobIdResponse​

Retornado por todos os endpoints POST que criam jobs assíncronos.

Schema​

CampoTipoDescrição
job_idstring (UUID)Identificador único do job criado

Exemplo​

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

Endpoints que Usam​

  • POST /public/v1/generate/image
  • POST /public/v1/generate/effect/v1
  • POST /public/v1/generate/effect/v2
  • POST /public/v1/image-tune/upscale

GetJobStatusResponse​

Retornado pelo endpoint de consulta de status do job.

Schema​

CampoTipoObrigatórioDescrição
job_idstring (UUID)SimIdentificador único do job
statusstringSimStatus do job (Pending, Succeed, Failed)
image_urlsarray[string]NãoLista de URLs de imagens concluídas (fornecido apenas no status Succeed)

Exemplos de Resposta por Status​

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 que Usam​

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

Documentação Relacionada​