OnlineVidRecorder API Documentation

Integrate video recording capabilities directly into your applications with our powerful REST API

Authentication

All API requests require an API key sent in the X-API-Key header.

Recording Endpoints

POST /api/v1/recordings

Create a new recording session. Returns a unique recording ID and access token.

Request Parameters

Parameter	Type	Required	Description
title	string	Optional	Title for the recording (max 120 chars)
max_duration	integer	Optional	Maximum recording duration in seconds (default: 600, max: 7200 for Pro accounts)
resolution	string	Optional	Recording resolution (options: "480p", "720p", "1080p", default: "720p")
enable_screen	boolean	Optional	Whether to enable screen recording (default: false)
enable_camera	boolean	Optional	Whether to enable camera recording (default: true)

Example Request

                    curl -X POST https://api.freescreenrec.com/api/v1/recordings \

                    -H "X-API-Key: your_api_key_here" \

                    -H "Content-Type: application/json" \

                    -d '{"title": "My Tutorial", "max_duration": 1800, "resolution": "1080p", "enable_screen": true}'

Example Response

                        {

                          "success": true,

                          "data": {

                            "recording_id": "rec_abc123def456",

                            "access_token": "tok_xyz789uvw012",

                            "expires_at": "2023-12-31T23:59:59Z",

                            "embed_url": "https://FreeScreenRec.com/embed/rec_abc123def456"

                          }

                        }

GET /api/v1/recordings/{recording_id}

Retrieve information about a specific recording.

Path Parameters

Parameter	Type	Required	Description
recording_id	string	Required	The ID of the recording to retrieve

Example Request

                    curl -X GET https://api.freescreenrec.com/api/v1/recordings/rec_abc123def456 \

                    -H "X-API-Key: your_api_key_here"

Video Management

GET /api/v1/videos

List all videos in your account. Supports pagination and filtering.

Query Parameters

Parameter	Type	Required	Description
page	integer	Optional	Page number for pagination (default: 1)
per_page	integer	Optional	Number of items per page (default: 20, max: 100)
status	string	Optional	Filter by status ("processing", "ready", "failed")
created_after	string	Optional	Filter videos created after this date (ISO 8601 format)

DELETE /api/v1/videos/{video_id}

Delete a video from your account. This action is irreversible.

Webhooks

Configure webhooks to receive real-time notifications about recording events.

POST /api/v1/webhooks

Available Events

recording.started - When a new recording session begins
recording.completed - When recording finishes
recording.processing - When recording is being processed
recording.ready - When recording is available for download
recording.failed - When recording fails