Skip to main content

Usage

Listing prerecordings​

You can list prerecordings using the /prerecordings/:event endpoint. For example, you can use curl to list all prerecordings for an event:

curl --request GET http://localhost:10600/prerecordings/0f339cb0-7ab4-43fe-852d-75708232f76c

Uploading and downloading prerecordings​

You can upload and download prerecordings using the /prerecordings/:event/:start endpoint. To upload a prerecording, you can use curl to send a PUT request streaming the content from a file:

curl \
    --request PUT \
    --header "Content-Type: audio/ogg" \
    --header "Transfer-Encoding: chunked" \
    --upload-file prerecording.ogg \
    http://localhost:10600/prerecordings/0f339cb0-7ab4-43fe-852d-75708232f76c/2024-01-01T00:00:00

To download a prerecording, you can use curl to send a GET request and save the response body to a file:

curl --request GET --output prerecording.ogg http://localhost:10600/prerecordings/0f339cb0-7ab4-43fe-852d-75708232f76c/2024-01-01T00:00:00

Deleting prerecordings​

You can delete prerecordings using the /prerecordings/:event/:start endpoint. For example, you can use curl to delete a prerecording:

curl --request DELETE http://localhost:10600/prerecordings/0f339cb0-7ab4-43fe-852d-75708232f76c/2024-01-01T00:00:00

Ping​

You can check the status of the service by sending either a GET or HEAD request to the /ping endpoint. The service should respond with a 204 No Content status code.

For example, you can use curl to do that:

curl --request HEAD --head http://localhost:10600/ping

Server-Sent Events​

You can subscribe to Server-Sent Events (SSE) by sending a GET request to the /sse endpoint. The service should send you the events as they happen.

For example, you can use curl to do that:

curl --request GET --no-buffer http://localhost:10600/sse

OpenAPI​

You can view the OpenAPI documentation made with Scalar by navigating to the /openapi endpoint in your browser.

You can also download the specification in JSON format by sending a GET request to the /openapi/openapi.json endpoint.

For example, you can use curl to do that:

curl --request GET http://localhost:10600/openapi/openapi.json