자산 API

*이 콘텐츠는 AI(베타)를 사용해 번역되었으며, 오류가 있을 수 있습니다. 이 페이지를 영어로 보려면 여기를 클릭하세요.

Roblox에서 자산을 생성하기 위해 다음 요청 및 응답 페이로드를 보내고 받을 수 있습니다.API 사용에 대한 자세한 정보는 사용 가이드를 참조하십시오.

Assets

https://apis.roblox.com/assets

자산 버전 목록

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

선택적 페이지네이션으로 특정 자산의 모든 버전을 나열합니다.

매개 변수

assetId string

자산의 고유 식별자.

Path
필수
maxPageSize number

응답에 포함할 자산 버전 수를 지정합니다. 유효한 값은 1에서 50(포함)까지입니다. 제공되지 않으면 기본값은 8입니다.

pageToken string

페이지네이션을 위한 토큰. 값은 이전 요청에서 가져오고 자산 버전의 다음 페이지를 검색할 수 있습니다.

요청

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

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

응답

200 - OK
성공적으로 나열된 자산 버전.
반환: array<object>

필요한 권한

이 엔드포인트를 호출하려면 다음 API 키 권한이 필요합니다. 적절한 키 생성에 대한 자세한 내용은 API 키 관리에서 확인하세요.

  • 읽기

한도

각 API 키별: IP 주소당 60초마다 100 요청

롤백 자산 버전

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

자산을 특정 이전 버전으로 롤백합니다.

양식 데이터에 자산 버전 경로를 제공합니다.

매개 변수

assetId string

자산의 고유 식별자.

Path
필수

요청

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}\"}'

응답

200 - OK
자산이 성공적으로 롤백됩니다.
반환: object
creationContext object

메타데이터 및 크리에이터 정보와 같이 자산 콘텐츠의 일부가 아닌 생성 컨텍스트. 자산 생성에 필요합니다.

moderationResult object

자산의 조정 결과.

path string

자산 버전의 반환된 리소스 경로. 형식: assets/{assetId}/versions/{version} . 예: assets/2205400862/versions/1 .

필요한 권한

이 엔드포인트를 호출하려면 다음 API 키 권한이 필요합니다. 적절한 키 생성에 대한 자세한 내용은 API 키 관리에서 확인하세요.

  • 읽기

  • 쓰기

한도

각 API 키별: IP 주소당 60초마다 100 요청

자산 생성

POST /v1/assets

제공된 콘텐츠와 메타데이터로 자산을 생성합니다.

자산을 생성할 때 소셜 링크 개체를 추가할 수 없습니다. 대신 자산 업데이트를 사용하십시오.

양식 데이터에서 자산, 바이너리 자산 파일 경로 및 콘텐츠 유형을 제공하십시오.

요청

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'

응답

200 - OK
생성 상태를 확인하기 위한 작업 ID를 반환합니다.
반환: object
done boolean

false 이면 작업이 계속 진행 중입니다. true 이면 작업이 완료됩니다.

error object

오류 상태를 설명하는 논리적 오류 모델.

metadata object

임의의 직렬화된 메시지와 함께 직렬화된 메시지의 유형을 설명하는 @type를 포함합니다.

path string

서버에서 할당된 리소스 경로. 기본 형식은 operations/{operation_id} 입니다.

response object

임의의 직렬화된 메시지와 함께 직렬화된 메시지의 유형을 설명하는 @type를 포함합니다.

필요한 권한

이 엔드포인트를 호출하려면 다음 API 키 권한이 필요합니다. 적절한 키 생성에 대한 자세한 내용은 API 키 관리에서 확인하세요.

  • 읽기

  • 쓰기

한도

각 API 키별: IP 주소당 60초마다 60 요청

자산 가져오기

GET /v1/assets/{assetId}

특정 자산 콘텐츠 및 메타데이터 검색.

매개 변수

assetId string

자산의 고유 식별자.

Path
필수
readMask string

