Overview
Preview endpoints allow you to create temporary match data snapshots with a 6-character access code. Previews expire automatically after 10 minutes.
Create Preview
PUT /createPreview
Creates a new match preview and returns a unique preview code.
Request Body
Version of the client creating the preview
Valid API key for authentication. Cannot be null or missing.
Optional custom 6-character preview code. If not provided or invalid, a random code will be generated.
Left team informationTeam tricode (e.g., “SEN”, “FNC”)
Whether team starts on attack side
Right team information (same structure as leftTeam)
Additional tools configuration data
Response
The 6-character preview code (uppercase letters and digits, excluding I and O)
Status Codes
200 - Preview created successfully400 - Missing or invalid key in preview data403 - Invalid or expired API key
Error Responses
{
"error": "Missing or invalid key in preview data"
}
{
"error": "Invalid or expired key"
}
{
"error": "Invalid preview data",
"details": "Detailed error message"
}
Implementation
From src/index.ts:27-29:
app.put("/createPreview", async (req: Request, res: Response) => {
await previewHandler.handlePreviewCreation(req, res);
});
src/util/previews/PreviewHandler.ts:23-67:
public async handlePreviewCreation(req: Request, res: Response) {
try {
const previewData: IPreviewData = req.body;
if (!previewData.key || previewData.key == null) {
return res.status(400).json({ error: "Missing or invalid key in preview data" });
}
const validity: KeyValidity = await this.wsi.isValidKey(previewData.key);
if (!validity.valid) {
return res.status(403).json({ error: "Invalid or expired key" });
}
previewData.organizationId = validity.organizationId;
let previewCode: string = previewData.previewCode;
if (!previewCode || previewCode.length !== 6) {
for (let i = 0; i < 6; i++) {
previewCode += validGroupcodeCharacters.charAt(
Math.floor(Math.random() * validGroupcodeCharacters.length),
);
}
}
const previewMatch = new PreviewMatch(previewData);
this.previews.set(previewCode, previewMatch);
res.status(200).json({ previewCode: previewCode });
// Set a timeout to remove the preview after 10 minutes
const timeout = setTimeout(
() => {
this.previews.delete(previewCode);
this.previewTimeouts.delete(previewCode);
},
10 * 60 * 1000,
);
this.previewTimeouts.set(previewCode, timeout);
return res;
} catch (e: any) {
return res.status(400).json({ error: "Invalid preview data", details: e.message });
}
}
Example Request
curl -X PUT http://localhost:5101/createPreview \
-H "Content-Type: application/json" \
-d '{
"type": "preview",
"clientVersion": "1.0.0",
"key": "your-api-key",
"leftTeam": {
"name": "Team Liquid",
"tricode": "TL",
"url": "https://example.com/tl-logo.png",
"attackStart": true
},
"rightTeam": {
"name": "Fnatic",
"tricode": "FNC",
"url": "https://example.com/fnc-logo.png",
"attackStart": false
},
"toolsData": {}
}'
Example Response
{
"previewCode": "A3K9ZX"
}
Get Preview
GET /preview/:previewCode
Retrieves match preview data using the preview code.
Path Parameters
The 6-character preview code. Must be exactly 6 characters.
Response
Returns the complete preview match object with all match data.
Status Codes
200 - Preview found and returned400 - Invalid preview code format404 - Preview not found or expired
Error Responses
{
"error": "Invalid preview code format"
}
{
"error": "Preview not found"
}
Implementation
From src/index.ts:31-42:
app.get("/preview/:previewCode", async (req: Request, res: Response) => {
const previewCode = req.params.previewCode;
Log.info(`Received request for preview with code: ${previewCode}`);
if (!previewCode || previewCode.length !== 6) {
return res.status(400).json({ error: "Invalid preview code format" });
}
const previewMatch = previewHandler.getPreview(previewCode);
if (!previewMatch) {
return res.status(404).json({ error: "Preview not found" });
}
res.status(200).json(previewMatch);
});
Example Requests
curl http://localhost:5101/preview/A3K9ZX
Preview codes are 6-character strings using uppercase letters and digits, excluding I and O to avoid confusion:
const validGroupcodeCharacters = "ABCDEFGHJKLMNPQRSTUVWXYZ0123456789";
A3K9ZX, HRST23, 9PQWER
Invalid examples: abc123 (lowercase), IOTEST (contains I and O), A3K9 (too short)
Preview Expiration
Previews automatically expire after 10 minutes (600,000 milliseconds):
setTimeout(
() => {
this.previews.delete(previewCode);
this.previewTimeouts.delete(previewCode);
},
10 * 60 * 1000,
);
src/util/previews/PreviewHandler.ts:54-61
If a preview code is reused before expiration, the old timeout is cleared and a new 10-minute timer starts.