VRChatBackendDocs/Apis/PrintsApi.md

PrintsApi

All URIs are relative to https://api.vrchat.cloud/api/1

Method	HTTP request	Description
deletePrint	DELETE /prints/{printId}	Delete Print
editPrint	POST /prints/{printId}	Edit Print
getPrint	GET /prints/{printId}	Get Print
getUserPrints	GET /prints/user/{userId}	Get Own Prints
uploadPrint	POST /prints	Upload Print

deletePrint

deletePrint(printId)

Delete Print

Returns a print.

Parameters

Name	Type	Description	Notes
printId	String	Print ID.	[default to null]

Return type

null (empty response body)

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

editPrint

Print editPrint(printId, image, note)

Edit Print

Edits a print.

Parameters

Name	Type	Description	Notes
printId	String	Print ID.	[default to null]
image	File	The binary blob of the png file.	[default to null]
note	String	The caption for the image.	[optional] [default to null]

Return type

Print

Authorization

authCookie

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

getPrint

Print getPrint(printId)

Get Print

Returns a print.

Parameters

Name	Type	Description	Notes
printId	String	Print ID.	[default to null]

Return type

Print

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getUserPrints

List getUserPrints(userId)

Get Own Prints

Returns a list of all prints of the user. User id has to be your own userId, as you can't request other user's prints.

Parameters

Name	Type	Description	Notes
userId	String	Must be a valid user ID.	[default to null]

Return type

List

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

uploadPrint

Print uploadPrint(image, timestamp, note, worldId, worldName)

Upload Print

Uploads and creates a print.

Parameters

Name	Type	Description	Notes
image	File	The binary blob of the png file.	[default to null]
timestamp	Date	The time the image was captured.	[default to null]
note	String	The caption for the image.	[optional] [default to null]
worldId	String	The id of the world in which the image was captured.	[optional] [default to null]
worldName	String	The name of the world in which the image was captured.	[optional] [default to null]

Return type

Print

Authorization

authCookie

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json