Get
/api/v1/commands.preview
Fetches the command's preview data or executes the preview item
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Query parameters
command
stringRequired
The name of the command to be executed.
Exampleunmute
roomId
stringRequired
The ID of the room.
ExampleByehQjC44FwMeiLbX
params
string
Parameters of the command if required. It is undefined by default.
Example@user123
Responses
200
OK
Success
{
"success": true
}object
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "You must provide a command to get the previews from."
}object
success
boolean
error
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string