Konch was built as an API first so all our operations are performed as data requests to our knch.io server. We have also built our platform from the ground up with GDPR in mind. Our EU and US clusters are seperated by the "eu" subdomain.

You can generate your API Key via https://app.konch.ai/settings/integrations. All requests require the "key" and its related user "id" as header parameters.

Please see our path definitions in the guide below. You will notice some endpoints use POST instead of GET for get-like requests. That is becuase some endpoints required body content for pagination or other object-formed variables. Additionally, we have evolved our offering since launch and some endpoints in V1 addmitingly have cruft. We are currently working on a new set of API endpoints for our V2 release which will be far more RESTful and intuitive. Our V2 endpoints plan to be backward compatible.

To help kick start development, here is a the Start Processing POST request in various flavors.

cURL

curl --request POST \
  --url https://konch.io/pipeline/dev/user/user-id-here/collections/ \
  --header 'Content-Type: application/json' \
  --header 'id: user-id-here' \
  --header 'key: user-generated-key-here' \
  --data '{
    "url": "https://.....public_accessible.mp4",
    "orgId": "your-org-id",
    "languageCode": "en-US",
    "name": "Test"
}'

Golang

package main

import (
    "fmt"
    "strings"
    "net/http"
    "io/ioutil"
)

func main() {

    url := "https://konch.io/pipeline/dev/user/user-id-here/collections/"

    payload := strings.NewReader("{\n\t\"url\": \"https://.....public_accessible.mp4\",\n\t\"orgId\": \"your-org-id\",\n\t\"languageCode\": \"en-US\",\n\t\"name\": \"Test\"\n}")

    req, _ := http.NewRequest("POST", url, payload)

    req.Header.Add("id", "user-id-here")
    req.Header.Add("key", "user-generated-key-here")
    req.Header.Add("Content-Type", "application/json")

    res, _ := http.DefaultClient.Do(req)

    defer res.Body.Close()
    body, _ := ioutil.ReadAll(res.Body)

    fmt.Println(res)
    fmt.Println(string(body))

}

Python

import requests

url = "https://konch.io/pipeline/dev/user/user-id-here/collections/"

payload = {
    "url": "https://.....public_accessible.mp4",
    "orgId": "your-org-id",
    "languageCode": "en-US",
    "name": "Test"
}
headers = {
    "id": "user-id-here",
    "key": "user-generated-key-here",
    "Content-Type": "application/json"
}

response = requests.request("POST", url, json=payload, headers=headers)

print(response.text)

Javascript

fetch("https://konch.io/pipeline/dev/user/user-id-here/collections/", {
  "method": "POST",
  "headers": {
    "id": "user-id-here",
    "key": "user-generated-key-here",
    "Content-Type": "application/json"
  },
  "body": "{\"url\":\"https://.....public_accessible.mp4\",\"orgId\":\"your-org-id\",\"languageCode\":\"en-US\",\"name\":\"Test\"}"
})
.then(response => {
  console.log(response);
})
.catch(err => {
  console.error(err);
});

And now, on to the API library!

User plans, usage, and related collections.

When assets are submitted they are placed into our pipeline for processing.