Skip to main content

Stream status

Get live caption stream status over the API

Written by James

Before you get started make sure to create an API key in your CaptionKit dashboard and read up on the API authentication.

Checking your stream status

GET /me/status

Using curl

curl -X POST https://api.captionkit.com/v2/me/status?key={API_KEY} -H

Using fetch in JS or Node

fetch(`https://api.captionkit.com/v2/me/status?key=${API_KEY}`)

Response

{
"live": true,
"status": {
"live": true,
"sessionId": "2355239b-578f-4bca-bfa5-8cd544633967",
"accountId": "9c9a80c2-ee91-4590-a83a-cf2a454893c3",
"startedAt": 1783005063199,
"lastSeen": 1783005063607,
"options": {
"language": "en-US",
"translations": [
"es-419"
],
"interimResults": true,
"profanityFilter": true
}
}
}

Did this answer your question?