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

https://apis.roblox.com/assets

Lista de versões de recursos

GET /assets/v1/assets/{assetId}/versions

Liste todas as versões de um ativoespecífico, com pagamento opcional.

Parâmetros

assetId string

O identificador exclusivo do ativo.

Path
Obrigatório
maxPageSize number

Especifica o número de versões de recursos para incluir na resposta. Valores válidos variam de 1 a 50 (inclusivo). Padrões para 8 quando não fornecido.

pageToken string

Um token para paginação. O valor é obtido de uma solicitação anterior e permite recuperar a próxima página das versões de recursos.

Solicitação

List Asset Versions
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.

  • Ler

Os seguintes escopos são necessários para que seu aplicativo OAuth 2.0 use este endpoint. Para obter mais informações sobre como registrar um aplicativo OAuth 2.0, consulte Registro e revisão de aplicativos.

  • asset:read

Limites

Por chave de API: 60 solicitações a cada 60 segundos por endereço IP

Versão de ativo de rolagem

POST /assets/v1/assets/{assetId}/versions:rollback

Rolagem de um recurso para uma versão anterior específica.

Parâmetros

assetId string

O identificador exclusivo do ativo.

Path
Obrigatório
assetVersion string

O caminho da versão da versão da assets/{assetId}/versions/{versionNumber} .

FormData
Obrigatório

Solicitação

Rollback Asset Versions
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.

  • Ler

  • Escrever

Os seguintes escopos são necessários para que seu aplicativo OAuth 2.0 use este endpoint. Para obter mais informações sobre como registrar um aplicativo OAuth 2.0, consulte Registro e revisão de aplicativos.

  • asset:read

  • asset:write

Limites

Por chave de API: 60 solicitações a cada 60 segundos por endereço IP

Obter Recurso

GET /v1/assets

Recupere conteúdo e metadados de recursos específicos.

Parâmetros

assetId

O identificador exclusivo do ativo.

Path
Obrigatório
readMask string

Campos de metadados de recursos para recuperar, incluindo a descrição, nome de exibição, ícone, links sociais e previsões. Exemplos: description%2CdisplayName , previews%2CtwitchSocialLink .

Solicitação

Get Asset without readMask
curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}' \

--header 'x-api-key: {apiKey}'
Get Asset with readMask
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.

  • Ler

Os seguintes escopos são necessários para que seu aplicativo OAuth 2.0 use este endpoint. Para obter mais informações sobre como registrar um aplicativo OAuth 2.0, consulte Registro e revisão de aplicativos.

  • asset:read

Limites

Por chave de API: 60 solicitações a cada 60 segundos por endereço IP

Criar Recurso

POST /v1/assets

Cria um recurso com conteúdo e metadados fornecidos.

Você não pode adicionar objetos SocialLink ao criar um recurso. Em vez disso, use Atualizar Recurso.

Parâmetros

request

Atributos de recursos para criar ou atualização. Envie como dados de formulário, como mostrado no exemplo de solicitação a seguir.

FormData
Obrigatório
fileContent string

O caminho do arquivo de recursos binário e o digitarde conteúdo. Formato: fileContent=@"/filepath/{File}";type={ContentType} . Exemplo: fileContent=@"/filepath/model.fbx";type=model/fbx . Veja Tipos de Conteúdo .

FormData
Obrigatório

Solicitação

Create Asset
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

200 - OK
Retorna o ID da Operação para verificar o status de criação.
Retorna um(a) object
done boolean

Se false , a operação ainda está em andamento. Se true , a operação é concluída.

error object

O modelo lógico de erro explicando o status de erro.

metadata object

Contém uma mensagem serializada aleatória, juntamente com um @type que descreve o tipo da mensagem serializada.

path string

O caminho de recursos atribuído ao servidor. O formato padrão é operations/{operation_id} .

response object

Contém uma mensagem serializada aleatória, juntamente com um @type que descreve o tipo da mensagem serializada.

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.

  • Ler

  • Escrever

