Documentação

Referência da API

Tentar arquivar arquivo novamente

POST/v1/files/{file_id}/retry

Arquivos históricos da mesma conta e chave; permite chaves válidas com cota esgotada, mas rejeita revogadas/expiradas. Download exige ready; exclusão com referências retorna 409. retry só salva o original, sem regenerar. API comum por dias; tarefas persistentes protegem referências; expires_at=0 indica ausência de expiração fixa.

Recuperação após falha ao salvar

Confira primeiro espaço disponível e causa do erro. Esta operação solicita capacidade novamente e arquiva o resultado original; não chama o serviço de geração outra vez nem altera a cobrança da tarefa. Se a origem original expirou, a nova tentativa ainda pode falhar.

Gerencie arquivos protegidos por referências de tarefas persistentes pelo ciclo de vida da tarefa; não exclua arquivos referenciados para liberar espaço. Confira cobrança e armazenamento separadamente; consulte Faturamento.

Autenticação e permissões

Use sua chave atual do GloopAPI. Modelos, recursos e permissões disponíveis dependem do catálogo da chave e da documentação do endpoint.

Authorization: Bearer $GLOOP_API_KEY

Esquemas de autenticação: BearerAuth

Solicitação

Parâmetros de caminho

  • file_idstringObrigatório

    ID público de arquivo gerenciado da mesma chave.

Respostas e erros

HTTP 200

Nova tentativa de arquivamento de arquivo realizada com sucesso

application/json

Tipo
object
Campos obrigatórios
idsource_kindsource_indexmodelstatusmime_typefile_namesize_bytescreated_atupdated_atexpires_at
  • idstringObrigatório

    Identificador público do objeto, usado na sua rota de detalhes.

  • source_kindstringObrigatório

    Categoria de origem do arquivo; determina ciclo de vida e proteção por referências.

  • source_indexintegerObrigatório

    Índice do resultado de origem.

  • modelstringObrigatório

    ID público do modelo no catálogo da chave atual.

  • statusstringObrigatório

    Etapas de armazenamento em segundo plano, como waiting/pending/archiving/ready/failed/deleting; URL de download só é obtida após ready.

  • mime_typestringObrigatório

    Tipo MIME verificado do arquivo.

  • file_namestringObrigatório

    Nome público do arquivo baixado.

  • sha256stringOpcional

    SHA-256 do conteúdo arquivado, se conhecido.

  • size_bytesintegerObrigatório

    Tamanho do arquivo em bytes.

  • error_codestringOpcional

    Código público de erro para decisões de fluxo.

  • created_atintegerObrigatório

    Data de criação em segundos Unix.

  • updated_atintegerObrigatório

    Última atualização em segundos Unix.

  • expires_atintegerObrigatório

    Segundos Unix; 0 indica retenção prolongada. A API comum segue os dias configurados; imagens/vídeos persistentes protegem resultados por referências. A exclusão preserva cobrança e idempotência.

HTTP 400

Campos ou parâmetros de solicitação inválidos.

application/json

Tipo
object
Campos obrigatórios
error

HTTP 401

A chave está ausente, inválida, expirada ou revogada.

application/json

Tipo
object
Campos obrigatórios
error

HTTP 403

Permissões insuficientes de IP, conta, modelo ou ferramenta.

application/json

Tipo
object
Campos obrigatórios
error

HTTP 404

Objeto/recurso indisponível ou função desativada.

application/json

Tipo
object
Campos obrigatórios
error

HTTP 409

Conflito de idempotência/cotação, objeto não pronto ou ainda referenciado.

application/json

Tipo
object
Campos obrigatórios
error

HTTP 429

Limite de solicitações/fila.

application/json

Tipo
object
Campos obrigatórios
error

HTTP 500

Falha interna de autenticação ou armazenamento de dados.

application/json

Tipo
object
Campos obrigatórios
error

HTTP 503

Serviço, preços ou armazenamento indisponíveis.

application/json

Tipo
object
Campos obrigatórios
error
Pronto para criar? Abra console para criar uma chave de API, ou explore recursos.