NAV Navigation
Shell

VideoForm API v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

The VideoForm API is a HTTP JSON API and allows you to programatically generate Images & Videos from the templates created in VideoForm

Terms: Terms of service

Email: Support

Authentication

In order to access the API, you will need to provide an API Key to authenticate with the API server. That API Key will be required for all API requests. You can acquire that token by logging in to your VideoForm Account.

Image

Everything about your Image

getImage

Code samples

# You can also use wget
curl -X GET https://app.videoform.com/api/v1/generateImage \
  -H 'Accept: application/json' \
  -H 'Header: {apiKey}'

GET /api/generateImage

Generates New Image Url

Dynamic Fields Listed Below can be passed as query parameters.

At least 1 dynamic field must be passed in the query parameters.

Parameters

Name Type Required Description
template_id string true Template ID which can be found in the Video Template Editor Page
apiKey string true Pass this in the header
fname string false Pass in Query Parameter
lname string false Pass in Query Parameter
company string false Pass in Query Parameter
logo string false Pass in Query Parameter
title string false Pass in Query Parameter
jobtitle string false Pass in Query Parameter
city string false Pass in Query Parameter
country string false Pass in Query Parameter
email string false Pass in Query Parameter
address string false Pass in Query Parameter
phone string false Pass in Query Parameter
revenue string false Pass in Query Parameter
website string false Pass in Query Parameter
gender string false Pass in Query Parameter
custom1 string false Pass in Query Parameter
custom2 string false Pass in Query Parameter
custom3 string false Pass in Query Parameter
custom4 string false Pass in Query Parameter
custom5 string false Pass in Query Parameter

Example responses

200 Response

{ 
  "status": "success", 
  "mediaUrl": "https://app.videoform.com/img/abcdefrg?fname=John&lname=doe" 
}

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request Invalid status value None

Video

Everything about your Video

getVideo

Code samples

# You can also use wget
curl -X GET https://app.videoform.com/api/v1/generateVideo \
  -H 'Accept: application/json' \
  -H 'Header: {apiKey}'

GET /api/generateVideo

Generates New Video Url

Dynamic Fields Listed Below can be passed as query parameters.

At least 1 dynamic field must be passed in the query parameters.

Parameters

Name Type Required Description
template_id string true Template ID which can be found in the Video Template Editor Page
apiKey string true Pass this in the header
fname string false Pass in Query Parameter
lname string false Pass in Query Parameter
company string false Pass in Query Parameter
logo string false Pass in Query Parameter
title string false Pass in Query Parameter
jobtitle string false Pass in Query Parameter
city string false Pass in Query Parameter
country string false Pass in Query Parameter
email string false Pass in Query Parameter
address string false Pass in Query Parameter
phone string false Pass in Query Parameter
revenue string false Pass in Query Parameter
website string false Pass in Query Parameter
gender string false Pass in Query Parameter
custom1 string false Pass in Query Parameter
custom2 string false Pass in Query Parameter
custom3 string false Pass in Query Parameter
custom4 string false Pass in Query Parameter
custom5 string false Pass in Query Parameter

Example responses

200 Response

{ 
  "status": "success", 
  "mediaUrl": "https://app.videoform.com/share/abcdefrg?fname=John&lname=doe" 
}

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request Invalid status value None