GET /job/{job_id}
Propósito
Este endpoint recupera o status atual e o resultado de um job assíncrono. Você pode verificar o status de jobs como geração de imagem, upscaling, inpainting e separação de camadas através do ID do job (job_id).
Método e Caminho
- HTTP Method:
GET - Path:
/public/v1/job/{job_id}
Autenticação
Este endpoint requer autenticação Bearer Token. Consulte o Guia de Autenticação para mais detalhes.
Cabeçalhos Obrigatórios:
Authorization: Bearer {your_api_key}
Campos da Requisição
Parâmetros de Caminho
| Nome do Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
job_id | UUID | Obrigatório | Identificador único do job a ser consultado (formato UUID) |
Resposta
GetJobStatusResponse
| Nome do Campo | Tipo | Descrição |
|---|---|---|
job_id | UUID | Identificador único do job |
status | string | Status do job. Valores possíveis: Pending, Succeed, Failed |
image_urls | list[string] | Lista de URLs de imagens concluídas. Incluído apenas quando o job é bem-sucedido |
Valores de Status
- Pending: O job está em andamento ou aguardando
- Succeed: O job foi concluído com sucesso
- Failed: Ocorreu um erro durante o processamento do job
Regras de Erro / Validação
| Código HTTP | Situação de Erro | Descrição |
|---|---|---|
401 Unauthorized | Falha de autenticação | Chave de API inválida ou cabeçalho de autenticação ausente |
404 Not Found | Job não encontrado | Nenhum job encontrado para o job_id fornecido |
422 Unprocessable Entity | Formato de job_id inválido | job_id deve ser um UUID válido |
Comportamento do Job Assíncrono
Este endpoint é usado para consultar o status de jobs assíncronos. Os endpoints de criação de jobs (por exemplo, /image-tune/upscale) retornam imediatamente um job_id, e o processamento real ocorre em segundo plano.
Estratégia de Polling:
- Após receber o
job_idda criação do job, faça polling neste endpoint para verificar o status - O status inicial é
Pending - Quando o job é concluído, o
statusmuda paraSucceede oimage_urlscontém as URLs das imagens resultantes - Se o job falhar, o
statusmuda paraFailed - Intervalo de polling recomendado: 1-2 segundos
Exemplo de Requisição
cURL
curl -X GET "https://api.aetherforgeai.com/public/v1/job/550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer YOUR_API_KEY"
Exemplo de Resposta (Sucesso - Pending)
{
"job_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "Pending",
"image_urls": []
}
Exemplo de Resposta (Sucesso - Concluído)
{
"job_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "Succeed",
"image_urls": ["https://cdn.aetherforgeai.com/images/generated_abc123.png"]
}
Exemplo de Resposta (Falha)
{
"job_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "Failed",
"image_urls": []
}