설명, 표시 이름, 아이콘, 소셜 링크 및 미리 보기를 포함하는 리소스 메타데이터 필드를 가져오다. 예: description%2CdisplayName, previews%2CtwitchSocialLink .

요청

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}'

응답

200 - OK
자산 리소스를 성공적으로 검색했습니다.
반환: object
assetId number

자산의 고유 식별자. 자산 업데이트에 필요합니다.

assetType string

자산 입력. Audio , Decal 또는 Model 만 사용할 수 있습니다. 자산 생성에 필요합니다.

creationContext object

메타데이터 및 크리에이터 정보와 같이 자산 콘텐츠의 일부가 아닌 생성 컨텍스트. 자산 생성에 필요합니다.

description string

자산의 설명. 1000자 제한. 자산 생성에 필요합니다.

displayName string

자산의 표시 이름. 자산 생성에 필요합니다.

icon string

아이콘의 리소스 경로.

moderationResult object

자산의 조정 결과.

path string

자산의 반환된 리소스 경로. 형식: assets/{assetId} . 예: assets/2205400862 .

previews array<object>

미리 보기 목록, 각각 자산 경로와 alt 텍스트가 있습니다. 미리 보기는 이미지 자산이어야 합니다.

revisionCreateTime string

현재 리뷰의 생성 시간戳.

revisionId string

자산의 버전 ID.versionNumber와 동일합니다.자산의 모든 변경은 자동으로 새 버전을 커밋합니다.형식은 정수 문자열입니다.예: 1.

socialLink object

자산에 대한 소셜 미디어 링크.자산당 최대 3개.개체 이름은 다음 중 하나일 수 있습니다: 형식에 대해서는 업데이트 요청의 샘플을 참조하십시오: 자산 업데이트 참조하십시오.

state string

자산이 활성화되었거나 보관되었는지 여부. 지정되지 않은 것은 사용되지 않습니다.

필요한 권한

이 엔드포인트를 호출하려면 다음 API 키 권한이 필요합니다. 적절한 키 생성에 대한 자세한 내용은 API 키 관리에서 확인하세요.

  • 읽기

한도

각 API 키별: IP 주소당 60초마다 60 요청

자산 업데이트

PATCH /v1/assets/{assetId}

설명, 표시 이름, 아이콘, 소셜 링크 및 미리 보기를 포함하여 제공된 콘텐츠와 메타데이터로 자산을 업데이트합니다.현재 콘텐츠 바디를 모델 에만 업데이트할 수 있습니다.아이콘과 미리보기는 이미지 자산이어야 합니다.아이콘은 정사각형 크기를 가져야 합니다.

양식 데이터에서 자산, 바이너리 자산 파일 경로 및 콘텐츠 유형을 제공하십시오.

매개 변수

assetId string

자산의 고유 식별자.

Path
필수
updateMask string

설명, 표시 이름, 아이콘 및 미리 보기를 포함하는 자산 메타데이터 필드를 업데이트합니다. 예: description%2CdisplayName , previews%2CtwitchSocialLink .

요청

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

응답

200 - OK
업데이트 상태 확인을 위한 작업 ID 반환/업데이트된 메타데이터 필드 반환
반환: object
application/json
{"previews": [

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

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

]}
done boolean

false 이면 작업이 계속 진행 중입니다. true 이면 작업이 완료됩니다.

error object

오류 상태를 설명하는 논리적 오류 모델.

metadata object

임의의 직렬화된 메시지와 함께 직렬화된 메시지의 유형을 설명하는 @type를 포함합니다.

path string

서버에서 할당된 리소스 경로. 기본 형식은 operations/{operation_id} 입니다.

response object

임의의 직렬화된 메시지와 함께 직렬화된 메시지의 유형을 설명하는 @type를 포함합니다.

필요한 권한

이 엔드포인트를 호출하려면 다음 API 키 권한이 필요합니다. 적절한 키 생성에 대한 자세한 내용은 API 키 관리에서 확인하세요.

  • 읽기

  • 쓰기

