Konch API (2.1)

Download OpenAPI specification:Download

Konch API Support: support@konch.ai URL: https://www.konch.ai License: Konch

Introduction

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.

Region API URL
EU eu.knch.io
US (Non-EU) konch.io

Authentication

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.

Getting started guide

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.

User

User plans, usage, and related collections.

Plan and Usage

Get user's plan and overage details

Request Body schema: application/json
orgId
string <uuid>

If the user wants the parent org info.

userId
string <uuid>

For user specific usage and plan info.

Request samples

Content type
application/json
{
  • "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Get collections

Get the user's collections

Request Body schema: application/json
limit
number
nextPage
string <uuid>
orgId
string <uuid>
orgWide
boolean
startTime
number <epoch>
endTime
number <epoch>

Request samples

Content type
application/json
{
  • "limit": 0,
  • "nextPage": "7e49edcd-d10b-4373-98b4-f553146b4ad9",
  • "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa",
  • "orgWide": true,
  • "startTime": 0,
  • "endTime": 0
}

List Dictionary

Get the user's dictionaries

Get Dictionary

Get the user's dictionary

Update Dictionary

Update the user's dictionary

Request Body schema: application/json
name
string
language
string
object

Request samples

Content type
application/json
{
  • "name": "string",
  • "language": "string",
  • "terms":
    {
    }
}

Delete Dictionary

Delete the user's dictionary

Pipeline

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

Start Processing

Start processing a collection media asset

Request Body schema: application/json
url
required
string <uri>

url of asset

webhook
string <uri>
languageCode
required
string
name
string

Request samples

Content type
application/json
{}

Retry

In some cases an issue could arise with the processing of your collection. If thats the case, you may use this endpoint to try and invoke the pipeline again. However, you can only retry once, and it must only be used after the pipeline is given ample oppertunity to complete. Approximatly 2x the assets length in time.

Un-Pause

If you have submitted more assets that lead to an estimated an overage you workflow will be paused for your collection. You may use this endpoint to start processing again only if you in-process and used minutes do not create an overage. You can either wait for that to occur, or upgrade your subscription. User or org information must be passed as a check on your plan is tested in the call.

Request Body schema: application/json
orgId
string <uuid>

If the user wants the parent org info.

userId
string <uuid>

For user specific usage and plan info.

Request samples

Content type
application/json
{
  • "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Collections (V2)

The updated V2 Collections endpoint access meta data, assets, and transcription information about your collection.

Search Collections

Search Collections

Request Body schema: application/json
term
string
orgId
string

Request samples

Content type
application/json
{
  • "term": "string",
  • "orgId": "string"
}

Get Metadata

Get a collections metadata

path Parameters
cid
required
uuid

UID of the collection

Get Metadata

Update a collections metadata

path Parameters
cid
required
uuid

UID of the collection

Get highlights

Get highlights

New Highlight

Create a new highlight based on highlight ID

path Parameters
cid
required
uuid

UID of the collection

Request Body schema: application/json
content
string
tags
object

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "tags": { }
}

Response samples

Content type
application/json
{
  • "id": null,
  • "content": "string",