API (Interface de Programação para Aplicações)de Recursos
*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.
Você pode enviar e receber os seguintes pedidos e respostas para criar recursos no Roblox.Para obter informações sobre o uso da API (Interface de Programação para Aplicações), consulte o guia de uso.
Assets
Listar Versões de Recursos
Liste todas as versões de um ativoespecífico, com paginação opcional.
Parâmetros
O identificador exclusivo do ativo.
Specifica o número de versões de recursos a incluir na resposta. Os valores válidos variam de 1 a 50 (inclusivo). Padrão para 8 quando não fornecido.
Um token para paginação. O valor é obtido a partir de uma solicitação anterior e permite recuperar a próxima página de versões de recursos.
Solicitação
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}/versions?pageToken=&maxPageSize=' \
--header 'x-api-key: {apiKey}'Resposta
Permissões necessárias
As seguintes permissões de chave API são requeridas para chamar este endpoint. Para mais informações sobre gerar chaves apropriadas, veja Gerenciando chaves API.
Limites
Por chave de API: 100 solicitações a cada 60 segundos por endereço IP
Versão de Recursos de Retrocesso
Rolar um recurso de volta para uma versão anterior específica.
Forneça o caminho da versão do recurso no formulário de dados.
Parâmetros
O identificador exclusivo do ativo.
Solicitação
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}/versions:rollback' \
--header 'x-api-key: {apiKey}' \
--header 'Content-Type: application/json' \
--data '{\"assetVersion\":\"assets/{assetId}/versions/{versionNumber}\"}'Resposta
Permissões necessárias
As seguintes permissões de chave API são requeridas para chamar este endpoint. Para mais informações sobre gerar chaves apropriadas, veja Gerenciando chaves API.
Limites
Por chave de API: 100 solicitações a cada 60 segundos por endereço IP
Criar Recurso
Cria um recurso com conteúdo e metadados fornecidos.
Você não pode adicionar objetos SocialLink quando cria um recurso. Em vez disso, use Atualizar Recurso.
Forneça o Recurso, caminho de arquivo de recurso binário, e tipo de conteúdo na forma de dados.
Solicitação
curl --location --request POST 'https://apis.roblox.com/assets/v1/assets' \
--header 'x-api-key: {apiKey}' \
--form 'request="{
\"assetType\": \"Model\",
\"displayName\": \"Name\",
\"description\": \"This is a description\",
\"creationContext\": {
\"creator\": {
\"userId\": \"${userId}\"
}
}
}"' \
--form 'fileContent=@"/filepath/model.fbx";type=model/fbx'Resposta
Permissões necessárias
As seguintes permissões de chave API são requeridas para chamar este endpoint. Para mais informações sobre gerar chaves apropriadas, veja Gerenciando chaves API.
Limites
Por chave de API: 60 solicitações a cada 60 segundos por endereço IP
Obter recurso
Recupere conteúdo e metadados de ativos específicos.
Parâmetros
O identificador exclusivo do ativo.
Campos de metadados de recursos para recuperar, incluindo a descrição, o Nome de exibiçãode exibição, o ícone, os links sociais e as visualizações. Exemplos: description%2CdisplayName , previews%2CtwitchSocialLink .
Solicitação
curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}' \
--header 'x-api-key: {apiKey}'curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}?readMask={read_mask}' \
--header 'x-api-key: {apiKey}'Resposta
Permissões necessárias
As seguintes permissões de chave API são requeridas para chamar este endpoint. Para mais informações sobre gerar chaves apropriadas, veja Gerenciando chaves API.
Limites
Por chave de API: 60 solicitações a cada 60 segundos por endereço IP
Atualizar recurso
Atualiza um recurso com conteúdo e metadados fornecidos, incluindo a descrição, o nome de exibição, o ícone, os links sociais e as visualizações.Atualmente, só é possível atualizar o corpo do conteúdo para Modelos .Ícones e Pré-visualizações devem ser imagens de recursos.Ícones devem ter dimensões quadradas.
Forneça o Recurso, caminho de arquivo de recurso binário, e tipo de conteúdo na forma de dados.
Parâmetros
O identificador exclusivo do ativo.
Campos de metadados de recursos para atualização, incluindo a descrição, o nome de exibição, o ícone e as visualizações. Exemplos: description%2CdisplayName , previews%2CtwitchSocialLink .
Solicitação
curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{assetId}' \
--header 'x-api-key: {apiKey}' \
--form 'request="{\"assetId\": {assetId} }"' \
--form 'fileContent="@\"{file-path}\""'curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{assetId}?updateMask=description%2CdisplayName' \
--header 'x-api-key: {apiKey}' \
--form 'request="{
\"assetType\": \"{assetType}\",
\"assetId\": {assetId},
\"displayName\": \"{new display name}\",
\"description\": \"{new description}\",
\"creationContext\": {
\"creator\": {
\"userId\": {userId}
},
\"expectedPrice\":{expectedPrice}
},
}"' \
--form 'fileContent=@\"{file-path}\"'curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{assetId}?updateMask=previews' \
--header 'x-api-key: {apiKey}' \
--form 'request="{\"assetId\": \"{assetId}\", \"previews\": [{\"asset\": \"assets/123\", \"altText\": \"Your alt text.\"}]}"'curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{assetId}?updateMask=twitchSocialLink%2CgithubSocialLink' \
--header 'x-api-key: {apiKey}' \
--form 'request="{\"assetId\": \"{assetId}\", \"twitchSocialLink\": {\"title\": \"Optional title\", \"uri\": \"https://twitch.tv/your-channel\"}, \"githubSocialLink\": {\"title\": \"Optional title\", \"uri\": \"https://github.com/your-repo\"}}"'Resposta
Permissões necessárias
As seguintes permissões de chave API são requeridas para chamar este endpoint. Para mais informações sobre gerar chaves apropriadas, veja Gerenciando chaves API.
Limites
Por chave de API: 60 solicitações a cada 60 segundos por endereço IP
Obtenha a versão do recurso
Recupere uma versão específica de um recurso pelo ID do recurso e pelo número da versão.
Parâmetros
O identificador exclusivo do ativo.
O número da versão.
Solicitação
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetId}/versions/{versionNumber}' \
--header 'x-api-key: {apiKey}'Resposta
Permissões necessárias
As seguintes permissões de chave API são requeridas para chamar este endpoint. Para mais informações sobre gerar chaves apropriadas, veja Gerenciando chaves API.
Limites
Por chave de API: 100 solicitações a cada 60 segundos por endereço IP
Recurso de Arquivo
Arquiva o ativo.Recursos arquivados desaparecem do site e não são mais utilizáveis ou visíveis nas experiências do Roblox, mas você pode restaurá-los.
Parâmetros
O identificador exclusivo do ativo.
Solicitação
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:archive' \
--header 'x-api-key: {apiKey}' \
--header 'Content-Type: application/json'Resposta
Permissões necessárias
As seguintes permissões de chave API são requeridas para chamar este endpoint. Para mais informações sobre gerar chaves apropriadas, veja Gerenciando chaves API.
Limites
Por chave de API: 100 solicitações a cada 60 segundos por endereço IP
Restaurar Recurso
Restaura um recurso arquivado.
Parâmetros
O identificador exclusivo do ativo.
Solicitação
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:restore' \
--header 'x-api-key: {apiKey}' \
--header 'Content-Type: application/json'Resposta
Permissões necessárias
As seguintes permissões de chave API são requeridas para chamar este endpoint. Para mais informações sobre gerar chaves apropriadas, veja Gerenciando chaves API.
Limites
Por chave de API: 100 solicitações a cada 60 segundos por endereço IP
Obter Operação
Obtenha o resultado de uma criação ou atualização de recurso usando o ID de operação retornado.Requer Leitura para a permissão da chave da API e leitura de recursos para aplicativos do OAuth 2.0.
Parâmetros
O identificador exclusivo da operação.
Solicitação
curl --location 'https://apis.roblox.com/assets/v1/operations/{operationId}' \
--header 'x-api-key: {apiKey}'Resposta
Permissões necessárias
As seguintes permissões de chave API são requeridas para chamar este endpoint. Para mais informações sobre gerar chaves apropriadas, veja Gerenciando chaves API.
Limites
Por chave de API: 100 solicitações a cada 60 segundos por endereço IP
Objetos
Os seguintes objetos descrevem payloads que são aceitos ou retornados. Veja cada endpoint para mais informações sobre quando esses objetos são usados.
Any
Contém uma mensagem serializada arbitrária junto com um @type que descreve o tipo da mensagem serializada.
Atributos
O tipo da mensagem serializada.
Asset
Representa um ativo.
Atributos
O identificador exclusivo do recurso. Necessário para Atualizar Recurso.
O digitarde recurso. Só pode ser Audio , Decal ou Model . Necessário para Criar Recurso .
O contexto de criação que não faz parte do conteúdo do recurso, como metadados e informações do criador. Necessário para Criar Recurso.
A descrição do ativo. Limite de 1000 caracteres. Necessário para Criar Recurso.
Nome de exibição do ativo. Necessário para Criar Recurso.
O caminho de recursos para o ícone.
O resultado de moderação do ativo.
O caminho de recursos retornado da ativo. Formato: assets/{assetId} . Exemplo: assets/2205400862 .
Uma lista de pré-visualizações, cada uma com um caminho de recurso e texto alternativo. As pré-visualizações devem ser Imagem recursos.
O tempo de criação da revisão atual.
ID de revisão do ativo.Equivalente a versionNumber.Cada alteração do recurso envia automaticamente uma nova versão.O formato é uma string / cadeia / textointeira.Exemplo: 1 .
Um link de mídia social para o recurso.Máximo de três por ativo.O nome do objeto pode ser qualquer um dos seguintes:
- facebookSocialLink
- twitterSocialLink
- youtubeSocialLink >
- twitchSocialLink >
- discordSocialLink >
- githubSocialLink >
- robloxSocialLink >
- guildedSocialLink >
- devForumSocialLink > >
Se o recurso está ativo ou arquivado. Não especificado não é usado.
AssetVersion
Uma versão de recurso.
Atributos
O contexto de criação que não faz parte do conteúdo do recurso, como metadados e informações do criador. Necessário para Criar Recurso.
O resultado de moderação do ativo.
O caminho de recursos retornado da versão do recurso. Formato: assets/{assetId}/versions/{version} . Exemplo: assets/2205400862/versions/1 .
CreationContext
O contexto de criação que não faz parte do conteúdo do recurso, como metadados e informações do criador. Necessário para Criar Recurso.
Atributos
Representa um criador.
Taxa de upload de recurso esperada em Robux. Quando o preço real for maior do que o esperado, a operação falha com um erro de 400.
Creator
Representa um criador.
Atributos
O ID do Grupo. Necessário se o recurso for de propriedade do grupo.
O ID do Usuário do criador. Necessário se o recurso for de propriedade de um único usuário.
ModerationResult
O resultado de moderação do ativo.
Atributos
O estado de moderação do ativo. Pode ser Reviewing, Rejected ou Approved.
Operation
Este recurso representa uma operação de longa duração que é o resultado de uma chamada de API de rede.
Atributos
Se false , a operação ainda está em andamento. Se true , a operação é concluída.
O modelo de erro lógico que explica o status de erro.
Contém uma mensagem serializada arbitrária junto com um @type que descreve o tipo da mensagem serializada.
O caminho de recursos atribuído pelo servidor. O formato padrão é operations/{operation_id} .
Contém uma mensagem serializada arbitrária junto com um @type que descreve o tipo da mensagem serializada.
Preview
Uma prévia de recurso.
Atributos
Texto alternativo para o recurso de pré-visualização.
O caminho de pré-visualização de recursos.
SocialLink
Um link de mídia social para o recurso.Máximo de três por ativo.O nome do objeto pode ser qualquer um dos seguintes:
- facebookSocialLink
- twitterSocialLink
- youtubeSocialLink >
- twitchSocialLink >
- discordSocialLink >
- githubSocialLink >
- robloxSocialLink >
- guildedSocialLink >
- devForumSocialLink > >
Atributos
Um título opcional para o víncular / conectarde mídia social. Não usado no Hub do Criador.
O URI para o víncular / conectarde mídia social.Deve corresponder ao formato esperado para o tipo de víncular / conectar.Por exemplo, o título de um objeto twitchSocialLink deve ser do formato https://twitch.tv/your-channel.
State
Se o recurso está ativo ou arquivado. Não especificado não é usado.
Atributos
Status
O modelo de erro lógico que explica o status de erro.
Atributos
O código de status HTTP.
Uma lista de mensagens que carregam detalhes de erro.
A mensagem de erro.