한도

각 API 키별: IP 주소당 60초마다 60 요청

자산 버전 가져오기

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

자산 ID와 버전 번호로 특정 자산 버전을 검색합니다.

매개 변수

assetId string

자산의 고유 식별자.

Path
필수
versionNumber string

버전 번호.

Path
필수

요청

Get Asset Version
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetId}/versions/{versionNumber}' \

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

응답

200 - OK
자산 버전 성공적으로 검색됨.
반환: object
creationContext object

메타데이터 및 크리에이터 정보와 같이 자산 콘텐츠의 일부가 아닌 생성 컨텍스트. 자산 생성에 필요합니다.

moderationResult object

자산의 조정 결과.

path string

자산 버전의 반환된 리소스 경로. 형식: assets/{assetId}/versions/{version} . 예: assets/2205400862/versions/1 .

필요한 권한

이 엔드포인트를 호출하려면 다음 API 키 권한이 필요합니다. 적절한 키 생성에 대한 자세한 내용은 API 키 관리에서 확인하세요.

  • 읽기

한도

각 API 키별: IP 주소당 60초마다 100 요청

보관 자산

POST /v1/assets/{assetId}:archive

자산을 보관합니다.보관된 자산은 웹사이트에서 사라지고 Roblox 경험에서 더 이상 사용할 수 없거나 표시할 수 없지만, 복원할 수 있습니다.

매개 변수

assetId string

자산의 고유 식별자.

Path
필수

요청

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

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

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

응답

200 - OK
자산이 성공적으로 보관되었습니다.
반환: object
assetId number

자산의 고유 식별자. 자산 업데이트에 필요합니다.

assetType string

자산 입력. Audio , Decal 또는 Model 만 사용할 수 있습니다. 자산 생성에 필요합니다.

creationContext object

메타데이터 및 크리에이터 정보와 같이 자산 콘텐츠의 일부가 아닌 생성 컨텍스트. 자산 생성에 필요합니다.

description string

자산의 설명. 1000자 제한. 자산 생성에 필요합니다.

displayName string

자산의 표시 이름. 자산 생성에 필요합니다.

icon string

아이콘의 리소스 경로.

moderationResult object

자산의 조정 결과.

path string

자산의 반환된 리소스 경로. 형식: assets/{assetId} . 예: assets/2205400862 .

previews array<object>

미리 보기 목록, 각각 자산 경로와 alt 텍스트가 있습니다. 미리 보기는 이미지 자산이어야 합니다.

revisionCreateTime string

현재 리뷰의 생성 시간戳.

revisionId string

자산의 버전 ID.versionNumber와 동일합니다.자산의 모든 변경은 자동으로 새 버전을 커밋합니다.형식은 정수 문자열입니다.예: 1.

socialLink object

자산에 대한 소셜 미디어 링크.자산당 최대 3개.개체 이름은 다음 중 하나일 수 있습니다: 형식에 대해서는 업데이트 요청의 샘플을 참조하십시오: 자산 업데이트 참조하십시오.

state string

자산이 활성화되었거나 보관되었는지 여부. 지정되지 않은 것은 사용되지 않습니다.

필요한 권한

이 엔드포인트를 호출하려면 다음 API 키 권한이 필요합니다. 적절한 키 생성에 대한 자세한 내용은 API 키 관리에서 확인하세요.

  • 읽기

  • 쓰기

한도

각 API 키별: IP 주소당 60초마다 100 요청

자산 복원

POST /v1/assets/{assetId}:restore

보관된 자산을 복원합니다.

매개 변수

assetId string

자산의 고유 식별자.

Path
필수

요청

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

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

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

응답

200 - OK
자산이 성공적으로 복원되었습니다.
반환: object
assetId number

자산의 고유 식별자. 자산 업데이트에 필요합니다.

assetType string

자산 입력. Audio , Decal 또는 Model 만 사용할 수 있습니다. 자산 생성에 필요합니다.

