Starting and Stopping MediaScribe With The API
August 21, 2025
Creating An API Token
To use the MediaScribe API you will first need an API Token. The api tokens are used to authenticate api requests independent of the MediaScribe user system. To create an API token:
- Navigate to Settings in the navigation menu on the left hand side of the MediaScribe user interface.
- Choose the Configuration tab and then click Manage from the Authentication section.
- Click + New API Token to create a new API Token
- Give the token a useful name that describes the project you will be using it on, such as "Control Panel".
- Click Create Token to generate the token.
- Save your token for use in your project.
Don't Loose Your Token
You can generate as many API Tokens as you want, and revoke them whenever you want, we MediaScribe will never show you the API token again. So keep your API token's safe.
Using The API
Work In Progress
This API is currently a work in progress. We'll do our best not to break anything, but were probably going to make it a bit nicer in the near future. Please check back on this article or email support@mediascribe.ai for updates.
Getting Status
Request
Javascript
1
2
3
4
5
6
7
8
const response = fetch("http://example.com/api/control/status", {
headers: {
"accept": "application/json",
"authorization": "Bearer api-token"
}
});
const json = await response.json();Ready Response
JSON
1
2
3
4
5
6
7
8
9
10
11
{
"siteName": "Your City's MediaScribe",
"presets": [
{
"id": "aa638eeb-854b-4e14-87a5-500be376f948",
"name": "Default"
}
],
"activePresetId": "aa638eeb-854b-4e14-87a5-500be376f948",
"hasNoSignal": false
}Recording Response
JSON
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"siteName": "Your City's MediaScribe",
"presets": [
{
"id": "aa638eeb-854b-4e14-87a5-500be376f948",
"name": "Default"
}
],
"activePresetId": "aa638eeb-854b-4e14-87a5-500be376f948",
"hasNoSignal": false,
"recording": {
"position": 4,
"path": "E:\\recordings\\New Meeting 2025-08-21T19-05-37.170Z\\New Meeting 2025-08-21T19-05-37.170Z.mp4"
}
}Start Transcribing
Javascript
1
2
3
4
5
6
7
8
9
10
11
const response = fetch("http://example.com/api/control/status", {
method: "PUT",
body: JSON.stringify({action: "start"}),
headers: {
"accept": "application/json",
"content-type": "application/json",
"authorization": "Bearer api-token"
}
});
const json = await response.json();Stop Transcribing
Javascript
1
2
3
4
5
6
7
8
9
10
11
const response = fetch("http://example.com/api/control/status", {
method: "PUT",
body: JSON.stringify({action: "stop"}),
headers: {
"accept": "application/json",
"content-type": "application/json",
"authorization": "Bearer api-token"
}
});
const json = await response.json();