VRoid Hub API reference

English

日本語

English

日本語

Appearance

Load a character model ​

Type information ​

Download license type ​

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

Issue download license ​

POST: /api/download_licenses

X-Api-Version

Required: YES

  • This is the VRoid Hub API version. The current version is version 11.

Request parameters ​

character_model_id

Required: Yes
Type: string

  • Model ID of the character you would like to load

Response ​

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"]

Acquire download license information ​

GET: /api/download_licenses/{id}

Header ​

X-Api-Version

Required: YES

  • This is the VRoid Hub API version. The current version is version 11.

Parameter ​

ID

Required: Yes
Type: string

  • Download license ID

Response ​

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"]

Invalidate download license ​

DELETE: /api/download_licenses/{id}

Header ​

X-Api-Version

Required: YES

  • This is the VRoid Hub API version. The current version is version 11.

Parameter ​

ID

Required: Yes
Type: string

  • Download license ID

Response ​

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"]

Load character model linked to download license ​

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

Header ​

X-Api-Version

Required: YES

  • This is the VRoid Hub API version. The current version is version 11.

Parameter ​

ID

Required: Yes
Type: string

  • Download license ID

Response ​

302

  • Redirect to download URL (AWS S3 presigned URL)

401

["OAUTH_UNAUTHORIZED: OAuth unauthorized"]

403

["OAUTH_FORBIDDEN: OAuth forbidden"]

404

["COMMON_NOT_FOUND: not found"]

Issue download license that allows use by persons other than the issuer (Multiplay only) ​

POST: /api/download_licenses/multiplay

Header ​

X-Api-Version

Required: YES

  • This is the VRoid Hub API version. The current version is version 11.

Request parameters ​

character_model_id

Required: Yes
Type: string

  • Model ID of the character you would like to load

Response ​

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"]

Copyright © pixiv