📖 Documentation

KWIKmotion Portal API v2.1.9

Complete API Reference & Developer Guide

White Peaks Solutions SAS

📖

KWIKmotionAPIV2

KWIKmotion APIs Version 2.1.9

To use each API mentioned in this file you should generate a token from the platform in the Access token form under the developers section.

  • API's will only be accessible through HTTPS and Post Method.
  • All API's accept form-data, x-www-form-urlencoded, XML and JSON as body types.
  • All Responses return a (JSON/XML) containing a Response, Message, and Data key.
  • Response: is an Integer. A value of 1 is considered success. All other values are considered a failure. Cannot be Null.
    Message: is a string. Message will be used to send relevant information about responses to the user or developer.
    Data: Depends on the requirements of an API. Can be a string, Object, or Array.

AUTHORIZATION

Bearer Token

Token

<token>

🎫

Tokens

AUTHORIZATION

Bearer Token

This folder is using Bearer Token from collection KWIKmotionAPIV2

POST Create token

https://api.kwikmotion.com/v1/security/token

This API is used to create a token.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

Content-Type

application/x-www-form-urlencoded

Body

urlencoded

  • grant_type: password
  • username
  • password
  • lifetime: "36500"

Example Request

curl --location 'https://api.kwikmotion.com/v1/security/token' \\
  --header 'Content-Type: application/x-www-form-urlencoded' \\
  --data-urlencode 'grant_type=password' \\
  --data-urlencode 'username=' \\
  --data-urlencode 'password=' \\
  --data-urlencode 'lifetime=36500'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Verify token

https://api.kwikmotion.com/v1/token/verify

This API is used to test if a token is valid or not.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

Content-Type

application/xml

session

NjM4ODExODc5NDc4MjA1OTU5

Body

urlencoded

  • output: json (optional: json or xml)
  • includePermissionsData: "1"

Example Request

curl --location 'https://api.kwikmotion.com/v1/token/verify' \\
  --header 'Content-Type: application/xml' \\
  --header 'session: NjM4ODExODc5NDc4MjA1OTU5' \\
  --data-urlencode 'output=json' \\
  --data-urlencode 'includePermissionsData=1'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

⚙️

General

AUTHORIZATION

Bearer Token

This folder is using Bearer Token from collection KWIKmotionAPIV2

POST General - GetListOfCountries

https://api.kwikmotion.com/v1/General/GetListOfCountries

This API is used to get the list of countries.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

Content-Type

text/html

Body

formdata

  • output: json
  • nocache: "true"
  • countryid: "0"

Example Request

curl --location 'https://api.kwikmotion.com/v1/General/GetListOfCountries' \\
  --header 'Content-Type: text/html' \\
  --form 'output="json"' \\
  --form 'nocache="true"' \\
  --form 'countryid="0"'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST General - GetListOfSubscriptions

https://api.kwikmotion.com/v1/General/GetListOfSubscriptions

This API is used to get the list of subscriptions.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

Content-Type

text/html

Body

formdata

  • output: json

Example Request

curl --location 'https://api.kwikmotion.com/v1/General/GetListOfSubscriptions' \\
  --header 'Content-Type: text/html' \\
  --form 'output="json"'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST General - GetTranscriptLanguages

https://api.kwikmotion.com/v1/General/GetTranscriptLanguages

This API is used to get transcript languages.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

Content-Type

application/x-www-form-urlencoded

Body

formdata

  • output: json
  • nocache: "true"
  • LanguageID: "0"

Example Request

curl --location 'https://api.kwikmotion.com/v1/General/GetTranscriptLanguages' \\
  --header 'Content-Type: application/x-www-form-urlencoded' \\
  --form 'output="json"' \\
  --form 'nocache="true"' \\
  --form 'LanguageID="0"'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST General - account-information

https://api.kwikmotion.com/v1/General/account-information

This API is used to get account information.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Example Request

curl --location --request POST 'https://api.kwikmotion.com/v1/General/account-information' \\
  --data ''

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST General - videos operations

https://api.kwikmotion.com/v1/General/videos/operations

This API is used to download or encode a video.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

Content-Type

text/html

Body

formdata

  • output: json (optional: json or xml)
  • videokey: kKdJ0lAYFf6MkL1G4U2iA (required: video key to be consumed in the operation)
  • operation: encode (required: currently it is either download or encode. if download then the url of the downloaded video will be listed in the result of the status API. if encode then the video key of the result video will be listed in the status API.)
  • resolution: 240p (optional: if specified then operation will work on this specific resolution)
  • watermarkid: 105 (optional: if specified then the watermark will be added to the result video)
  • encodingprofile: 130 (optional: if specified then operation will use this encoding profile in the result)
  • introvideokey: (optional: if specified then operation will use the provided video key as an intro for the main video)
  • outrovideokey: (optional: if specified then operation will use the provided video key as an outro for the main video)

Example Request

curl --location 'https://api.kwikmotion.com/v1/General/videos/operations' \\
  --header 'Content-Type: text/html' \\
  --form 'output="json"' \\
  --form 'videokey="kKdJ0lAYFf6MkL1G4U2iA"' \\
  --form 'operation="encode"' \\
  --form 'watermarkid="105"' \\
  --form 'encodingprofile="130"'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST General - videos operations status

https://api.kwikmotion.com/v1/General/videos/operations/status

This API is used to get the operation status.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

Content-Type

text/html

Body

formdata

  • output: json (optional: json or xml)
  • trackerid: 53 (required: specify the id obtained from the operation API call.)

Example Request

curl --location 'https://api.kwikmotion.com/v1/General/videos/operations/status' \\
  --header 'Content-Type: text/html' \\
  --form 'output="json"' \\
  --form 'trackerid="53"'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Logout

https://api.kwikmotion.com/v1/general/logout

This API is used to logout.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Example Request

curl --location --request POST 'https://api.kwikmotion.com/v1/general/logout' \\
  --data ''

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST General - company settings

https://api.kwikmotion.com/v1/General/company-settings

This API is used to get company settings.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

Content-Type

text/html

session

k7yn08cg9pthrmx7vanlsrf1nls1js40u

Body

formdata

  • output: json
  • rectype: outro

Example Request

curl --location 'https://api.kwikmotion.com/v1/General/company-settings' \\
  --header 'Content-Type: text/html' \\
  --header 'session: k7yn08cg9pthrmx7vanlsrf1nls1js40u' \\
  --form 'output="json"' \\
  --form 'rectype="outro"'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST General - log operation

https://api.kwikmotion.com/v1/General/log-operation

This API is used to log operations.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

session

k7yn08cg9pthrmx7vanlsrf1nls1js40u

Body

raw (json)

