キャラクターモデルの読み込み

型情報

ダウンロードライセンス関連の型

type DownloadLicense = {
  id: string;
  character_model_id: string;
  character_model_version_id: string;
  is_public_visibility: boolean;
  is_private_visibility: boolean;
  expires_at: string;
}

ダウンロードライセンスの発行

POST: /api/download_licenses

ヘッダー

---

X-Api-Version

必須: YES

• VRoid HubのAPIバージョンです。現行バージョンは 11 になります。

リクエストパラメータ

---

character_model_id

必須: Yes
型: string

• 読み込みたいキャラクターモデルのid

---

レスポンス

200

{
  "data": DownloadLicense,
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "_links": {
    "next": {
      "href": "string"
    }
  },
  "rand": "string"
}

401

[
  "OAUTH_UNAUTHORIZED: OAuth unauthorized",
  "OAUTH_AUTHORIZATION_REQUIRED: OAuth authorization required",
  "COMMON_SIGNED_IN_REQUIRED: signed in required"
]

403

["OAUTH_FORBIDDEN: OAuth forbidden"]

404

["COMMON_NOT_FOUND: not found"]

ダウンロードライセンス情報の取得

GET: /api/download_licenses/{id}

ヘッダー

---

X-Api-Version

必須: YES

• VRoid HubのAPIバージョンです。現行バージョンは 11 になります。

パラメータ

---

id

必須: Yes
型: string

• ダウンロードライセンスのid

---

レスポンス

200

{
  "data": DownloadLicense,
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "_links": {
    "next": {
      "href": "string"
    }
  },
  "rand": "string"
}

401

[
  "OAUTH_UNAUTHORIZED: OAuth unauthorized",
  "OAUTH_AUTHORIZATION_REQUIRED: OAuth authorization required"
]

403

["OAUTH_FORBIDDEN: OAuth forbidden"]

404

["COMMON_NOT_FOUND: not found"]

ダウンロードライセンスの無効化

DELETE: /api/download_licenses/{id}

ヘッダー

---

X-Api-Version

必須: YES

• VRoid HubのAPIバージョンです。現行バージョンは 11 になります。

パラメータ

---

id

必須: Yes
型: string

• ダウンロードライセンスのid

---

レスポンス

200

{
  "data": {},
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "_links": {
    "next": {
      "href": "string"
    }
  },
  "rand": "string"
}

401

[
  "OAUTH_UNAUTHORIZED: OAuth unauthorized",
  "COMMON_SIGNED_IN_REQUIRED: signed in required"
]

403

["OAUTH_FORBIDDEN: OAuth forbidden"]

404

["COMMON_NOT_FOUND: not found"]

ダウンロードライセンスに紐づいたキャラクターモデルの読み込み

GET: /api/download_licenses/{id}/download

ヘッダー

---

X-Api-Version

必須: YES

• VRoid HubのAPIバージョンです。現行バージョンは 11 になります。

パラメータ

---

id

必須: Yes
型: string

• ダウンロードライセンスのid

---

レスポンス

302

• ダウンロードURL（AWS S3のpresigned URL）へリダイレクト

401

["OAUTH_UNAUTHORIZED: OAuth unauthorized"]

403

["OAUTH_FORBIDDEN: OAuth forbidden"]

404

["COMMON_NOT_FOUND: not found"]

発行者以外も利用可能なダウンロードライセンスの発行（マルチプレイ専用）

POST: /api/download_licenses/multiplay

ヘッダー

---

X-Api-Version

必須: YES

• VRoid HubのAPIバージョンです。現行バージョンは 11 になります。

リクエストパラメータ

---

character_model_id

必須: Yes
型: string

• 読み込みたいキャラクターモデルのid

---

レスポンス

200

{
  "data": DownloadLicense,
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "_links": {
    "next": {
      "href": "string"
    }
  },
  "rand": "string"
}

401

[
  "OAUTH_UNAUTHORIZED: OAuth unauthorized",
  "OAUTH_AUTHORIZATION_REQUIRED: OAuth authorization required",
  "COMMON_SIGNED_IN_REQUIRED: signed in required"
]

403

["OAUTH_FORBIDDEN: OAuth forbidden"]

404

["COMMON_NOT_FOUND: not found"]