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
Lista de 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
Outros códigos de status
Permissões necessárias
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
Parâmetros
assetId string
Path
Obrigatório
assetVersion string
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
Outros códigos de status
Permissões necessárias
Limites
Por chave de API: 60 solicitações a cada 60 segundos por endereço IP
Obter Recurso
GET /v1/assets
Parâmetros
assetId
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
Outros códigos de status
Permissões necessárias
Limites
Por chave de API: 60 solicitações a cada 60 segundos por endereço IP
Criar Recurso
POST /v1/assets
Parâmetros
request
FormData
Obrigatório
fileContent string
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
Outros códigos de status
Permissões necessárias
Limites
Por chave de API: 60 solicitações a cada 60 segundos por endereço IP
Atualizar Recurso
PATCH /v1/assets/{assetId}
Parâmetros
request
FormData
Obrigatório
fileContent string
FormData
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
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
Outros códigos de status
Permissões necessárias
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}
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
Outros códigos de status
Permissões necessárias
Limites
Por chave de API: 60 solicitações a cada 60 segundos por endereço IP
Obter Operação
GET /v1/operations/{operationId}
Solicitação
Get Operation
curl --location 'https://apis.roblox.com/assets/v1/operations/{operationId}' \
--header 'x-api-key: {apiKey}'Resposta
Outros códigos de status
Permissões necessárias
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
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
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
SocialLink
Atributos
title string
uri string
Status
Atributos
code number
details array<object>
message string