Documentação
Mubert API de Música com IA
Versão 3.0
Índice
Bem-vindo à API de Música com IA Mubert v3!
Esta API permite integrar funcionalidades de geração de faixas e streaming de música em aplicações, jogos ou serviços. Para começar a usar a API, por favor solicite as suas chaves da API à equipa da Mubert (via [email protected]).
A API REST comunica exclusivamente em JSON sobre SSL (HTTPS). Todos os URLs dos endpoints começam com https://music-api.mubert.com/api/v3/ (exceto os URLs de streaming, que começam com https://stream.mubert.com/b2b/v3/)
Os parâmetros devem ser serializados em JSON e enviados no corpo da solicitação.
Você deve usar a designação de tipo de mídia application/json.
Existem dois diretórios principais na API:
serviço —
https://music-api.mubert.com/api/v3/service/— usado pela empresa para gerir licenças e clientes.público —
https://music-api.mubert.com/api/v3/public/— usado pelos clientes para receber funcionalidades de streaming e faixas.
Autenticação
A API REST aceita autenticação baseada em chave de API.
Para Empresas
Para clientes
A API REST comunica exclusivamente em JSON sobre SSL (HTTPS). Todos os URLs dos endpoints começam com https://music-api.mubert.com/api/v3/ (exceto os URLs de streaming, que começam com https://stream.mubert.com/b2b/v3/)
Para o diretório de serviço, use um par de COMPANY_ID e LICENSE_TOKEN e, para o diretório público, use um par de CUSTOMER_ID e ACCESS_TOKEN.
Você deve substituir COMPANY_ID / LICENSE_TOKEN / CUSTOMER_ID / CUSTOMER_TOKEN pelos seus tokens reais.
Licença
Para sua conveniência, tornámos possível que uma empresa tenha várias licenças com as suas próprias capacidades e limites. Isto foi feito para que possa পৃথ separar utilizadores por licenças diferentes. Por defeito, a empresa tem uma licença e, na maioria dos casos, isso é suficiente.
Pode obter informações sobre as suas licenças e limites.
Use licenças do modelo com a solicitação GET
Também pode obter informações sobre uma licença específica
Resposta
200 OK
Este é o modelo de licença. Aqui pode encontrar as funcionalidades da licença, os parâmetros predefinidos, os limites e as estatísticas.
Você pode notar -1 em alguns valores de limite; isso significa que um limite não está definido (ilimitado).
Webhooks
Nesta versão da API, pode adicionar um webhook à licença através do qual receberá notificações sobre o estado do processo de geração das faixas.
Use o método PUT para configurar um webhook
você receberá um modelo de licença atualizado.
Depois de adicionar o webhook, você começará a receber mensagens com modelos de rastreamento. Assim:
Você pode saber mais sobre o modelo track na seção Geração de trilhas.
Registo de utilizador
Cada usuário final do seu produto (serviço) é identificado por um par de tokens exclusivo: customer-id e access-token. Esses tokens são necessários para acessar o conteúdo e os recursos.
Crie tantos clientes quantos forem os utilizadores a quem pretende fornecer música.
Para criá-lo, use o modelo customers com a solicitação POST descrita abaixo.
Parâmetros de entrada
custom_id — o seu ID interno único de cliente, que pode consistir em letras latinas, números e caracteres especiais permitidos: ".", "_", "@", "-" e não deve ter mais de 255 caracteres.
company-id e license-token — fornecidos pela equipe Mubert
Responde com uma resposta 200 OK e uma resposta JSON, se for bem-sucedido.
Existe modelo de cliente
Aqui:
customer-id =
data->access->customer_id(CUSTOMER_ID)access-token =
data->access->access_token(ACCESS_TOKEN)daily_reset_at, monthly_reset_at — data anulável
Também pode ver os limites e as estatísticas pessoais do cliente.
Gestão de utilizadores
Informações do(s) utilizador(es)
Você pode obter informações sobre todos os seus usuários com paginação.
Use GET requisição com o modelo customers
A resposta contém uma lista de modelos de clientes.
Use a paginação para ver todos os dados.
Também pode obter informações sobre um cliente específico usando o seu identificador personalizado ou de cliente. Como isto:
Ou
As respostas também contêm o modelo do cliente.
Eliminação de utilizador
Use a solicitação DELETE com o modelo customers
Responde com uma resposta 204 Sem Conteúdo se for bem-sucedido.
Lista de canais
Informações do(s) utilizador(es)
Tanto o streaming como a geração de faixas requerem que selecione um canal de música.
Use GET no modelo playlists para obter uma lista de todas as categorias, grupos, canais e seus índices de playlist disponíveis.
Resposta 200 OK
Aqui você também pode ver a faixa de BPM e a lista de tons. Esses valores estão disponíveis para a geração de faixas.
Observe que o parâmetro bpm tem um intervalo disponível no qual você pode gerar numa categoria específica.
gt significa maior que, lt significa menor que.
Streaming de música
Antes de começar a utilizar a função de streaming, certifique-se de que ela está ativada no acordo contratual. Também pode encontrá-la nas informações da sua licença. Para obter uma ligação para o streaming, utilize o pedido abaixo
Solicitação
Resposta 200 OK
Parâmetros
playlist_index(obrigatório) — índice do canalbitrate(opcional) — qualidade do som medida em kbpsintensity(opcional) — a complexidade do arranjo, menos ou mais instrumentos estão a tocar simultaneamentetype(opcional) — tipo de protocolo de streaming
Valores possíveis para bitrate : 32, 96, 128, 192, 256, 320
Valores possíveis para intensity : baixo, médio, alto
Valores possíveis para type : http, webrtc
Se os parâmetros opcionais forem omitidos ou contiverem valores incorretos, então os parâmetros padrão são aplicados com bitrate=128, intensity=high e type=http.
gt significa maior que, lt significa menor que.
Modo de repetição
Use a URL set-loop-state para repetir a parte mais recente da composição musical (ou desativar o modo de repetição).
Parâmetros
loop(obrigatório) — valores possíveis:off,ontime(opcional) — defina como igual ao tempo atual de reprodução do stream em segundos (desde o início da sessão) para melhorar a experiência do usuário
Solicitação
Resposta
Responde com um 204 Sem conteúdo se for bem-sucedido.
Intensidade
O set-intensity URL permite alterar a complexidade do arranjo. Diferentes predefinições consistem em menos ou mais instrumentos a tocar simultaneamente. As intensidades mudam de forma contínua sem interromper o fluxo.
Valores possíveis para a intensidade : low, medium, high
Solicitação
Resposta
Responde com um 204 Sem conteúdo se for bem-sucedido.
Reiniciar geração
Para reiniciar o stream, para que uma faixa diferente (melodia) comece a tocar com o mesmo url, use o método POST com streaming/restart.
Solicitação
Resposta
Responde com um 204 Sem conteúdo se for bem-sucedido.
Geração de trilhas
Antes de começar a usar a função de geração de trilhas, certifique-se de que ela está ativada ao abrigo do contrato. Além disso, pode encontrá-la nas informações da sua licença.
Com esta API, pode criar faixas personalizadas por pedido. Cada faixa é uma composição musical exclusiva, disponível para descarregar através de uma ligação especial.
Para interagir com faixas, use o modelo tracks.
Criar faixa
Use POST para criar uma faixa com um conjunto das características selecionadas.
Solicitação
Parâmetros
playlist_index(obrigatório) - índice do canalduration(obrigatório) - duração da faixa em segundosformat(opcional) - mp3 ou wavbitrate(opcional) - qualidade do som medida em kbpsintensity(opcional) - complexidade do arranjo, menos ou mais instrumentos estão a tocar simultaneamentemode(opcional) — tipo de composição (track,loop,jingle,mix)
Valores possíveis para bitrate : 32, 96, 128, 192, 256, 320
Valores possíveis para intensity : baixo, médio, alto
Se parâmetros opcionais forem omitidos ou contiverem valores incorretos, então os parâmetros padrão são aplicados com format=mp3, bitrate=128 , intensity=high, mode=track
track - significa uma faixa com estrutura comum, com intro, drops, breaks e outro
loop - designa uma faixa que pode ser repetida em loop
jingle - é ideal para conteúdos musicais com até 40 segundos de duração – são faixas curtas e completas, com uma estrutura fixa e lógica
mix - imita o trabalho de um DJ, em que as faixas seguem umas após as outras, misturando-se harmoniosamente
playlist_index é um índice universal de canais no formato “0.0.0”, composto por category_id.group_id.channel_id. Omita os últimos dígitos para misturar vários canais.
Por exemplo: playlist=0.0 reproduzirá todos os canais dentro do grupo “Calma”; playlist=0 reproduzirá toda a categoria “Humores”.
Resposta
Aqui:
prompt,key,bpm,url— cadeia de caracteres nulagenerated_at,expired_at— data nula
Para verificar se uma faixa foi criada, use o modelo tracks com TRACK_ID. Assim:
Solicitação
Ou adicione um webhook à sua licença e receba mensagens quando estiver concluído.
Texto-para-Música
Pode criar uma faixa com um prompt de texto e um conjunto de características selecionadas. Este método é semelhante ao anterior, mas, em vez de escolher um canal, envia-nos uma mensagem de texto. Esta é enviada para a rede neural transformer, com uma base de etiquetas, e os conjuntos de sons correspondentes são escolhidos automaticamente. Depois disso, o nosso motor de composição cria uma faixa e devolve-lhe o ficheiro.
Antes de começar a utilizá-lo, certifique-se de que está ativado ao abrigo do contrato.
Solicitação
Parâmetros
prompt(obrigatório) —o seu texto de prompt em inglês, no máximo 200 caracteresduration(obrigatório) — duração da faixa em segundosformat(opcional) —mp3ouwavbitrate(opcional) — qualidade de som medida em kbpsintensity(opcional) — complexidade do arranjo, com menos ou mais instrumentos a tocar simultaneamentemode(opcional) — tipo de composição (track,loop)
Valores possíveis para bitrate : 32, 96, 128, 192, 256, 320
Valores possíveis para intensity : baixo, médio, alto
prompt — prompt de texto que você pode receber da entrada do usuário ou de quaisquer outras entradas conectadas (modelos de linguagem, imagem-para-texto, mecânicas de jogo etc.)
track — significa uma faixa com estrutura comum com intro, drops, breaks e outro
loop — significa uma faixa que pode ser repetida em loop
Se os parâmetros opcionais forem omitidos ou contiverem valores incorretos, então os parâmetros padrão são aplicados com format=mp3, bitrate=128 , intensity=high, mode=track
Resposta
Responde com um 204 Sem conteúdo se for bem-sucedido.
Intensidade
O set-intensity URL permite alterar a complexidade do arranjo. Diferentes predefinições consistem em menos ou mais instrumentos a tocar simultaneamente. As intensidades mudam de forma contínua sem interromper o fluxo.
Valores possíveis para a intensidade : low, medium, high
Solicitação
Resposta
Responde com um 204 Sem conteúdo se for bem-sucedido.
Reiniciar geração
Para reiniciar o stream, para que uma faixa diferente (melodia) comece a tocar com o mesmo url, use o método POST com streaming/restart.
Solicitação
Resposta
Responde com um 204 Sem conteúdo se for bem-sucedido.
Imagem-2-Música
Pode criar uma faixa com uma imagem. Antes de começar a utilizá-la, certifique-se de que está ativada ao abrigo do acordo contratual.
Solicitação
Parâmetros
image(obrigatório) — a sua imagem no formato jpeg/png, máximo de 10 MBduration(obrigatório) — duração da faixa em segundosformat(opcional) — mp3 ou wavbitrate(opcional) — qualidade do som medida em kbpsintensity(opcional) — complexidade do arranjo, menos ou mais instrumentos estão a tocar simultaneamentemode(opcional) — tipo de composição (track,loop)
Valores possíveis para bitrate : 32, 96, 128, 192, 256, 320
Valores possíveis para intensity : baixo, médio, alto
track — significa uma faixa com estrutura comum com intro, drops, breaks e outro
loop — significa uma faixa que pode ser repetida em loop
Se os parâmetros opcionais forem omitidos ou contiverem valores incorretos, então os parâmetros padrão são aplicados com format=mp3, bitrate=128 , intensity=high, mode=track
Geração de BPM/Tom
Pode adicionar bpm e tonalidade aos parâmetros de geração de playlist_index.
Solicitação
Resposta
Responde com 200 OK com o track modelo se for bem-sucedido.
Gerar semelhantes
Você pode gerar uma faixa semelhante a uma existente. Ela não será exatamente a mesma faixa, mas será semelhante.
Utilize POST com https://music-api.mubert.com/api/v3/public/tracks/TRACK_ID/similar
Solicitação
Edição de faixa
Você pode alterar alguns parâmetros de uma faixa existente.
Solicitação
Resposta 200 OK
Além disso, você pode substituir parte da faixa. Cada faixa é composta por instrumentos. A faixa pode conter instrumentos como:
BATERIA, PERCUSSÕES, CHIMBALS, PALMAS, BAIXO, MÉDIOS, LEADS, FX, VOCAIS, PADS, ASCENDENTE, IMPACTO
Estes instrumentos podem ser combinados em hastes, como
Então, estas stems contêm os seguintes instrumentos:
DRUMSincluiDRUMS,PERCS,HATS,CLAPSBASSincluiBASSLEADSincluiMIDS,LEADS,PADSVOCALSincluiVOCALSFXincluiFX,RISER,IMPACT
Pode substituir tanto o instrumento como a haste. Substituir instrumento(s):
Substituir instrumento(s):
Substituir hastes:
Eliminar instrumento(s):
Eliminar caule(s):
Todas estas solicitações recebem o modelo track.
Lista de Faixas
Para obter a lista de faixas, use GET com o modelo tracks.
A resposta contém uma lista de modelos de pistas.
Use a paginação para ver todos os dados.
Também pode obter informações sobre uma faixa específica.
A resposta contém o modelo da pista.
Loja de faixas
A funcionalidade de armazenamento de faixas permite criar um buffer com faixas pré-geradas. Funciona muito bem quando pretende obter uma faixa única com a duração, o modo e o formato exatos, sem respostas demoradas. Criamos um bucket na nuvem e configuramos um gerador dedicado para acelerar o processo de receção de ficheiros. Mubert cria várias faixas com um conjunto de parâmetros e coloca-as no bucket. Quando usa um destes ficheiros, inicia-se uma geração de faixas semelhante para preencher o buffer. A quantidade de ficheiros no bucket depende da carga média do seu serviço. Para calcular isso, também precisamos de receber de si uma lista dos seguintes parâmetros: modo, duração, bitrate, intensidade, formato. Selecione os valores destes parâmetros e envie um email ao nosso gestor para continuarmos a criar o bucket. Além disso, pode escolher as playlists que pretende pré-gerar; por predefinição, usamos todos os canais.
Receberá automaticamente o track a partir do track store quando os parâmetros do pedido de track corresponderem aos parâmetros da store. Antes de começar a usar o track store, certifique-se de que está ativado ao abrigo do acordo contratual.
Mubert Biblioteca de músicas
Preparamos uma biblioteca com mais de 12.000 faixas criadas usando a inteligência artificial da Mubert e selecionadas pelos nossos editores musicais.
Parâmetros
Use o método GET para ver estatísticas da biblioteca de música e os parâmetros pelos quais pode filtrar faixas.
Solicitação
Resposta
Você também pode obter informações sobre um parâmetro específico. Por exemplo: BPM 120
Resposta
Isto significa que pode encontrar 315 faixas com BPM 120 no tema "Сorporate", 12 faixas no tema "Podcast", 138 faixas no género "Nu Disco" e 27 faixas no género "Folk".
Você pode especificar vários parâmetros e então o AND lógico será aplicado a eles.
Solicitação
Resposta
Na resposta, também pode ver a contagem de faixas de cada duração correspondente ao pedido BPM 120 AND Genre Nu Disco
Faixas
Use o método GET para receber a lista de faixas.
Solicitação
Resposta
A resposta contém uma lista de modelos de faixas. Use paginação para ver todos os dados. Você também pode usar um ou mais parâmetros para filtrar faixas e encontrar as mais adequadas. Por exemplo: BPM 120 AND Gênero Nu Disco AND Duração 180
Solicitação
Resposta
Na resposta, inclua também uma lista dos modelos de trilhas. Use paginação para ver todos os dados.
Swagger
Para obter informações mais técnicas, você pode usar o Swagger: https://music-api.mubert.com/api/v3/swagger
Preços
Tente por apenas $49 por mês
está ao vivo agora — Dê trilha sonora aos seus vídeos