Skip to content
ScreenApp Logo ScreenApp Docs

Overview

ScreenApp’s API and SDK allow you to ingest video and audio media, apply transformations, and consume the results programmatically.

Key Capabilities

  1. Upload API – Upload media files over HTTP, either as a single file or in chunks.
  2. Agents API – Interact with meeting bots for platforms like Google Meet, Microsoft Teams, and Zoom to capture and transform sessions.
  3. Templates API – Convert captured content into predefined, structured formats.
  4. Webhooks API – Trigger custom actions based on content transformation events.

The API is available for Business and Entreprise plans. API keys can be generated by users with the Owner or Admin role.

OpenAPI Specification

You can explore the full OpenAPI specification at: https://api.screenapp.io/v2/spec

Generating API Keys

All API requests must include an Authorization header with a Bearer token:

Authorization: Bearer sk-xxxxx

Follow the steps below to generate your API key:

  1. Log in to ScreenApp as an Admin or Team Owner.
  2. Visit screenapp.io/app/#/settings/api.
  3. Navigate to the API section.
  4. Create a new API key and assign the appropriate scopes.

Client SDKs

Currently, ScreenApp provides a TypeScript/JavaScript SDK that supports both browser and Node.js environments.

Installation

Terminal window
npm i --save @screenapp/client

Usage

import ScreenAppClient from '@screenapp/client';


const sdk = new ScreenAppClient({
  token: 'your-auth-token', // Required
  baseUrl: 'https://api.screenapp.io', // Optional, defaults to this value
});