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 |
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.
Get user's plan and overage details
| orgId | string <uuid> If the user wants the parent org info. |
| userId | string <uuid> For user specific usage and plan info. |
{- "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}Get the user's collections
| limit | number |
| nextPage | string <uuid> |
| orgId | string <uuid> |
| orgWide | boolean |
| startTime | number <epoch> |
| endTime | number <epoch> |
{- "limit": 0,
- "nextPage": "7e49edcd-d10b-4373-98b4-f553146b4ad9",
- "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa",
- "orgWide": true,
- "startTime": 0,
- "endTime": 0
}Update the user's dictionary
| name | string |
| language | string |
object |
{- "name": "string",
- "language": "string",
- "terms": {
- "word": "sound1, ... soundN",
- "howdy": "How Dee, howdee",
- "Jenkins": "jay kins, jank ins"
}
}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.
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.
| orgId | string <uuid> If the user wants the parent org info. |
| userId | string <uuid> For user specific usage and plan info. |
{- "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}The updated V2 Collections endpoint access meta data, assets, and transcription information about your collection.
Create a new highlight based on highlight ID
| cid required | uuid UID of the collection |
| content | string |
| tags | object |
{- "content": "string",
- "tags": { }
}{- "id": null,
- "content": "string",