Os seguintes escopos são necessários para que seu aplicativo OAuth 2.0 use este endpoint. Para obter mais informações sobre como registrar um aplicativo OAuth 2.0, consulte Registro e revisão de aplicativos.

  • asset:read

  • asset:write

Limites

Por chave de API: 60 solicitações a cada 60 segundos por endereço IP

Atualizar Recurso

PATCH /v1/assets/{assetId}

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 predefinições. Atualmente, só pode atualizar o corpo de conteúdo para Modelos . Os ícones e Previsualizações devem ser recursos de Imagem. Os ícones devem ter dimensões quadradas.

Parâmetros

request

Envie como dados de formulário, como as seguintes solicitações de exemplo.

FormData
Obrigatório
fileContent string

O caminho do arquivo de recursos binário e o digitarde conteúdo. Formato: fileContent=@"/filepath/{File}";type={ContentType} . Exemplo: fileContent=@"/filepath/model.fbx";type=model/fbx . Veja Tipos de Conteúdo .

FormData
updateMask string

Campos de metadados de ativos para serem atualização, incluindo a descrição, nome de exibição, ícone e previsões. Exemplos: description%2CdisplayName , previews%2CtwitchSocialLink .

Solicitação

Update Content Only and Create a New Version
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}\""'
Update Content and Metadata
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}\"'
Update a List of Previews
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.\"}]}"'
Update Social Links

Resposta

