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.

Assets

https://apis.roblox.com/assets

Listar Versões de Recursos

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

Parâmetros

assetId string
Path
Obrigatório
maxPageSize number
pageToken string

Solicitação

List Asset Versions
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}/versions?pageToken=&maxPageSize=' \

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

Resposta

200 - OK
Versões de recursos listadas com sucesso.
Retorna um(a) array<object>

Permissões necessárias

Limites

Versão de Recursos de Retrocesso

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

Parâmetros

assetId string
Path
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

200 - OK
Ativo revertido com sucesso.
Retorna um(a) object
creationContext object
moderationResult object
path string

Permissões necessárias

Limites

Criar Recurso

POST /v1/assets

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
error object
metadata object
path string
response object

Permissões necessárias

Limites

Obter recurso

GET /v1/assets/{assetId}

Parâmetros

assetId string
Path
Obrigatório
readMask string

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

200 - OK
Recurso de ativo recuperado com sucesso.
Retorna um(a) object
assetId number
assetType string
creationContext object
description string
displayName string
icon string
moderationResult object
path string
previews array<object>
revisionCreateTime string
revisionId string
socialLink object
state string

Permissões necessárias

Limites

Atualizar recurso

PATCH /v1/assets/{assetId}

Parâmetros

assetId string
Path
Obrigatório
updateMask string

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 da atualização/Retorna os campos de metadados atualizados.
Retorna um(a) object
application/json
{"previews": [

  {"asset": "assets/123", "altText": "preview 1"},

  {"asset": "assets/456", "altText": "preview 2"}

]}
done boolean
error object
metadata object
path string
response object

Permissões necessárias

Limites

Obtenha a versão do recurso

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

Parâmetros

assetId string
Path
Obrigatório
versionNumber string
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

200 - OK
Versão de recurso recuperada com sucesso.
Retorna um(a) object
creationContext object
moderationResult object
path string

Permissões necessárias

Limites

Recurso de Arquivo

POST /v1/assets/{assetId}:archive

Parâmetros

assetId string
Path
Obrigatório

Solicitação

Archive Asset
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:archive' \

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

--header 'Content-Type: application/json'

Resposta

200 - OK
Recurso arquivado com sucesso.
Retorna um(a) object
assetId number
assetType string
creationContext object
description string
displayName string
icon string
moderationResult object
path string
previews array<object>
revisionCreateTime string
revisionId string
socialLink object
state string

Permissões necessárias

Limites

Restaurar Recurso

POST /v1/assets/{assetId}:restore

Parâmetros

assetId string
Path
Obrigatório

Solicitação

Restore Asset
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:restore' \

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

--header 'Content-Type: application/json'

Resposta

200 - OK
Recurso restaurado com sucesso.
Retorna um(a) object
assetId number
assetType string
creationContext object
description string
displayName string
icon string
moderationResult object
path string
previews array<object>
revisionCreateTime string
revisionId string
socialLink object
state string

Permissões necessárias

Limites

Obter Operação

GET /v1/operations/{operationId}

Parâmetros

operationId string
Path
Obrigatório

Solicitação

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

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

Resposta

200 - OK
Resultado da operação recuperado com sucesso.
Retorna um(a) object
done boolean
error object
metadata object
path string
response object

Permissões necessárias

Limites

Objetos

Any

Atributos

@type string

Asset

Atributos

assetId number
assetType string
creationContext object
description string
displayName string
icon string
moderationResult object
path string
previews array<object>
revisionCreateTime string
revisionId string
socialLink object
state string

AssetVersion

Atributos

creationContext object
moderationResult object
path string

CreationContext

Atributos

creator object
Obrigatório
expectedPrice number

Creator

Atributos

groupId number
userId number

ModerationResult

Atributos

moderationState string

Operation

Atributos

done boolean
error object
metadata object
path string
response object

Preview

Atributos

altText string
asset string

Atributos

title string
uri string

State

Atributos

string (enum): "Unspecified", "Active", "Archived"

Status

Atributos

code number
details array<object>
message string