creationContext object

메타데이터 및 크리에이터 정보와 같이 자산 콘텐츠의 일부가 아닌 생성 컨텍스트. 자산 생성에 필요합니다.

description string

자산의 설명. 1000자 제한. 자산 생성에 필요합니다.

displayName string

자산의 표시 이름. 자산 생성에 필요합니다.

icon string

아이콘의 리소스 경로.

moderationResult object

자산의 조정 결과.

path string

자산의 반환된 리소스 경로. 형식: assets/{assetId} . 예: assets/2205400862 .

previews array<object>

미리 보기 목록, 각각 자산 경로와 alt 텍스트가 있습니다. 미리 보기는 이미지 자산이어야 합니다.

revisionCreateTime string

현재 리뷰의 생성 시간戳.

revisionId string

자산의 버전 ID.versionNumber와 동일합니다.자산의 모든 변경은 자동으로 새 버전을 커밋합니다.형식은 정수 문자열입니다.예: 1.

socialLink object

자산에 대한 소셜 미디어 링크.자산당 최대 3개.개체 이름은 다음 중 하나일 수 있습니다: 형식에 대해서는 업데이트 요청의 샘플을 참조하십시오: 자산 업데이트 참조하십시오.

state string

자산이 활성화되었거나 보관되었는지 여부. 지정되지 않은 것은 사용되지 않습니다.

필요한 권한

이 엔드포인트를 호출하려면 다음 API 키 권한이 필요합니다. 적절한 키 생성에 대한 자세한 내용은 API 키 관리에서 확인하세요.

  • 읽기

  • 쓰기

한도

각 API 키별: IP 주소당 60초마다 100 요청

작업 가져오기

GET /v1/operations/{operationId}

반환된 작업 ID를 사용하여 자산 생성 또는 업데이트의 결과를 가져옵니다.API 키 권한에 대한 읽기 와 OAuth 2.0 앱에 대한 자산:읽기 가 필요합니다.

매개 변수

operationId string

작업의 고유 식별자.

Path
필수

요청

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

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

응답

200 - OK
작업 결과가 성공적으로 검색되었습니다.
반환: object
done boolean

false 이면 작업이 계속 진행 중입니다. true 이면 작업이 완료됩니다.

error object

오류 상태를 설명하는 논리적 오류 모델.

metadata object

임의의 직렬화된 메시지와 함께 직렬화된 메시지의 유형을 설명하는 @type를 포함합니다.

path string

서버에서 할당된 리소스 경로. 기본 형식은 operations/{operation_id} 입니다.

response object

임의의 직렬화된 메시지와 함께 직렬화된 메시지의 유형을 설명하는 @type를 포함합니다.

필요한 권한

이 엔드포인트를 호출하려면 다음 API 키 권한이 필요합니다. 적절한 키 생성에 대한 자세한 내용은 API 키 관리에서 확인하세요.

  • 읽기

한도

각 API 키별: IP 주소당 60초마다 100 요청

개체

다음 개체는 수락되거나 반환되는 페이로드를 설명합니다. 이러한 개체가 사용되는 시기에 대한 자세한 정보는 각 개별 끝점을 참고하세요.

Any

임의의 직렬화된 메시지와 함께 직렬화된 메시지의 유형을 설명하는 @type를 포함합니다.

특성

@type string

직렬화된 메시지의 유형.

Asset

자산을 나타냅니다.

특성

assetId number

자산의 고유 식별자. 자산 업데이트에 필요합니다.

assetType string

자산 입력. Audio , Decal 또는 Model 만 사용할 수 있습니다. 자산 생성에 필요합니다.

creationContext object

메타데이터 및 크리에이터 정보와 같이 자산 콘텐츠의 일부가 아닌 생성 컨텍스트. 자산 생성에 필요합니다.

description string

자산의 설명. 1000자 제한. 자산 생성에 필요합니다.

displayName string

자산의 표시 이름. 자산 생성에 필요합니다.

icon string