200 - OK
Retorna o ID da Operação para verificar o status de atualização / Retorna os campos de metadados atualizados.
Retorna um(a) object
application/json
{\"previews\": [\n    {\"asset\": \"assets/123\", \"altText\": \"preview 1\"},\n    {\"asset\": \"assets/456\", \"altText\": \"preview 2\"}\n]}
done boolean

Se false , a operação ainda está em andamento. Se true , a operação é concluída.

error object

O modelo lógico de erro explicando o status de erro.

metadata object

Contém uma mensagem serializada aleatória, juntamente com um @type que descreve o tipo da mensagem serializada.

path string

O caminho de recursos atribuído ao servidor. O formato padrão é operations/{operation_id} .

response object

Contém uma mensagem serializada aleatória, juntamente com um @type que descreve o tipo da mensagem serializada.

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.

  • Ler

  • Escrever

Os seguintes escopos são necessários para que seu aplicativo OAuth 2.0 use este endpoint. Para obter mais informações sobre como registrar um aplicativo OAuth 2.0, consulte Registro e revisão de aplicativos.

  • asset:read

  • asset:write

Limites

Por chave de API: 60 solicitações a cada 60 segundos por endereço IP

Obter versão de recurso

GET /v1/assets/{assetId}/versions/{versionNumber}

Recupere uma versão de recurso específica pelo ID do recurso e pelo número de versão.

Parâmetros

assetId string

O identificador exclusivo do ativo.

Path
Obrigatório
versionNumber string

O número da versão.

Path
Obrigatório

Solicitação

Get Asset Version
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.

  • Ler

Os seguintes escopos são necessários para que seu aplicativo OAuth 2.0 use este endpoint. Para obter mais informações sobre como registrar um aplicativo OAuth 2.0, consulte Registro e revisão de aplicativos.

  • asset:read

Limites

Por chave de API: 60 solicitações a cada 60 segundos por endereço IP

Obter Operação

GET /v1/operations/{operationId}

Obtenha o resultado de uma criação ou atualização de recurso usando o ID de Operação retornado. Requer Leia para a permissão de chave da API e asset:read para os aplicativos OAuth 2.0.

Solicitação

Get Operation
curl --location 'https://apis.roblox.com/assets/v1/operations/{operationId}' \

--header 'x-api-key: {apiKey}'

Resposta

200 - OK
Retorna um(a) object
done boolean

Se false , a operação ainda está em andamento. Se true , a operação é concluída.

error object

O modelo lógico de erro explicando o status de erro.

metadata object

Contém uma mensagem serializada aleatória, juntamente com um @type que descreve o tipo da mensagem serializada.

path string

O caminho de recursos atribuído ao servidor. O formato padrão é operations/{operation_id} .

response object

Contém uma mensagem serializada aleatória, juntamente com um @type que descreve o tipo da mensagem serializada.

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.

  • Ler

Os seguintes escopos são necessários para que seu aplicativo OAuth 2.0 use este endpoint. Para obter mais informações sobre como registrar um aplicativo OAuth 2.0, consulte Registro e revisão de aplicativos.

  • asset:read

Limites

Por chave de API: 60 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 aleatória, juntamente com um @type que descreve o tipo da mensagem serializada.

Atributos

@type string

O tipo da mensagem serializada.

Asset

Representa um ativo.

Atributos

assetId number

O identificador exclusivo do recurso. Requer para Atualizar Recurso .

assetType string

O digitarde recurso. Só pode ser Audio , Decal ou Model . Requerido para 1> Criar Recurso1> .

creationContext object

O contexto de criação que não faz parte do conteúdo do recurso, como metadados e informações de criador. Requerido para Criar Recurso .

description string

A descrição do ativo. Limite de 1000 caracteres. Requerido para Criar Recurso.

displayName string

Nome de exibição do ativo. Requer para Criar Recurso .

icon string

O caminho de recursos para o ícone.

moderationResult object

O resultado da moderação do ativo.

path string

O caminho de recursos retornado do recurso. Formato: assets/{assetId} . Exemplo: assets/2205400862 .

previews array<object>

Uma lista de pré-visualizações, cada uma com um caminho de recurso e texto alternativo. As pré-visualizações devem ser Imagem recursos.

revisionCreateTime string

A hora de criação da revisão atual.

revisionId string

ID de revisão do ativo. Equivalente a versionNumber . Toda alteração do recurso envia automaticamente uma nova versão. O formato é uma string / cadeia / textode inteiro. Exemplo: 1 .

socialLink object

Um link de mídia social para o ativo. Máximo de três por ativo. O

CreationContext

O contexto de criação que não faz parte do conteúdo do recurso, como metadados e informações de criador. Requerido para Criar Recurso .

Atributos

creator object

Representa um criador.

Obrigatório
expectedPrice number

Taxa de upload de recursos 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

groupId number

O ID do Grupo. Requerido se o recurso for de propriedade do grupo.

userId number

O ID do Usuário é o criador. Requerido se o recurso for de propriedade do usuário.

ModerationResult

O resultado da moderação do ativo.

Atributos

moderationState string

O estado de moderação do ativo. Pode ser MODERATION_STATE_REVIEWING, MODERATION_STATE_REJECTED ou MODERATION_STATE_APPROVED.

Operation

Este recurso representa uma operação de longa duração que é o resultado de uma chamada de API de rede.

Atributos

done boolean

Se false , a operação ainda está em andamento. Se true , a operação é concluída.

error object

O modelo lógico de erro explicando o status de erro.

metadata object

Contém uma mensagem serializada aleatória, juntamente com um @type que descreve o tipo da mensagem serializada.

path string

O caminho de recursos atribuído ao servidor. O formato padrão é operations/{operation_id} .

response object

Contém uma mensagem serializada aleatória, juntamente com um @type que descreve o tipo da mensagem serializada.

Preview

Uma prévia de recursos.

Atributos

altText string

Texto alternativo para o recurso de pré-visualização.

asset string

O caminho de recursos da pré-visualização.

Um link de mídia social para o ativo. Máximo de três por ativo. O

Atributos

title string

Um título opcional para o víncular / conectarde mídia social. Não usado no Hub do Criador.

uri string

A URL 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 para um objeto twitchSocialLink deve ser do formato https://twitch.tv/your-channel.

Status

O modelo lógico de erro explicando o status de erro.

Atributos

code number

O código de status HTTP.

details array<object>

Uma lista de mensagens carregando detalhes de erro.

message string

A mensagem de erro.