Getting Started
Authentication
All endpoints require an API key in the Authorization header.
curl -X GET "https://api.elmira.aws/1.0/health" \
-H "Authorization: Bearer YOUR_API_KEY"
Base URL
The API is available at the following endpoints:
-
https://api.elmira.aws/1.0/ -
https://dev.api.elmira.aws/1.0/
Available Endpoints
1. Create Real-Time Session
POST /1.0/sessions
Creates a new real-time collaboration session with CRDT capabilities.
HTTP/1.1 201 Created
Headers
Authorization: Bearer YOUR_API_KEY Content-Type: application/json
Request Body
{
"type": "document",
"participants": 2,
"ttl": 3600
}
Response Example
{
"session_id": "sess-4c5d2e7a",
"type": "document",
"url": "wss://ws.elmira.aws/1.0/sessions/sess-4c5d2e7a",
"participants": 2,
"created_at": "2025-09-07T12:34:56Z",
" expires_at": "2025-09-07T13:34:56Z"
}
2. Get Session Information
GET /1.0/sessions/:session_id.info
Retrieve metadata and status for an existing session.
HTTP/1.1 200 OK
Headers
Authorization: Bearer YOUR_API_KEY Accept: application/json
Path Parameters
{
"session_id": "sess-4c5d2e7a"
}
3. Terminate Session
DELETE /1.0/sessions/:session_id
Immediately terminates a session and all its participants.
HTTP/1.1 204 No Content
Headers
Authorization: Bearer YOUR_API_KEY
Path Parameters
{
"session_id": "sess-4c5d2e7a"
}