Service Status
Check the availability and health of the real-time transcription service.
Endpoint
GET /api/v4/realtime/status
Check if the real-time service is operational before establishing WebSocket connections.
Request
Headers:
Authorization: Bearer YOUR_TOKEN
Example:
curl https://api.scriptix.io/api/v4/realtime/status \
-H "Authorization: Bearer YOUR_TOKEN"
Response
Status Available (200 OK):
{
"status": "available",
"version": "v4",
"models": ["fast", "quality"]
}
Status Unavailable (503 Service Unavailable):
{
"status": "unavailable",
"message": "Service temporarily unavailable"
}
Response Fields
| Field | Type | Description |
|---|---|---|
status | string | Service status: "available" or "unavailable" |
version | string | API version |
models | array | Available model types |
message | string | Error message if unavailable |
Usage
Check status before establishing WebSocket connections to ensure the service is ready.
const response = await fetch('https://api.scriptix.io/api/v4/realtime/status', {
headers: {
'Authorization': 'Bearer YOUR_TOKEN'
}
});
const data = await response.json();
if (data.status === 'available') {
// Proceed with WebSocket connection
}
Related
For complete real-time documentation, see:
- Overview - Complete real-time API guide
- Initialize Session - Create WebSocket session
- WebSocket Connection - Connection details
- Message Protocol - Protocol reference