Skip to main content

Códigos de Erro do HappyOyster

Estrutura de resposta e códigos de erro da Open API do HappyOyster, incluindo códigos de negócio, cenários típicos e sugestões de tratamento.

Este documento descreve a estrutura de resposta e os códigos de erro da Open API do HappyOyster. Aplica-se a todos os endpoints da Open API dos modelos Adventure, Directing e Acting.

Estrutura da resposta

Depois que uma solicitação passa pela autenticação do gateway (tanto para sucesso quanto para erros de negócio), a resposta sempre retorna HTTP 200 com a seguinte estrutura JSON como corpo:
{
  "code": 0,
  "message": null,
  "data": {}
}
CampoTipoDescrição
codeintegerCódigo de retorno de negócio. 0 significa sucesso; um valor diferente de0 significa um erro de negócio — veja a lista de códigos de erro abaixo.
messagestring | nullMensagem de erro legível por humanos. null quando code=0.
dataobject | nullPayload de negócio. Em caso de sucesso, contém o objeto de resposta específico do endpoint; em caso de erro, geralmente null.
Falhas na camada de gateway, como verificação de AK, assinatura ou timestamp, são rejeitadas diretamente, portanto, essas respostas não seguem esta estrutura e geralmente são retornadas com um código de status HTTP 4xx / 5xx — veja Código de erro.

Lista de códigos de erro

códigoDescriçãoCenários típicos e tratamento
0SuccessSolicitação bem-sucedida; leia data.
400000Parâmetros de solicitação inválidosmode não corresponde ao modelo atual; prompt ou firstFrameImage está ausente; prompt é muito longo; creationModel / uploadMode / resolution / aspectRatio / perspective tem um valor ilegal; o formato da imagem ou do ID criptografado é inválido. Corrija os parâmetros conforme a documentação da API e tente novamente.
400001Falha ao buscar ou armazenar URL da imagemA URL da imagem do primeiro quadro ou de referência está inacessível ou expirada. Verifique a acessibilidade e a validade da URL e tente criar o Mundo novamente.
401010ticket inválido ou expiradoEntrar na travel (enter-travel). Chame get-travel-credential novamente para obter um novo ticket.
401011ticket já usadoEntrar na travel. O ticket é de uso único; obtenha um novo.
403001O Mundo não existe, foi excluído, não pertence a você ou não pertence ao modelo atualConsulta, troca de credenciais, entrada na viagem e filtragem de listas. Na exclusão, este código é retornado apenas para IDs entre contas, entre workspaces ou entre modelos; um ID já inexistente na mesma conta retorna code=0, deleted=false.
403002O Mundo não está ready ou indisponívelTroca de credenciais, entrar na travel. Consulte o status da compilação até ready antes de operar.
403003Este endpoint permite apenas a API Key primáriaGerenciamento de Mundo, lista de Travel, artefatos, etc. Chame com a API Key primária (começa com sk-).
403004O conteúdo de entrada falhou na política de segurança de conteúdoCriar Mundo, enviar instruct. Ajuste o conteúdo de texto e tente novamente.
403005A imagem de entrada falhou na verificação de direitos autorais ou propriedade intelectualCriar Mundo. Substitua por uma imagem compatível e tente novamente.
403007Cota de recurso ou serviço não habilitadaCriar, troca de credenciais, entrar na travel. Confirm se a capacidade correspondente do modelo está habilitada.
403008Configuração de capacidade temporariamente indisponívelCriação, troca de credenciais, entrada na viagem. Tente novamente mais tarde ou entre em contato com o provedor de serviços para aumentar a capacidade.
404000A viagem não existe, não pertence a você, não pertence ao modelo atual ou não possui artefatos disponíveisConsulta de status da Travel, controle, encerramento, consulta de artefatos.
409000A solicitação entra em conflito com o estado atual do recursoEndpoints de controle como pausar, retomar, encerrar e instruir; também retornado ao chamar um endpoint que um modelo não suporta.
429001A concorrência para a especificação atual está cheiaEntrar na viagem. Tente novamente mais tarde ou aumente a especificação de concorrência.
429002Capacidade disponível insuficienteEntrar na travel. Tente novamente mais tarde.
500000Erro interno do sistemaExceções não classificadas; também podem ser retornadas ao chamar um endpoint não suportado (por exemplo, rewind em alguns modelos).
500001Falha ao alocar recursos de streamingEntrar na travel. Tente novamente mais tarde.
O acesso entre modelos não revela se o recurso existe: os endpoints de World retornam code=403001 e os endpoints de Travel retornam code=404000.

errorCode de falha da Travel

Ao consultar o status da Travel ou a lista de Travels, itens com status=failed carregam adicionalmente o campo estruturado errorCode e uma descrição em inglês errorMessage (consulte a documentação da API correspondente para a estrutura de resposta de falha). O texto de errorMessage para o mesmo errorCode pode diferir entre os endpoints de consulta e a resposta de Encerrar Travel; faça a ramificação com base em errorCode, não em errorMessage.
errorCodeerrorMessageDescrição
TRAVEL_SESSION_INIT_FAILEDFailed to allocate inference resources.A sessão de inferência falhou ao inicializar ao entrar na travel, geralmente devido a recursos de inferência insuficientes
TRAVEL_NO_STREAM_AUTO_ENDNo video stream was received before timeout.O cliente não recebeu o stream antes do tempo limite; encerre a Travel passando failCode na solicitação de Encerrar Travel
TRAVEL_STREAM_CREATE_FAILEDFailed to create the video stream.Falha ao criar o canal de streaming
CONTENT_VIDEO_MODERATION_REJECTEDSomething went wrong.A imagem da experiência foi interrompida pela política de segurança de conteúdo
TRAVEL_RUNTIME_FAILEDThe experience was interrupted by a runtime error.Outras falhas de tempo de execução, ou o servidor não registrou um motivo específico
Qualquer errorCode não listado pode ser tratado como uma falha desconhecida.