Creating a Transcript

In this guide, you will learn how to setup an API Request inside of BotGhost in order to create a HTML transcript for a channel in any of your discord servers directly from your own bot!

To use our service, you firstly must have your own API key. Follow our Getting Your Key guide by clicking here to obtain one. It is completely free of charge to get create one!

1. Use the Send an API Request Block

First off, you need the "Send an API Request" from either your command or event builder.

2. Settings of the API Request

Once you have added the API Request block into your command or event builder, find the labeled section called Name, here you should insert the plain text of transcript. This will allow you to reference the API Request in further actions.

After you have set the name of your request, click the "Request Builder" button. This will open up the builder of your request to our API, here you will need to add all of the required information.

Paste https://api.erensko.xyz/v1/transcript to the URL at the top of the builder.

Make sure to change the Method from GET to POST.

Once you have added the URL into your request's builder, find to the URL Params section. When you have found this section (it opens by default), insert the following values into the table key-value format.

Key	Value
channel-id	The ID of the channel you would like to create a HTML transcript for.

After you have added your URL Params, it's time to finish the request by adding your HTTP Headers. Click on the "HTTP Headers" button and use the following set in the table. Your bot's token is required. To get your bot's token, you will need to reset it from the Discord Developer Portal. You also must have your own API key from us in order for you to send the request.

Key	Value
Authorization	Your own personal API key, learn how to get one by clicking here.
bot-token	Your discord bot's plain token.

3. Retrieving the Transcript Link

If you have correctly followed the guide, you can now retrieve the URL to the transcript you have created by using the following BotGhost variable below:

{transcript.response.url}

You can use this variable anywhere you would like inside of your command or event to get the URL.

Getting Help

Do you need any assistance with setting up your transcript? Feel free to reach out to our support team in our discord server by clicking here to join it!