REST API/OVERVIEW
Introduction
Use the EdithPro REST API to manage recordings, screenshots, transcripts and AI documents from your own backend.
On this page
Draft. Endpoints, parameters and responses on these pages are examples to review and confirm before launch.
Base URL #
base url
https://api.edithpro.app/v1Who can use it #
The REST API is part of the Enterprise plan. For recording inside your own web app, use the SDK instead.
What you can do #
AreaEndpoints
RecordingsList, get, update, delete, upload a file, get viewer analytics
ScreenshotsUpload, list, get
Transcripts and AITranscript in JSON, SRT, VTT or text; chapters; summary
DocumentsGenerate any of the 26 document types, get, export as PDF or Markdown
Folders and membersList and create folders, list and invite members
Requests and commentsCreate request-a-video links, read and add comments
WebhooksGet notified when recordings, transcripts and documents are ready
Conventions #
- Requests and responses are JSON, except file uploads, which use multipart/form-data.
- Timestamps are ISO 8601 in UTC.
- IDs have a prefix that tells you the type: rec_, shot_, doc_, fld_, usr_, req_.
- Durations are in seconds.
Was this page helpful? REST API v1 draft · Edit this page