Introduction
Welcome to the BGplus API documentation. Use our REST API to programmatically create, manage, and delete your hosted transcripts.
Base URL
https://bgplus.robbiee.com/api/v1
Format
JSON
Version
v1
The Transcript Object
Most API endpoints return a transcript object. Below are all possible parameters that may be included in the response.
| Parameter | Type | Description |
|---|---|---|
| id | string | The unique internal ID for the transcript. |
| slug | string | The unique slug (or uuid) used in the hosted URL. |
| url | string | The public hosted URL for the transcript. |
| name | string | The display name of the transcript. |
| createdAt | number | Unix timestamp (ms) of creation. |
| isProtected | boolean | Whether password protection is active. |
| password | string | The transcript password (if applicable). |
| requiredRoles | array | The Discord roles required to view this transcript. |
| pathPrefix | string | The processed path prefix used for the transcript's URLs. |
| success | boolean | Status of the request (for mutations). |
| dry_run | boolean | True if the request was a dry-run. |
Example Response
json
{
"id": "j57abc123...",
"slug": "my-transcript-slug",
"url": "https://bgplus.robbiee.com/tr/my-transcript-slug",
"name": "General Chat",
"createdAt": 1708213200000,
"isProtected": true,
"password": "example_password",
"requiredRoles": ["123456789012345678"],
"pathPrefix": "test-project/2026-02-26",
"success": true,
"dry_run": false
}