Overview
The Vysual API gives your app read-only access to a Vysual customer’s media library (photos, videos, graphics, documents) plus video transcripts. Your users click Connect Vysual in your app, approve access to one or more of their Vysual companies, and your server can then list and download their assets.
The API is read-only. It cannot upload, change, or delete anything, and the consent screen tells users so. Responses are JSON, except transcripts in vtt and txt form.
| Base URL | https://app.vysual.com |
| Auth | OAuth 2.0 + PKCE (S256) |
| Scope | assets:read |
| Version | v1 |
How it works
- Get credentials. Vysual registers your app and sends you a
client_idandclient_secret. - Connect. Your users approve access through the OAuth flow, and your server gets tokens. See Authentication.
- Read. Call the API with the access token to list companies, projects, assets, and transcripts.
- Stay in sync. Poll for new uploads and late transcripts. See Syncing.
Questions about your integration? Contact your Vysual partner contact.