VRCHIVE API Documentation

Integrate in minutes with the Unity SDK

VRCHIVE API v1 allows VR developers and their users to stream VR photos. This is more convenient than manually uploading to VRCHIVE.

An API Key is required for VR developers and an API Secret is required for end users.

API Key

An API Key is a unique string that identifies a VRCHIVE project. Create a project.

API Secret

An API Secret is a unique string that identifies a VRCHIVE user account.

API call

Request method

VRCHIVE API calls can be done using the POST request methods.

Request URL

http://vrchive.com/gameapi/1/<action>/

Parameters

  • key The API v1 key, it can be found and reset @ vrchive.com/settings/projects
  • secret A user's secret can be found in user settings.
  • action What you want to do [values: upload].
  • source A base64 encoded image string. You can also use FILES["source"] in your request.
  • format Sets the return format [values: json]

Example call

POST http://vrchive.com/gameapi/1/upload/?key=12345&secret=678910&source=http://somewebsite/someimage.jpg&format=json

API response

When using JSON the response will have headers status codes to allow you to easily notice if the request was OK or not. It will also output the status_txt and status_code properties.

Example response (JSON)

{
                "status_code": 200,
                "success": {
                        "message": "image uploaded",
                        "code": 200
                },
                "image": {
                        "name": "example",
                        "extension": "png",
                        "size": 53237,
                        "width": 1151,
                        "height": 898,
                        "date": "2014-06-04 15:32:33",
                        "date_gmt": "2014-06-04 19:32:33",
                        "storage_id": null,
                        "description": null,
                        "nsfw": "0",
                        "md5": "c684350d722c956c362ab70299735830",
                        "storage": "datefolder",
                        "original_filename": "example.png",
                        "original_exifdata": null,
                        "views": "0",
                        "id_encoded": "L",
                        "filename": "example.png",
                        "ratio": 1.2817371937639,
                        "size_formatted": "52 KB",
                        "mime": "image/png",
                        "bits": 8,
                        "channels": null,
                        "url": "http://127.0.0.1/images/2014/06/04/example.png",
                        "url_viewer": "http://127.0.0.1/image/L",
                        "thumb": {
                                "filename": "example.th.png",
                                "name": "example.th",
                                "width": 160,
                                "height": 160,
                                "ratio": 1,
                                "size": 17848,
                                "size_formatted": "17.4 KB",
                                "mime": "image/png",
                                "extension": "png",
                                "bits": 8,
                                "channels": null,
                                "url": "http://127.0.0.1/images/2014/06/04/example.th.png"
                        },
                        "medium": {
                                "filename": "example.md.png",
                                "name": "example.md",
                                "width": 500,
                                "height": 390,
                                "ratio": 1.2820512820513,
                                "size": 104448,
                                "size_formatted": "102 KB",
                                "mime": "image/png",
                                "extension": "png",
                                "bits": 8,
                                "channels": null,
                                "url": "http://127.0.0.1/images/2014/06/04/example.md.png"
                        },
                        "views_label": "views",
                        "display_url": "http://127.0.0.1/images/2014/06/04/example.md.png",
                        "how_long_ago": "moments ago"
                },
                "status_txt": "OK"
     }

Aenean Consectetur Porta

Nullam quis risus eget urna mollis ornare vel eu leo.

Aenean Consectetur

Cay sociis nato que penatibus et

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse varius enim in eros elementum tristique.

ConsectUltricies

Amet Ipsum

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse varius enim in eros elementum tristique.

Aenean Consectetur Porta

Magna Porta Sit Bibendum

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse varius enim in eros elementum tristique.

Aenean Consectetur Porta

Sem Risus Elit Vestibulum

Nulla vitae elit libero, a pharetra augue. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Cras mattis consectetur purus sit amet fermentum. Donec id elit non mi porta gravida at eget metus. Etiam porta sem malesuada magna mollis euismod.

Aenean Consectetur Porta

Parturient Tortor

Nulla vitae elit libero, a pharetra augue. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Cras mattis consectetur purus sit amet fermentum. Donec id elit non mi porta gravida at eget metus. Etiam porta sem malesuada magna mollis euismod.

Ready to get started?

Stay in the loop

Follow us on social media