{
    "output": "json or xml",
    "rectype": "type of the operation ex clipping - download",
    "recid": "record id ex clipping video id",
    "info": "description of the operation",
    "tokentype": "platformtoken or videoeditortoken or clippingtoken"
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/General/log-operation' \\
  --header 'session: k7yn08cg9pthrmx7vanlsrf1nls1js40u' \\
  --data '{
    "output": "json or xml",
    "rectype": "type of the operation ex clipping - download",
    "recid": "record id ex clipping video id",
    "info": "description of the operation",
    "tokentype": "platformtoken or videoeditortoken or clippingtoken"
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

🎬

Videos

AUTHORIZATION

Bearer Token

This folder is using Bearer Token from collection KWIKmotionAPIV2

POST Videos - GetList (x-www-form-urlencoded)

https://api.kwikmotion.com/v1/Videos/GetList

This API is used to list video according to added filters.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

Content-Type

application/xml

PARAMS

  • output: json
  • videokey: WDa2QHqU4rKJJvLJBN1wkg

Body

urlencoded

  • top: 10
  • output: json
  • folderid: 0
  • searchstr
  • fromdate: 2019-1-1 10:10:00
  • todate: 2020-1-1 10:10:00
  • pagenumber: 1
  • nocache: true
  • searchgenre
  • searchactor

Example Request

curl --location 'https://api.kwikmotion.com/v1/Videos/GetList' \\
  --header 'Content-Type: application/xml' \\
  --data-urlencode 'top=10' \\
  --data-urlencode 'output= json' \\
  --data-urlencode 'folderid=0' \\
  --data-urlencode 'searchstr=' \\
  --data-urlencode 'fromdate=2019-1-1 10:10:00' \\
  --data-urlencode 'todate=2020-1-1 10:10:00' \\
  --data-urlencode 'pagenumber=1' \\
  --data-urlencode 'nocache=true' \\
  --data-urlencode 'searchgenre=' \\
  --data-urlencode 'searchactor='

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Videos - GetList (form-data)

https://api.kwikmotion.com/v1/Videos/GetList

This API is used to list video according to added filters.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

Content-Type

application/xml

PARAMS

  • output: json
  • videokey: WDa2QHqU4rKJJvLJBN1wkg

Body

formdata

  • top: 10
  • output: json
  • folderid: 0
  • searchstr
  • fromdate: 2019-1-1 10:10:00
  • todate: 2020-1-1 10:10:00
  • pagenumber: 1
  • nocache: true
  • searchgenre
  • searchactor

Example Request

curl --location 'https://api.kwikmotion.com/v1/Videos/GetList' \\
  --header 'Content-Type: application/xml' \\
  --form 'top="10"' \\
  --form 'output=" json"' \\
  --form 'folderid="0"' \\
  --form 'searchstr=""' \\
  --form 'pagenumber="1"' \\
  --form 'nocache="true"' \\
  --form 'searchgenre=""' \\
  --form 'searchactor=""'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Videos - GetList (Xml)

https://api.kwikmotion.com/v1/Videos/GetList

This API is used to list video according to added filters.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

Content-Type

application/xml

PARAMS

  • output: json
  • videokey: WDa2QHqU4rKJJvLJBN1wkg

Body

raw

<Root>
    <top>10</top>
    <output>json</output>
    <folderid>0</folderid>
    <searchstr></searchstr>
    <searchgenre></searchgenre>
    <searchactor></searchactor>
    <fromdate></fromdate>
    <todate></todate>
    <pagenumber>1</pagenumber>
    <nocache>true</nocache>
</Root>

Example Request

curl --location 'https://api.kwikmotion.com/v1/Videos/GetList' \\
  --header 'Content-Type: application/xml' \\
  --data '<Root>
    <top>10</top>
    <output>json</output>
    <folderid>0</folderid>
    <searchstr></searchstr>
    <searchgenre></searchgenre>
    <searchactor></searchactor>
    <fromdate></fromdate>
    <todate></todate>
    <pagenumber>1</pagenumber>
    <nocache>true</nocache>
</Root>'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Videos - GetList (Json)

https://api.kwikmotion.com/v1/Videos/GetList

This API is used to list video according to added filters.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

Content-Type

application/json

PARAMS

  • output: json
  • videokey: WDa2QHqU4rKJJvLJBN1wkg

Body

raw

{
    "top" :50,
    "output":"json",
    "folderid":0,
    "searchstr":"",
    "searchgenre":"",
    "searchactor":"",
    "fromdate":"",
    "todate":"",
    "pagenumber": 1,
    "nocache" :"true",
    "videokey": 1,
    "VideoDuration" : 1,
    "videoTitle":1,
    "uploadedDate":1,
    "modifiedDate": 1,
    "videoPosterImage":1,
    "videoThumbnailImage":1,
    "sources" : 1,
    "promoVideos": 1
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/Videos/GetList' \\
  --header 'Content-Type: application/json' \\
  --data '{
    "top" :50,
    "output":"json",
    "folderid":0,
    "searchstr":"",
    "searchgenre":"",
    "searchactor":"",
    "fromdate":"",
    "todate":"",
    "pagenumber": 1,
    "nocache" :"true",
    "videokey": 1,
    "VideoDuration" : 1,
    "videoTitle":1,
    "uploadedDate":1,
    "modifiedDate": 1,
    "videoPosterImage":1,
    "videoThumbnailImage":1,
    "sources" : 1,
    "promoVideos": 1
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Videos - GetVODDetails

https://api.kwikmotion.com/v1/Videos/GetVODDetails

This API is used to get the metadata of a video.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

Content-Type

application/xml

PARAMS

  • output: json
  • videokey: WDa2QHqU4rKJJvLJBN1wkg

Body

raw

<Root>
    <videokey>0iCAkpSRqNxFpm8qGyZA</videokey>
    <output>xml</output>
    <fullduration>1</fullduration>
    <allowmobile>true</allowmobile>
    <source>1</source>
    <nocache>true</nocache>
</Root>

Example Request

curl --location 'https://api.kwikmotion.com/v1/Videos/GetVODDetails' \\
  --header 'Content-Type: application/xml' \\
  --data '<Root>
    <videokey>0iCAkpSRqNxFpm8qGyZA</videokey>
    <output>xml</output>
    <fullduration>1</fullduration>
    <allowmobile>true</allowmobile>
    <source>1</source>
    <nocache>true</nocache>
</Root>'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Videos - SetVODDetails

https://api.kwikmotion.com/v1/Videos/SetVODDetails

This API is used to update metadata of a video.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

Content-Type

application/xml

PARAMS

  • output: json
  • videokey: WDa2QHqU4rKJJvLJBN1wkg

Body

raw

<Root>
    <Videokey>itEr4P6AE79oB8ifuIXOug</Videokey>
    <title>Edited from API 2.0</title>
    <description>Robert Edit this</description>
    <keywords>My, Key, word</keywords>
    <reference>REF-01</reference>
    <episode>1</episode>
    <subscription>A</subscription>
    <actor>Johnny</actor>
    <tag>This is my test from API</tag>
    <watermarkid>15</watermarkid>
    <genreid>10,20</genreid>
    <folderid>5613</folderid>
    <output>json</output>
</Root>

Example Request

curl --location 'https://api.kwikmotion.com/v1/Videos/SetVODDetails' \\
  --header 'Content-Type: application/xml' \\
  --data '<Root>
    <Videokey>itEr4P6AE79oB8ifuIXOug</Videokey>
    <title>Edited from API 2.0</title>
    <description>Robert Edit this</description>
    <keywords>My, Key, word</keywords>
    <reference>REF-01</reference>
    <episode>1</episode>
    <subscription>A</subscription>
    <actor>Johnny</actor>
    <tag>This is my test from API</tag>
    <watermarkid>15</watermarkid>
    <genreid>10,20</genreid>
    <folderid>5613</folderid>
    <output>json</output>
</Root>'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Videos - DeleteVODDetails

https://api.kwikmotion.com/v1/Videos/DeleteVODDetails

This API is used to delete a video.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

Content-Type

application/xml

Body

urlencoded

  • Videokey: xcUjbIlIHW1LPOCt8rSjGA
  • output: json

Example Request

curl --location 'https://api.kwikmotion.com/v1/Videos/DeleteVODDetails' \\
  --header 'Content-Type: application/xml' \\
  --data-urlencode 'Videokey=xcUjbIlIHW1LPOCt8rSjGA' \\
  --data-urlencode 'output=json'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Videos - Modified

https://api.kwikmotion.com/v1/Videos/Modified

This API is used to list video that has been modified.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

Content-Type

application/json

Body

raw (json)

{
    "output":"json",
    "folderid":0,
    "fromdate":"2020-10-16 00:00:00",
    "todate":"2024-12-01 00:00:00",
    "nocache" :"true"
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/Videos/Modified' \\
  --header 'Content-Type: application/json' \\
  --data '{
    "output":"json",
    "folderid":0,
    "fromdate":"2020-10-16 00:00:00",
    "todate":"2024-12-01 00:00:00",
    "nocache" :"true"
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Videos - Deleted

https://api.kwikmotion.com/v1/Videos/Deleted

This API is used to list video that are set as deleted.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

Content-Type

application/json

Body

raw (json)

{
    "output":"json",
    "folderid":0,
    "fromdate":"2020-1-1 10:10:00",
    "todate":"2020-10-20 23:59:59",
    "nocache" :"true"
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/Videos/Deleted' \\
  --header 'Content-Type: application/json' \\
  --data '{
    "output":"json",
    "folderid":0,
    "fromdate":"2020-1-1 10:10:00",
    "todate":"2020-10-20 23:59:59",
    "nocache" :"true"
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Videos - SetVideoGeoBlocking/Block

https://api.kwikmotion.com/v1/Videos/SetVideoGeoBlocking/Block

This API is used to set video geoblocking.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

Content-Type

application/xml

Body

raw (xml)

<Root>
    <videokey>BSJcEe9t45QInjjHOPDIQ</videokey>
    <output>json</output>
    <countryids>123,1</countryids>
</Root>

Example Request

curl --location 'https://api.kwikmotion.com/v1/Videos/SetVideoGeoBlocking/Block' \\
  --header 'Content-Type: application/xml' \\
  --data '<Root>
    <videokey>BSJcEe9t45QInjjHOPDIQ</videokey>
    <output>json</output>
    <countryids>123,1</countryids>
</Root>'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Videos - SetVideoGeoBlocking/UnBlock

https://api.kwikmotion.com/v1/Videos/SetVideoGeoBlocking/UnBlock

This API is used to remove geoblock for a video.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

Content-Type

application/xml

Body

raw (xml)

<Root>
    <videokey>BSJcEe9t45QInjjHOPDIQ</videokey>
    <output>json</output>
    <countryids>123</countryids>
</Root>

Example Request

curl --location 'https://api.kwikmotion.com/v1/Videos/SetVideoGeoBlocking/UnBlock' \\
  --header 'Content-Type: application/xml' \\
  --data '<Root>
    <videokey>BSJcEe9t45QInjjHOPDIQ</videokey>
    <output>json</output>
    <countryids>123</countryids>
</Root>'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST UploadVideo - CreateSession

https://api.kwikmotion.com/v1/UploadVideo/CreateSession

Summary of the Upload Process

Upload video has three steps, create a session for the upload, upload video chunks and finally perform the save.

  • Create a session: this API is used to init the upload and returns a session id to be used in the other upload operations
  • Upload video chunks: this API is used to define the properties of the file example: total file size, chunk file bytes, original filename and chunk resume index. After all chunks are uploaded the final API is ready to be triggered and if a chunk has an issue then the final API will return an error.
  • Finish Session: this API is used to combine the uploaded chunks and add the metadata sent in the API to set the video to be transcoded.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (xml)

<Root>
    <output>json</output>
</Root>

Example Request

curl --location 'https://api.kwikmotion.com/v1/UploadVideo/CreateSession' \\
  --data '<Root>
    <output>json</output>
</Root>'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST UploadVideo - UploadChunk

https://api.kwikmotion.com/v1/UploadVideo/UploadChunk

This API is used to upload video chunks.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

formdata

  • sessionid: session id from CreateSession
  • chunkindex: chunk index
  • file: [file]
  • output: json

Example Request

curl --location 'https://api.kwikmotion.com/v1/UploadVideo/UploadChunk' \\
  --form 'sessionid="session id from CreateSession"' \\
  --form 'chunkindex="chunk index"' \\
  --form 'file=@[file]' \\
  --form 'output="json"'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST UploadVideo - FinishSession

https://api.kwikmotion.com/v1/UploadVideo/FinishSession

This API is used to combine the uploaded chunks and add the metadata sent in the API to set the video to be transcoded.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (xml)

<Root>
    <sessionid>session id from CreateSession</sessionid>
    <title>video title</title>
    <description>video description</description>
    <folderid>0</folderid>
    <output>json</output>
</Root>

Example Request

curl --location 'https://api.kwikmotion.com/v1/UploadVideo/FinishSession' \\
  --data '<Root>
    <sessionid>session id from CreateSession</sessionid>
    <title>video title</title>
    <description>video description</description>
    <folderid>0</folderid>
    <output>json</output>
</Root>'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST PosterImage - GetImage

https://api.kwikmotion.com/v1/PosterImage/GetImage

This API is used to get poster image for a video.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

urlencoded

  • videokey: WDa2QHqU4rKJJvLJBN1wkg
  • output: json

Example Request

curl --location 'https://api.kwikmotion.com/v1/PosterImage/GetImage' \\
  --data-urlencode 'videokey=WDa2QHqU4rKJJvLJBN1wkg' \\
  --data-urlencode 'output=json'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST PosterImage - SetImage

https://api.kwikmotion.com/v1/PosterImage/SetImage

This API is used to set poster image for a video.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

formdata

  • videokey: WDa2QHqU4rKJJvLJBN1wkg
  • file: [file]
  • output: json

Example Request

curl --location 'https://api.kwikmotion.com/v1/PosterImage/SetImage' \\
  --form 'videokey="WDa2QHqU4rKJJvLJBN1wkg"' \\
  --form 'file=@[file]' \\
  --form 'output="json"'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

📁

Folders

AUTHORIZATION

Bearer Token

This folder is using Bearer Token from collection KWIKmotionAPIV2

POST Folders - GetList

https://api.kwikmotion.com/v1/Folders/GetList

This API is used to list folders.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw

<Root>
    <folderid></folderid>
    <nocache>true</nocache>
    <output>json</output>
</Root>

Example Request

curl --location 'https://api.kwikmotion.com/v1/Folders/GetList' \\
  --data '<Root>
    <folderid></folderid>
    <nocache>true</nocache>
    <output>json</output>
</Root>'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Folders - GetSimpleList

https://api.kwikmotion.com/v1/Folders/GetSimpleList

This API is used to list folders with simplified data.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw

<Root>
    <nocache>true</nocache>
    <output>json</output>
    <showsubfolders>true</showsubfolders>
</Root>

Example Request

curl --location 'https://api.kwikmotion.com/v1/Folders/GetSimpleList' \\
  --data '<Root>
    <nocache>true</nocache>
    <output>json</output>
    <showsubfolders>true</showsubfolders>
</Root>'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Folders - CreateFolder

https://api.kwikmotion.com/v1/Folders/CreateFolder

This API is used to create a folder.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw

<Root>
    <foldertext>mynewfolder</foldertext>
    <parentfolderid>4448</parentfolderid>
    <output>json</output>
</Root>

Example Request

curl --location 'https://api.kwikmotion.com/v1/Folders/CreateFolder' \\
  --data '<Root>
    <foldertext>mynewfolder</foldertext>
    <parentfolderid>4448</parentfolderid>
    <output>json</output>
</Root>'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Folders - SetFolder

https://api.kwikmotion.com/v1/Folders/SetFolder

This API is used to update a folder.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (xml)

<Root>
    <newfoldertext>Softimpact</newfoldertext>
    <folderid>18306</folderid>
    <output>json</output>
</Root>

Example Request

curl --location 'https://api.kwikmotion.com/v1/Folders/SetFolder' \\
  --data '<Root>
    <newfoldertext>Softimpact</newfoldertext>
    <folderid>18306</folderid>
    <output>json</output>
</Root>
'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Folders - DeleteFolder

https://api.kwikmotion.com/v1/Folders/DeleteFolder

This API is used to delete a folder.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

formdata

  • folderid: select folder id seperated by comma
  • output: json

Example Request

curl --location 'https://api.kwikmotion.com/v1/Folders/DeleteFolder' \\
  --form 'folderid="select folder id seperated by comma"' \\
  --form 'output="json"'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

🔄

Transcoders

AUTHORIZATION

Bearer Token

This folder is using Bearer Token from collection KWIKmotionAPIV2

POST Transcoder - profiles

https://api.kwikmotion.com/v1/transcoder/profiles

This API is used to get transcoding profiles.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (json)

{
    "output":"json",
    "tokentype":"videoeditortoken"
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/transcoder/profiles' \\
  --data '{
    "output":"json",
    "tokentype":"videoeditortoken"
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Transcoder - profile resolutions

https://api.kwikmotion.com/v1/transcoder/profileresolutions

This API is used to get transcoding profile resolutions.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (json)

{
    "output" : "json",
    "profileid":21
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/transcoder/profileresolutions' \\
  --data '{
    "output" : "json",
    "profileid":21
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Folders - GetFolderGeoBlocking

https://api.kwikmotion.com/v1/Folders/GetFolderGeoBlocking

This API is used to get folder geoblocking.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

Content-Type

application/xml

Body

raw (xml)

<Root>
    <folderid>4322</folderid>
    <nocache>true</nocache>
    <output>json</output>
</Root>

Example Request

curl --location 'https://api.kwikmotion.com/v1/Folders/GetFolderGeoBlocking' \\
  --header 'Content-Type: application/xml' \\
  --data '<Root>
    <folderid>4322</folderid>
    <nocache>true</nocache>
    <output>json</output>
</Root>'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Folders - SetFolderGeoBlocking/Block

https://api.kwikmotion.com/v1/Folders/SetFolderGeoBlocking/Block

This API is used to set folder geoblocking.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

Content-Type

application/xml

Body

raw (xml)

<Root>
    <folderid>4322</folderid>
    <output>json</output>
    <countryids>1</countryids>
</Root>

Example Request

curl --location 'https://api.kwikmotion.com/v1/Folders/SetFolderGeoBlocking/Block' \\
  --header 'Content-Type: application/xml' \\
  --data '<Root>
    <folderid>4322</folderid>
    <output>json</output>
    <countryids>1</countryids>
</Root>'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Folders - SetFolderGeoBlocking/UnBlock

https://api.kwikmotion.com/v1/Folders/SetFolderGeoBlocking/UnBlock

This API is used to remove folder geoblocking.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

Content-Type

application/xml

Body

raw (xml)

<Root>
    <folderid>4322</folderid>
    <output>json</output>
    <countryids>1</countryids>
</Root>

Example Request

curl --location 'https://api.kwikmotion.com/v1/Folders/SetFolderGeoBlocking/UnBlock' \\
  --header 'Content-Type: application/xml' \\
  --data '<Root>
    <folderid>4322</folderid>
    <output>json</output>
    <countryids>1</countryids>
</Root>'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

📝

Transcript & Translate

AUTHORIZATION

Bearer Token

This folder is using Bearer Token from collection KWIKmotionAPIV2

POST Videos - Transcripts/UploadVTT

https://api.kwikmotion.com/v1/Videos/Transcripts/UploadVTT

This API is used to upload vtt file for a video.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (xml)

<Root>
    <output>json</output>
    <videokey>LgV2zwwgbWZeF8j713lTHA</videokey>
    <transcriptlanguage>arabic</transcriptlanguage>
    <filename>arabic.vtt</filename>
    <filebytes>V0VCVlRUCgowMDowMDowMi4zMzAgLS0+IDAwOjAwOjQ0LjM4MArZgdmKINi62LbZiNmGINiw2YTZgyDYp9mD2K8g2YXZhdir2YQg2LXZhtiv2YjZgiDYp9mE2KfZhdmFINin2YTZhdiq2K3Yr9ipINmE2YTYt9mB2YjZhNipINin2YTZitmI2YbZitiz2YEg2YjYp9mE2YXYr9mK2LHYqSDYp9mE2KfZgtmE2YrZhdmK2Kkg2YTZhdmG2LjZhdipINin2YTYudmF2YQg2KfZhNiv2YjZhNmK2Kkg2YHZiiDZhNio2YbYp9mGINin2YbYpyDYp9mE2LrYp9ihINin2YTYr9i52YUg2YXZhiDYr9mI2YYg2LbZhdin2YbYp9iqINmE2K3Zhdin2YrYqSDYp9mE2YHYptin2Kog2KfZhNin2YPYq9ixINi22LnZgdinINiz2YrYtdmEINin2YTZiSDYrdivINmD2KfYsdir2Kkg2KfYrNiq2YXYp9i52YrYqSDZhdit2KfYsNmK2LEg2KfYqtmK2YYg2YXZhiDYudiv2YUg2YjYtdmI2YQg2YjYrNmI2K8g2YjZg9mK2YTYqSDZhNiq2K7ZgdmK2YEg2KfZhNi22LHYqNipINmI2KjYrdiz2Kgg2YXZhti42YXYqSDYp9mE2LnZhdmEINmB2KXZhiDZhdinINmK2LXZhCDYp9mE2Ykg2KvZhdin2YbZitmGINmB2Yog2KfZhNmF2KfYptipINmF2YYg2KfZhNiv2LnZhSDZitiz2KrZgdmK2K/ZhyDYp9mE2YbYtSDYp9mE2KfYutmG2Ykg2YXZhiDYp9mE2LPZg9in2YYg2YjZitiw2YfYqCDZiNi52LTYsdmK2YYg2YHZiiDYp9mE2YXYp9im2Kkg2YHZgti3INmE2YTZhti1INin2YTYp9mD2KvYsSDZgdmC2LHYpyDZiNmE2KPZhiDYp9mE2K3Yr9mK2Ksg2YPYq9ixINmB2Yog2KfZhNin2YjZhtipINin2YTYp9iu2YrYsdipINi52YYg2KfZh9mF2YrYqSDZiNis2YjYryDYqNiv2KfYptmEINi52YYg2LPZitin2LPYqSDYp9mE2K/YudmFINin2YTZhdi52YXZiNmEINio2YfYpyDYrdin2YTZitinINmF2Kcg2YfZiiDYp9mE2KfYrNix2KfYodin2Kog2KfZhNmF2LfYsdmI2K3YqSDZhdmGINmC2KjZhCDYp9mE2K/ZiNmE2Kkg2YTZhdiz2KfYudiv2Kkg2KfZhNmB2KbYp9iqINin2YTYp9mD2KvYsSDYtti52YHYpwo=</filebytes>
</Root>

Example Request

curl --location 'https://api.kwikmotion.com/v1/Videos/Transcripts/UploadVTT' \\
  --data '<Root>
    <output>json</output>
    <videokey>LgV2zwwgbWZeF8j713lTHA</videokey>
    <transcriptlanguage>arabic</transcriptlanguage>
    <filename>arabic.vtt</filename>
    <filebytes>V0VCVlRUCgowMDowMDowMi4zMzAgLS0+IDAwOjAwOjQ0LjM4MArZgdmKINi62LbZiNmGINiw2YTZgyDYp9mD2K8g2YXZhdir2YQg2LXZhtiv2YjZgiDYp9mE2KfZhdmFINin2YTZhdiq2K3Yr9ipINmE2YTYt9mB2YjZhNipINin2YTZitmI2YbZitiz2YEg2YjYp9mE2YXYr9mK2LHYqSDYp9mE2KfZgtmE2YrZhdmK2Kkg2YTZhdmG2LjZhdipINin2YTYudmF2YQg2KfZhNiv2YjZhNmK2Kkg2YHZiiDZhNio2YbYp9mGINin2YbYpyDYp9mE2LrYp9ihINin2YTYr9i52YUg2YXZhiDYr9mI2YYg2LbZhdin2YbYp9iqINmE2K3Zhdin2YrYqSDYp9mE2YHYptin2Kog2KfZhNin2YPYq9ixINi22LnZgdinINiz2YrYtdmEINin2YTZiSDYrdivINmD2KfYsdir2Kkg2KfYrNiq2YXYp9i52YrYqSDZhdit2KfYsNmK2LEg2KfYqtmK2YYg2YXZhiDYudiv2YUg2YjYtdmI2YQg2YjYrNmI2K8g2YjZg9mK2YTYqSDZhNiq2K7ZgdmK2YEg2KfZhNi22LHYqNipINmI2KjYrdiz2Kgg2YXZhti42YXYqSDYp9mE2LnZhdmEINmB2KXZhiDZhdinINmK2LXZhCDYp9mE2Ykg2KvZhdin2YbZitmGINmB2Yog2KfZhNmF2KfYptipINmF2YYg2KfZhNiv2LnZhSDZitiz2KrZgdmK2K/ZhyDYp9mE2YbYtSDYp9mE2KfYutmG2Ykg2YXZhiDYp9mE2LPZg9in2YYg2YjZitiw2YfYqCDZiNi52LTYsdmK2YYg2YHZiiDYp9mE2YXYp9im2Kkg2YHZgti3INmE2YTZhti1INin2YTYp9mD2KvYsSDZgdmC2LHYpyDZiNmE2KPZhiDYp9mE2K3Yr9mK2Ksg2YPYq9ixINmB2Yog2KfZhNin2YjZhtipINin2YTYp9iu2YrYsdipINi52YYg2KfZh9mF2YrYqSDZiNis2YjYryDYqNiv2KfYptmEINi52YYg2LPZitin2LPYqSDYp9mE2K/YudmFINin2YTZhdi52YXZiNmEINio2YfYpyDYrdin2YTZitinINmF2Kcg2YfZiiDYp9mE2KfYrNix2KfYodin2Kog2KfZhNmF2LfYsdmI2K3YqSDZhdmGINmC2KjZhCDYp9mE2K/ZiNmE2Kkg2YTZhdiz2KfYudiv2Kkg2KfZhNmB2KbYp9iqINin2YTYp9mD2KvYsSDYtti52YHYpwo=</filebytes>
</Root>'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Videos - Transcripts/SetTranscript

https://api.kwikmotion.com/v1/Videos/Transcripts/SetTranscript

This API is used to set transcript for a video.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (xml)

<Root>
    <output>json</output>
    <videokey>LgV2zwwgbWZeF8j713lTHA</videokey>
    <transcriptlanguage>English</transcriptlanguage>
    <operation>retranscript</operation>
</Root>

Example Request

curl --location 'https://api.kwikmotion.com/v1/Videos/Transcripts/SetTranscript' \\
  --data '<Root>
    <output>json</output>
    <videokey>LgV2zwwgbWZeF8j713lTHA</videokey>
    <transcriptlanguage>English</transcriptlanguage>
    <operation>retranscript</operation>
</Root>'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Videos - Transcripts/SetTranslate

https://api.kwikmotion.com/v1/Videos/Transcripts/SetTranslate

This API is used to set translation for a video.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (xml)

<Root>
    <output>json</output>
    <videokey>LgV2zwwgbWZeF8j713lTHA</videokey>
    <translatefrom>English</translatefrom>
    <translateTo>French</translateTo>
</Root>

Example Request

curl --location 'https://api.kwikmotion.com/v1/Videos/Transcripts/SetTranslate' \\
  --data '<Root>
    <output>json</output>
    <videokey>LgV2zwwgbWZeF8j713lTHA</videokey>
    <translatefrom>English</translatefrom>
    <translateTo>French</translateTo>
</Root>'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Videos - Transcripts/DeleteVTT

https://api.kwikmotion.com/v1/Videos/Transcripts/DeleteVTT

This API is used to delete VTT file for a video.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (xml)

<Root>
    <output>json</output>
    <videokey>N3ySI8lYtprDKKO7ZJeNpA</videokey>
    <langabbreviation>en</langabbreviation>
    <operationtype>translate</operationtype>
</Root>

Example Request

curl --location 'https://api.kwikmotion.com/v1/Videos/Transcripts/DeleteVTT' \\
  --data '<Root>
    <output>json</output>
    <videokey>N3ySI8lYtprDKKO7ZJeNpA</videokey>
    <langabbreviation>en</langabbreviation>
    <operationtype>translate</operationtype>
</Root>'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

💧

Watermark

AUTHORIZATION

Bearer Token

This folder is using Bearer Token from collection KWIKmotionAPIV2

POST WatermarkProfile - Get Watermark

https://api.kwikmotion.com/v1/WatermarkProfile/GetWatermark

This API is used to get watermark.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (xml)

<Root>
    <output>json</output>
    <nocache>true</nocache>
</Root>

Example Request

curl --location 'https://api.kwikmotion.com/v1/WatermarkProfile/GetWatermark' \\
  --data '<Root>
    <output>json</output>
    <nocache>true</nocache>
</Root>'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST WatermarkProfile - Set Watermark

https://api.kwikmotion.com/v1/WatermarkProfile/SetWatermark

This API is used to set watermark.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

formdata

  • watermarkid: select watermark id
  • watermarkname: this is a test
  • file: [file]
  • output: json

Example Request

curl --location 'https://api.kwikmotion.com/v1/WatermarkProfile/SetWatermark' \\
  --form 'watermarkid="select watermark id"' \\
  --form 'watermarkname="this is a test"' \\
  --form 'file=@[file]' \\
  --form 'output="json"'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

🏷️

Genre

AUTHORIZATION

Bearer Token

This folder is using Bearer Token from collection KWIKmotionAPIV2

POST GenreProfile - GetGenre

https://api.kwikmotion.com/v1/GenreProfile/GetGenre

This API is used to list genres.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

Content-Type

application/xml

Body

raw (xml)

<Root>
    <output>json</output>
    <nocache>true</nocache>
</Root>

Example Request

curl --location 'https://api.kwikmotion.com/v1/GenreProfile/GetGenre' \\
  --header 'Content-Type: application/xml' \\
  --data '<Root>
    <output>json</output>
    <nocache>true</nocache>
</Root>'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST GenreProfile - SetGenre

https://api.kwikmotion.com/v1/GenreProfile/SetGenre

This API is used to set genres.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

Content-Type

application/xml

Body

raw (xml)

<Root>
    <genreid>select genre id</genreid>
    <genrename>this is a test</genrename>
    <output>json</output>
</Root>

Example Request

curl --location 'https://api.kwikmotion.com/v1/GenreProfile/SetGenre' \\
  --header 'Content-Type: application/xml' \\
  --data '<Root>
    <genreid>select genre id</genreid>
    <genrename>this is a test</genrename>
    <output>json</output>
</Root>'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST GenreProfile - DeleteGenre

https://api.kwikmotion.com/v1/GenreProfile/DeleteGenre

This API is used to delete genres.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (xml)

<Root>
    <genreids>0</genreids>
    <output>json</output>
</Root>

Example Request

curl --location 'https://api.kwikmotion.com/v1/GenreProfile/DeleteGenre' \\
  --data '<Root>
    <genreids>0</genreids>
    <output>json</output>
</Root>'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

📱

Social Media

AUTHORIZATION

Bearer Token

This folder is using Bearer Token from collection KWIKmotionAPIV2

POST List Youtube Profiles

https://api.kwikmotion.com/v1/socialsharing/youtubeprofiles

This API is used to list youtube profiles.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (json)

{
    "output":"xml"
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/socialsharing/youtubeprofiles' \\
  --data '{
    "output":"xml"
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST List Facebook profiles

https://api.kwikmotion.com/v1/socialsharing/facebookprofiles

This API is used to list facebook profiles.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (json)

{
    "output":"xml"
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/socialsharing/facebookprofiles' \\
  --data '{
    "output":"xml"
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST List Instagram Profiles

https://api.kwikmotion.com/v1/socialsharing/instagramprofiles

This API is used to list instagram profiles.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (json)

{
    "output":"xml"
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/socialsharing/instagramprofiles' \\
  --data '{
    "output":"xml"
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST List Twitter Profiles

https://api.kwikmotion.com/v1/socialsharing/twitterprofiles

This API is used to list twitter profiles.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (json)

{
    "output":"xml"
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/socialsharing/twitterprofiles' \\
  --data '{
    "output":"xml"
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST List Tiktok Profiles

https://api.kwikmotion.com/v1/socialsharing/tiktokprofiles

This API is used to list tiktok profiles.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (json)

{
    "output":"xml"
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/socialsharing/tiktokprofiles' \\
  --data '{
    "output":"xml"
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Post to youtube

https://api.kwikmotion.com/v1/socialsharing/posttoyoutube

This API is used to post video to youtube.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (json)

{
    "channelid": "~id~",
    "filephysicalfullpath":"~filephysicalfullpath~",
    "title" : "~title~",
    "description" : "~description~",
    "tags":"~tags~",
    "privacystatus":"~Public~ or ~Unlisted~ or ~Private~",
    "introvideokey":"{{intro video key}}",
    "outrovideokey":"{{outro video key}}"
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/socialsharing/posttoyoutube' \\
  --data '{
    "channelid": "~id~",
    "filephysicalfullpath":"~filephysicalfullpath~",
    "title" : "~title~",
    "description" : "~description~",
    "tags":"~tags~",
    "privacystatus":"~Public~ or ~Unlisted~ or ~Private~",
    "introvideokey":"{{intro video key}}",
    "outrovideokey":"{{outro video key}}"
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Post to facebook

https://api.kwikmotion.com/v1/socialsharing/posttofacebook

This API is used to post video to facebook.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (json)

{
    "accountid": "~id~",
    "filephysicalfullpath":"~filephysicalfullpath~",
    "title" : "~title~",
    "caption" : "~caption~",
    "status":"~true~ or ~false~",
    "publishdate":"~Unix epoch time~",
    "introvideokey":"{{intro video key}}",
    "outrovideokey":"{{outro video key}}"
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/socialsharing/posttofacebook' \\
  --data '{
    "accountid": "~id~",
    "filephysicalfullpath":"~filephysicalfullpath~",
    "title" : "~title~",
    "caption" : "~caption~",
    "status":"~true~ or ~false~",
    "publishdate":"~Unix epoch time~",
    "introvideokey":"{{intro video key}}",
    "outrovideokey":"{{outro video key}}"
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Post to Instagram

https://api.kwikmotion.com/v1/socialsharing/posttoinstagram

This API is used to post video to instagram.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (json)

{
    "accountid": "~id~",
    "filephysicalfullpath":"~filephysicalfullpath~",
    "posttype":"~video~ or ~igtv~",
    "caption" : "~caption~",
    "publishdate":"~Unix epoch time~",
    "introvideokey":"{{intro video key}}",
    "outrovideokey":"{{outro video key}}"
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/socialsharing/posttoinstagram' \\
  --data '{
    "accountid": "~id~",
    "filephysicalfullpath":"~filephysicalfullpath~",
    "posttype":"~video~ or ~igtv~",
    "caption" : "~caption~",
    "publishdate":"~Unix epoch time~",
    "introvideokey":"{{intro video key}}",
    "outrovideokey":"{{outro video key}}"
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Post to twitter

https://api.kwikmotion.com/v1/socialsharing/posttotwitter

This API is used to post video to twitter.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (json)

{
    "accountid": "~id~",
    "filephysicalfullpath":"~filephysicalfullpath~",
    "caption" : "~caption~",
    "publishdate":"~Unix epoch time~",
    "introvideokey":"{{intro video key}}",
    "outrovideokey":"{{outro video key}}"
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/socialsharing/posttotwitter' \\
  --data '{
    "accountid": "~id~",
    "filephysicalfullpath":"~filephysicalfullpath~",
    "caption" : "~caption~",
    "publishdate":"~Unix epoch time~",
    "introvideokey":"{{intro video key}}",
    "outrovideokey":"{{outro video key}}"
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Post to tiktok

https://api.kwikmotion.com/v1/socialsharing/posttotiktok

This API is used to post video to tiktok.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (json)

{
    "accountid": "~id~",
    "filephysicalfullpath":"~filephysicalfullpath~",
    "caption" : "~caption~",
    "publishdate":"~Unix epoch time~",
    "introvideokey":"{{intro video key}}",
    "outrovideokey":"{{outro video key}}"
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/socialsharing/posttotiktok' \\
  --data '{
    "accountid": "~id~",
    "filephysicalfullpath":"~filephysicalfullpath~",
    "caption" : "~caption~",
    "publishdate":"~Unix epoch time~",
    "introvideokey":"{{intro video key}}",
    "outrovideokey":"{{outro video key}}"
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

🚰

Sprinkler

AUTHORIZATION

Bearer Token

This folder is using Bearer Token from collection KWIKmotionAPIV2

POST List Sprinklr Profiles

https://api.kwikmotion.com/v1/socialsharing/sprinklrprofiles

This API is used to list sprinklr profiles.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (json)

{
    "output":"json"
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/socialsharing/sprinklrprofiles' \\
  --data '{
    "output":"json"
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Get Sprinklr Profile values

https://api.kwikmotion.com/v1/socialsharing/sprinklrprofilevalues

This API is used to get sprinklr values.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (json)

{
    "output":"json",
    "accountid":
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/socialsharing/sprinklrprofilevalues' \\
  --data '{
    "output":"json",
    "accountid":
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Get Sprinklr predefined settings

https://api.kwikmotion.com/v1/socialsharing/sprinklrprofiling

This API is used to get sprinklr predefined settings.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (json)

{
    "output":"json"
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/socialsharing/sprinklrprofiling' \\
  --data '{
    "output":"json"
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Post to Sprinklr

https://api.kwikmotion.com/v1/socialsharing/posttosprinklr

This API is used to post to sprinklr.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (json)

{
   "output": "json",
   "videoid": "{{video id}}",
   "videophysicalpath": "{{physical video path}}",
   "posttype": "{{clipping or editor}}",
   "accountid": "",
   "watermark": {{watermarkid}},
   "introvideokey": {{intro videokey}},
   "outrovideokey": {{outro videokey}},
   "data": "{\"name\": \"compilation\",\"assetStatus\":\"APPROVED\" \"assetType\": \"VIDEO\", \"description\": \"\", \"campaignIds\": [ \"6813_111\" ], \"availableAfterTime\": 1654756020000, \"visibleFromTime\": 1654842420000, \"visibleTillTime\": 1654928820000, \"expiryTime\": 1655015220000, \"tags\": \"test\", \"clientCustomProperties\": { \"599a8037e4b0f2c618e8fd3e\": [ \"ENTERTAINMENT\" ], \"5857f2f7e4b029b1e9080d50\": [ \"(comتفاعل) - تفاعلكم\" ], \"5aa4e9c6e4b03b65b2577c11\": [ \"Original Content\" ], \"5cc9b9d2e4b022c8fb53c4fb\": [ \"Shahid\" ], \"5e89d93ff4ea0c651db52aee\": [ \"Yes\" ], \"5a9cfcffe4b0bd0cd1d76d8e\": [ \"Less than 30 sec\" ], \"_c_60478933997ea65a0047bf76\": [ \"IGTV\" ], \"5b7bcf48e4b063944fcd242e\": [ \"Ali Ghamloush\" ], \"5b7bd109e4b063944fcdf894\": [ \"Ali Ghamloush\" ], \"5b7bd1eae4b063944fce7d04\": [ \"Ali Ghamloush\" ], \"5b7bd253e4b063944fcebc28\": [ \"Ali Ghamloush\" ], \"5b7bd2c1e4b063944fceebc6\": [ \"Ali Ghamloush\" ] } }"
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/socialsharing/posttosprinklr' \\
  --data '{
   "output": "json",
   "videoid": "{{video id}}",
   "videophysicalpath": "{{physical video path}}",
   "posttype": "{{clipping or editor}}",
   "accountid": "",
   "watermark": {{watermarkid}},
   "introvideokey": {{intro videokey}},
   "outrovideokey": {{outro videokey}},
   "data": "{\"name\": \"compilation\",\"assetStatus\":\"APPROVED\" \"assetType\": \"VIDEO\", \"description\": \"\", \"campaignIds\": [ \"6813_111\" ], \"availableAfterTime\": 1654756020000, \"visibleFromTime\": 1654842420000, \"visibleTillTime\": 1654928820000, \"expiryTime\": 1655015220000, \"tags\": \"test\", \"clientCustomProperties\": { \"599a8037e4b0f2c618e8fd3e\": [ \"ENTERTAINMENT\" ], \"5857f2f7e4b029b1e9080d50\": [ \"(comتفاعل) - تفاعلكم\" ], \"5aa4e9c6e4b03b65b2577c11\": [ \"Original Content\" ], \"5cc9b9d2e4b022c8fb53c4fb\": [ \"Shahid\" ], \"5e89d93ff4ea0c651db52aee\": [ \"Yes\" ], \"5a9cfcffe4b0bd0cd1d76d8e\": [ \"Less than 30 sec\" ], \"_c_60478933997ea65a0047bf76\": [ \"IGTV\" ], \"5b7bcf48e4b063944fcd242e\": [ \"Ali Ghamloush\" ], \"5b7bd109e4b063944fcdf894\": [ \"Ali Ghamloush\" ], \"5b7bd1eae4b063944fce7d04\": [ \"Ali Ghamloush\" ], \"5b7bd253e4b063944fcebc28\": [ \"Ali Ghamloush\" ], \"5b7bd2c1e4b063944fceebc6\": [ \"Ali Ghamloush\" ] } }"
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Sprinklr post status

https://api.kwikmotion.com/v1/socialsharing/poststatus

This API is used to get sprinklr post status.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (json)

{
    "output": "xml",
    "postid": 46308
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/socialsharing/poststatus' \\
  --data '{
    "output": "xml",
    "postid": 46308
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

📋

Playlists

AUTHORIZATION

Bearer Token

This folder is using Bearer Token from collection KWIKmotionAPIV2

POST Get Playlists

https://api.kwikmotion.com/v1/Playlist/GetPlayList

This API is used to get playlists.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (json)

{
    "referenceid": "2705b8ea-6778-43ad-ae98-3bb604afbfed",
    "output":"json"
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/Playlist/GetPlayList' \\
  --data '{
    "referenceid": "2705b8ea-6778-43ad-ae98-3bb604afbfed",
    "output":"json"
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

🤖

AI

AUTHORIZATION

Bearer Token

This folder is using Bearer Token from collection KWIKmotionAPIV2

POST Translate

https://api.kwikmotion.com/v1/ai/translate

This API is used to submit a text for translation by specifying the source language (translateFrom), the target languages (translateTo), and the text itself (textToTranslate). The API does not return the translated text immediately but confirms that the request has been successfully saved along with a recordID for tracking the translation status.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

session

2pebtz1e69fbo3ugexeg4g061fm1ta8jkl

Body

raw (json)

{
    "output":"json",
    "translateFrom":"Arabic",
    "translateTo":"English,French",
    "textToTranslate":"بفضل طبيعتها الساحرة وتضاريسها الجبلية المميزة، أصبحت تنورين مقصدًا لمحبي رياضة المشي الجبلي والتسلق والتخييم، حيث يمكن للزوار الاستمتاع بجمال المناظر الطبيعية والهواء النقي، مما يجعلها وجهة مثالية للراحة والاستجمام بعيدًا عن ضوضاء المدن."
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/ai/translate' \\
  --header 'session: 2pebtz1e69fbo3ugexeg4g061fm1ta8jkl' \\
  --data '{
    "output":"json",
    "translateFrom":"Arabic",
    "translateTo":"English,French",
    "textToTranslate":"بفضل طبيعتها الساحرة وتضاريسها الجبلية المميزة، أصبحت تنورين مقصدًا لمحبي رياضة المشي الجبلي والتسلق والتخييم، حيث يمكن للزوار الاستمتاع بجمال المناظر الطبيعية والهواء النقي، مما يجعلها وجهة مثالية للراحة والاستجمام بعيدًا عن ضوضاء المدن."
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Translate - Status

https://api.kwikmotion.com/v1/ai/translate/status

This API is used to check the translation status of a specific record by providing its recordID. The response will be returned in XML format, and caching is disabled to ensure the latest data is retrieved.

Request Parameters:

  • output (string) – Specifies the response format (json).
  • nocache (boolean) – Ensures fresh data is fetched (true disables caching).
  • recordID (integer) – The unique identifier of the record whose translation status is being queried.

Expected Response: The API will return a response containing the translation status of the specified recordID.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

HEADERS

session

2pebtz1e69fbo3ugexeg4g061fm1ta8jkl

Body

raw (json)

{
    "output":"json",
    "nocache":true,
    "recordID":25076
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/ai/translate/status' \\
  --header 'session: 2pebtz1e69fbo3ugexeg4g061fm1ta8jkl' \\
  --data '{
    "output":"json",
    "nocache":true,
    "recordID":25076
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Cropping - Process

https://api.kwikmotion.com/v1/aicropping/process

This API will create a process to crop a file based on AI technology and return a process ID that you can follow via the status API.

Notes on Parameters:

  • resolution can be 9/16, 1/1, 5/4
  • videoidtype can be either clipping or portal
  • Only one of the parameters is required either videoid (the id of the video in KWIKmotion) or the filepath (can be a network path in the platform nodes)

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (json)

{
    "output":"json",
    "resolution": "{{aspectratio}}",
    "videoid":{{videoid}},
    "inputpath" :"{{video path}}",
    "kmtitle" :"{{video title}}",
    "kmfolderid" : "{{video folder id}}",
    "kmtranscode" : {{1 or 0}},
    "kmtranscodeprofile": "{{ID of the transcoding profile}}",
    "videomaxduration": {{set the max video duration in seconds}}
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/aicropping/process' \\
  --data '{
    "output":"json",
    "resolution": "9/16",
    "videoid":123,
    "inputpath" :"/path/to/video.mp4",
    "kmtitle" :"My Video Title",
    "kmfolderid" : "0",
    "kmtranscode" : 1,
    "kmtranscodeprofile": "21",
    "videomaxduration": 60
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

POST Cropping - Status

https://api.kwikmotion.com/v1/aicropping/status

This API is used to check the cropping process status by providing the processid returned from the Process endpoint.

AUTHORIZATION

Bearer Token

This request is using Bearer Token from collection KWIKmotionAPIV2

Body

raw (json)

{
    "output":"json",
    "processid":"{{returned processID}}"
}

Example Request

curl --location 'https://api.kwikmotion.com/v1/aicropping/status' \\
  --data '{
    "output":"json",
    "processid":"process-id-12345"
}'

Example Response

Body

Headers (0)

No response body

This request doesn't return any response body

📞

Contact & Support

White Peaks Solutions SAS

🚀 Interactive API Explorer

Try out the API endpoints directly!
Click "Authorize" to add your Bearer token, then expand any endpoint and click "Try it out" to test.

📥 Download OpenAPI Spec: openapi.json ← Import to Postman/Insomnia