Skip to main content
GET
Get Character
Error responses use the same {code, message, data} envelope; a non-zero code identifies the error.

Authorizations

Authorization
string
header
required

Your Vivix API key. Keep it on your server.

Path Parameters

character_id
string
required

Character id.

Response

200 - application/json

Success

code
integer
required

0 on success; any other value is an error code.

message
string
required

success, or an English error description.

data
object
required

The saved character: metadata plus the entire stored configuration. Source image URLs may be rewritten during saving.