Documentação

Referência da API

Consultar recursos do espaço de vídeo

GET/v1/video-models

Retorna presets executáveis e limites de quadros por modo; use presets completos, sem misturar parâmetros entre modos.

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

Respostas e erros

HTTP 200

Recursos do espaço de vídeo consultados com sucesso

application/json

Tipo
object
Campos obrigatórios
dataworkspace_enabledupload_enabledfile_storage_enabled
  • dataarrayObrigatório

    Array de dados da página/catálogo atual.

    Campos filhos de data (1)
    • []objectOpcional
      Campos filhos de [] (6)
      • idstringObrigatório

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

      • namestringObrigatório

        Nome legível para o usuário.

      • capability_versionstringObrigatório

        Versão dos recursos do modelo público.

      • modesarrayObrigatório

        Modos executáveis e suas combinações completas de parâmetros.

        Campos filhos de modes (1)
        • []objectOpcional
          Campos filhos de [] (9)
          • modestringObrigatório

            Modo de execução.

          • presetsarrayObrigatório

            Combinações completas executáveis; não forme produtos cartesianos entre combinações.

            Campos filhos de presets (1)
            • []objectOpcional
              Campos filhos de [] (4)
              • durationintegerOpcionalPermite null

                Duração em segundos do preset do modelo.

              • resolutionstringOpcional

                Resolução do preset do modelo.

              • aspect_ratiostringOpcional

                Proporção do preset do modelo.

              • generate_audiobooleanOpcionalPermite null

                Se o preset gera áudio.

          • audio_policystringObrigatório

            Política de áudio do modo atual.

          • aspect_policystringObrigatório

            Política de proporção do modo atual.

          • duration_policystringObrigatório

            Política de duração do modo atual.

          • prompt_max_charsintegerObrigatório

            Máximo de caracteres Unicode do prompt do modo atual.

          • start_frameobjectOpcional

            Limites do quadro inicial do modo atual.

            Campos filhos de start_frame (5)
            • requiredbooleanObrigatório

              Se o modo exige esse quadro.

            • max_bytesintegerObrigatório

              Máximo de bytes do arquivo do quadro.

            • max_pixelsintegerObrigatório

              Máximo total de pixels do quadro.

            • max_edgeintegerObrigatório

              Máximo de pixels por lado do quadro.

            • content_typesarrayObrigatório

              Tipos MIME de imagem aceitos para o quadro.

              Campos filhos de content_types (1)
              • []stringOpcional
            Ramificação allOf 1

            Tipo: object

            Obrigatório nesta ramificação: required, max_bytes, max_pixels, max_edge, content_types

            • requiredbooleanObrigatório

              Se o modo exige esse quadro.

            • max_bytesintegerObrigatório

              Máximo de bytes do arquivo do quadro.

            • max_pixelsintegerObrigatório

              Máximo total de pixels do quadro.

            • max_edgeintegerObrigatório

              Máximo de pixels por lado do quadro.

            • content_typesarrayObrigatório

              Tipos MIME de imagem aceitos para o quadro.

              Campos filhos de content_types (1)
              • []stringOpcional
          • end_frameobjectOpcional

            Limites do quadro final do modo atual.

            Campos filhos de end_frame (5)
            • requiredbooleanObrigatório

              Se o modo exige esse quadro.

            • max_bytesintegerObrigatório

              Máximo de bytes do arquivo do quadro.

            • max_pixelsintegerObrigatório

              Máximo total de pixels do quadro.

            • max_edgeintegerObrigatório

              Máximo de pixels por lado do quadro.

            • content_typesarrayObrigatório

              Tipos MIME de imagem aceitos para o quadro.

              Campos filhos de content_types (1)
              • []stringOpcional
            Ramificação allOf 1

            Tipo: object

            Obrigatório nesta ramificação: required, max_bytes, max_pixels, max_edge, content_types

            • requiredbooleanObrigatório

              Se o modo exige esse quadro.

            • max_bytesintegerObrigatório

              Máximo de bytes do arquivo do quadro.

            • max_pixelsintegerObrigatório

              Máximo total de pixels do quadro.

            • max_edgeintegerObrigatório

              Máximo de pixels por lado do quadro.

            • content_typesarrayObrigatório

              Tipos MIME de imagem aceitos para o quadro.

              Campos filhos de content_types (1)
              • []stringOpcional
          • cancel_policystringOpcional

            Política de cancelamento; solicitá-lo não garante conclusão nem reembolso.

      • cancel_policystringObrigatório

        Política de cancelamento; solicitá-lo não garante conclusão nem reembolso.

      • pricing_kindsarrayObrigatório

        Métodos de preço aceitos pelo modelo.

        Campos filhos de pricing_kinds (1)
        • []stringOpcional
  • workspace_enabledbooleanObrigatório

    Se novas tarefas estão ativadas no espaço atual; não implica exclusão do histórico.

  • upload_enabledbooleanObrigatório

    Se o serviço ativa uploads de referências.

  • file_storage_enabledbooleanObrigatório

    Se o serviço ativa armazenamento gerenciado.

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.