아이콘의 리소스 경로.

moderationResult object

자산의 조정 결과.

path string

자산의 반환된 리소스 경로. 형식: assets/{assetId} . 예: assets/2205400862 .

previews array<object>

미리 보기 목록, 각각 자산 경로와 alt 텍스트가 있습니다. 미리 보기는 이미지 자산이어야 합니다.

revisionCreateTime string

현재 리뷰의 생성 시간戳.

revisionId string

자산의 버전 ID.versionNumber와 동일합니다.자산의 모든 변경은 자동으로 새 버전을 커밋합니다.형식은 정수 문자열입니다.예: 1.

socialLink object

자산에 대한 소셜 미디어 링크.자산당 최대 3개.개체 이름은 다음 중 하나일 수 있습니다: 형식에 대해서는 업데이트 요청의 샘플을 참조하십시오: 자산 업데이트 참조하십시오.

state string

자산이 활성화되었거나 보관되었는지 여부. 지정되지 않은 것은 사용되지 않습니다.

AssetVersion

자산 버전.

특성

creationContext object

메타데이터 및 크리에이터 정보와 같이 자산 콘텐츠의 일부가 아닌 생성 컨텍스트. 자산 생성에 필요합니다.

moderationResult object

자산의 조정 결과.

path string

자산 버전의 반환된 리소스 경로. 형식: assets/{assetId}/versions/{version} . 예: assets/2205400862/versions/1 .

CreationContext

메타데이터 및 크리에이터 정보와 같이 자산 콘텐츠의 일부가 아닌 생성 컨텍스트. 자산 생성에 필요합니다.

특성

creator object

크리에이터나타냅니다.

필수
expectedPrice number

Robux의 예상 자산 업로드 비용. 실제 가격이 예상보다 높으면 작업이 400 오류로 실패합니다.

Creator

크리에이터나타냅니다.

특성

groupId number

그룹 ID. 자산이 그룹 소유인 경우 필요합니다.

userId number

크리에이터의 사용자 ID. 자산이 개인 사용자 소유인 경우 필요합니다.

ModerationResult

자산의 조정 결과.

특성

moderationState string

자산의 조정 상태. Reviewing , Rejected 또는 Approved 일 수 있습니다.

Operation

이 리소스는 네트워크 API 호출의 결과인 장기 실행 작업을 나타냅니다.

특성

done boolean

false 이면 작업이 계속 진행 중입니다. true 이면 작업이 완료됩니다.

error object

오류 상태를 설명하는 논리적 오류 모델.

metadata object

임의의 직렬화된 메시지와 함께 직렬화된 메시지의 유형을 설명하는 @type를 포함합니다.

path string

서버에서 할당된 리소스 경로. 기본 형식은 operations/{operation_id} 입니다.

response object

임의의 직렬화된 메시지와 함께 직렬화된 메시지의 유형을 설명하는 @type를 포함합니다.

Preview

자산 미리 보기.

특성

altText string

미리 보기 자산에 대한 대체 텍스트.

asset string

미리 보기 자산 경로.

자산에 대한 소셜 미디어 링크.자산당 최대 3개.개체 이름은 다음 중 하나일 수 있습니다: 형식에 대해서는 업데이트 요청의 샘플을 참조하십시오: 자산 업데이트 참조하십시오.

특성

title string

소셜 미디어 연결선택적 제목. 크리에이터 허브에서 사용되지 않음.

uri string

소셜 미디어 연결URI.연결유형의 예상 형식과 일치해야 합니다.예를 들어, twitchSocialLink 개체의 제목은 형식 https://twitch.tv/your-channel 이어야 합니다.

State

자산이 활성화되었거나 보관되었는지 여부. 지정되지 않은 것은 사용되지 않습니다.

특성

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

Status

오류 상태를 설명하는 논리적 오류 모델.

특성

code number

HTTP 상태 코드.

details array<object>

오류 세부 정보를 포함하는 메시지 목록.

message string

오류 메시지.