Skip to main content
Infrastructure

APIApplication Programming Interface

An API (Application Programming Interface) is the entry point that lets external software talk to a video platform by code rather than through its web interface: upload a file, trigger playback, list assets or sync metadata. It is what lets an LMS, a CRM or an automation script plug into video management without a human clicking through it.

Why a video API

A web interface is enough for occasional use; an API becomes necessary once another system needs to act on videos without a human in the loop. Three uses come up most often.

  • Automatic import from an LMS, a CRM or an editing tool
  • Metadata sync between the video platform and another system
  • Pulling statistics into an internal dashboard
  • Automating a publishing workflow (going live, updating, deleting)

REST API and SDKs

A video API is used two ways: direct HTTP calls to the REST API, or an SDK that wraps those calls in the language you're using. The choice mostly comes down to how often it's called and whether you need features like resuming an interrupted upload.

ApproachWhat it gives youBest for
REST APIDirect HTTP calls, nothing to installOne-off scripts, languages without a dedicated SDK
SDKReady-made functions, error handling and large uploads handled for youLasting integrations in JavaScript, TypeScript or Python

The Videas API

The Videas API is exposed at `https://app.videas.com/api/external/` and authenticated with a personal token, sent as an `Authorization: Bearer` header. Each token is created from Settings → API access, with scopes shaped `<resource>:<action>` — `assets:read`, `files:write`, and so on — and a configurable expiry, so the token can follow the principle of least privilege. It covers uploading files, playback, the domains allowed to embed the player, and folder management. Uploads use the resumable TUS protocol, so an interrupted transfer picks up where it stopped rather than starting over. Two SDKs wrap these calls — `@videas/sdk` for JavaScript and TypeScript, `videas-sdk` for Python — but the REST API on its own is enough for plain HTTP calls. The interactive documentation, generated from the code (OpenAPI), lists every endpoint and lets you test a call directly with your own token. None of it is required: the web interface covers everyday use, and the API is there for what only it can automate.

Frequently asked questions

What does API stand for?+

API stands for Application Programming Interface: the entry point that lets external software talk to a platform by code rather than through its web interface.

Do I need the API to use Videas?+

No. The web interface is enough for everyday use, upload, organizing and sharing included. The API is for what the interface doesn't do: automating, integrating another tool, or acting on videos without manual intervention.

How do you authenticate against the Videas API?+

With a personal token created from Settings → API access, sent on every request in the `Authorization: Bearer <token>` header. The full value is only ever shown once, at creation.

Does the Videas API come with an SDK?+

Two: `@videas/sdk` for JavaScript and TypeScript, `videas-sdk` for Python. The REST API alone works too, with a plain HTTP client and a Bearer token.

What does the Videas API cover?+

Uploading files, playback, the domains allowed to embed the player, and folder management, with granular scopes by resource and action.

What happens if an upload gets interrupted?+

Nothing to redo from scratch: uploads use the resumable TUS protocol, which picks the transfer back up where it left off.

Where can I find the list of available endpoints?+

In the interactive documentation, generated automatically from the code (OpenAPI), so it stays in sync with what the server actually exposes.

Are API tokens shared between colleagues?+

No. Each team member creates their own tokens, tied to their account, which keeps who-did-what traceable and lets one person's access be revoked without breaking anyone else's integration.