Arquivos

Um asset é um item da biblioteca: arquivo ou vídeo. O mesmo objeto nunca contém as duas variantes preenchidas. A criação reserva um envio direto; depois de enviar o conteúdo, confirme o upload e acompanhe o processamento até ready.

Objeto completo

Formato retornado pelas consultas e pelos itens das listagens. Os campos de retorno não são todos editáveis; confira as regras de escrita abaixo.

{
  "id": "ast_1234567890abcdef",
  "created_at": "2030-01-01T00:00:00.000Z",
  "description": null,
  "file": {
    "checksum": null,
    "filename": "material.pdf"
  },
  "metadata": {},
  "mime_type": "application/pdf",
  "object": "asset",
  "size_bytes": null,
  "status": "uploading",
  "title": "Material de apoio",
  "type": "file",
  "updated_at": "2030-01-01T00:00:00.000Z",
  "video": null
}

Variante de vídeo

Em um vídeo, file é null e video contém os dados de processamento. Os campos desconhecidos podem ser null durante o envio.

{
  "id": "ast_1234567890abcdef",
  "created_at": "2030-01-01T00:00:00.000Z",
  "description": null,
  "file": null,
  "metadata": {},
  "mime_type": null,
  "object": "asset",
  "size_bytes": 104857600,
  "status": "ready",
  "title": "Aula de introdução",
  "type": "video",
  "updated_at": "2030-01-01T00:00:00.000Z",
  "video": {
    "duration_seconds": 600,
    "height": 1080,
    "progress": 100,
    "width": 1920
  }
}

Campos do objeto

string

Identificador público estável. Use o valor retornado pela API nas consultas e relacionamentos; não derive IDs de nomes.

string

Data e hora da criação, em ISO 8601 com fuso horário. Somente leitura.

string | null

Descrição do item. Pode ser null; envie null para limpar.

object | null

Detalhes do arquivo quando type é file. Null para vídeos. Somente leitura.

Show Campos de file

string | null

Checksum do arquivo, quando disponível; null quando não informado.

string

Nome original do arquivo, incluindo a extensão.

object

Objeto JSON livre para referências da integração, limitado a 16 KB. Ao enviar, substitui todo o metadata anterior; use {} para limpar. Não aceita null.

string | null

Tipo MIME do arquivo, como application/pdf. Pode ser null. Informado no início do upload de arquivo; não é editável depois.

string

Tipo do objeto retornado. O valor é fixo para este recurso.Sempre asset.

integer | null

Tamanho do conteúdo em bytes, preenchido pela verificação/processamento. Pode ser null enquanto desconhecido. Somente leitura.

string

Estado do envio: uploading, processing, ready ou failed. deleted indica exclusão; itens excluídos não aparecem nas consultas normais. Somente leitura.Valores: uploading, processing, ready, failed, deleted.

string

Título do item na biblioteca. Obrigatório na criação, não vazio e com até 300 caracteres no início do upload.

string

Variante do conteúdo: file ou video. Definida pela operação de criação e não editável.Valores: file, video.

string

Data e hora da última alteração, em ISO 8601 com fuso horário. Somente leitura.

object | null

Detalhes do vídeo quando type é video. Null para arquivos. Somente leitura.

Show Campos de video

integer | null

Duração do vídeo em segundos; null enquanto desconhecida.

integer | null

Altura do vídeo em pixels; null enquanto desconhecida.

number | null

Percentual de processamento informado, de 0 a 100; pode ser null.

integer | null

Largura do vídeo em pixels; null enquanto desconhecida.

Criação e alterações

Use Iniciar upload de arquivo com title e filename, ou Iniciar upload de vídeo com title. A resposta é o objeto asset completo, acrescido do campo upload com a credencial de envio. Siga o fluxo de upload e download. Depois de criado, apenas description, metadata e title são editáveis. O tipo e os dados de processamento são preenchidos pela Hubfy. Downloads privados exigem um arquivo pronto e devolvem uma URL válida por uma hora. Excluir marca o item como removido e agenda a limpeza do conteúdo. Campos omitidos em uma atualização são preservados. metadata substitui o objeto inteiro quando enviado. Campos desconhecidos são rejeitados.

Relacionamentos

file e video são partes do mesmo asset, não recursos independentes. O vínculo de entrega com produtos e cursos é administrado no painel.

Eventos

Envio, confirmação e processamento podem gerar asset.updated. Eventos descrevem mudanças efetivas no objeto público. Repetir uma operação sem alterar o objeto não garante um evento. Confira entrega e assinatura.

Fundamentos da API

Objetos

Webhooks e eventos

Objeto completo

Variante de vídeo

Campos do objeto

Criação e alterações

Relacionamentos

Eventos

​Objeto completo

​Variante de vídeo

​Campos do objeto

​Criação e alterações

​Relacionamentos

​Eventos

Objeto completo

Variante de vídeo

Campos do objeto

Criação e alterações

Relacionamentos

Eventos