ViGi API Specification

This document outlines the technical specifications for the ViGi API.

1. Introduction

The ViGi API provides programmatic access to ViGi functionality and content. This document is intended for developers who wish to integrate with our platform.

2. Base URL

All API requests should be made to the following base URL:

https://api.vigivideo.com/v2

3. Authentication

The ViGi API uses API keys for authentication.

3.1 Obtaining API Key

To obtain an API Key you must be on a paid plan and visit the https://web.vigivideo.com/settings/api page.

3.2 Using API Keys

Include the API key in the x-api-key header of your requests:

x-api-key: YOUR_API_KEY

Alternativly, include the ?api_key=<YOUR_API_KEY> in GET requests or api_key in the body of post requests.

4. Rate Limiting

The API is rate limited to 10 requests per minute per access token. Rate limit information is included in the response headers:

X-RateLimit-Limit: 10
X-RateLimit-Remaining: 9
X-RateLimit-Reset: 1627924800