Lees hier meer over onze

API documentatie

In de onderstaande documentatie leggen we op een zo makkelijk mogelijke manier uit hoe u onze AI modellen kunt gebruiken via onze API. Onze API is een v1 generatie dus er zullen regelmatig updates / bug fixes uitgerolt worden. Houd de documentatie en onze blogs goed in de gaten. 

Komt u er toch niet helemaal uit, plan dan gerust een consult in. 

API credits

API credits zijn het beschikbaar crediet wat op uw account staat. Om het gebruik van onze API simpel en soepel te laten verlopen gebruiken wij crediet op uw account om de kosten van uw API request te berekenen. 

Heeft u aan het einde van het jaar credits over, dan neemt u deze mee naar volgend jaar of kunt u deze terugvragen.

*1 credit = € 0.001

  • Audio – Standaard   =   65 credits
  • Audio – Dialogue   =   75 credits

*prijzen per 1 minute audio

  • Translation   =   25 credits
  • Q & A   =   30 credits
  • Highlight   =   15 credits
  • Detect Language   =   15 credits
  • Summary   =   50 credits

*prijzen per 100 woorden

  • PDF OCR   =   50 credits
  • Image OCR =  50 credits

*prijzen per pagina. (Afbeelding geld als 1 pagina)

Audio transcribtie

Met de “Audio transcribtion” API endpoint heeft u de mogelijkheid om audio files om te zetten naar tekst. Deze AI activeren kan door een POST request naar het bovenstaande endpoint te sturen. 

  • UserToken: Dit is de username van uw account
  • userSecret: Dit is uw geheime wachtwoord
  • filelocation: Een openbare online locatie waar wij uw audio-file (.mp3 format) kunnen vinden.
  • dialogue: true of false. Hierin geeft u aan of u de transcribtie als “gesprek” wilt verwerken of niet. (Letop, deze optie kost meer om te runnen en duurt langer)
Request [POST]
{
  "userToken": "Hier komt uw username",
  "userSecret": "Hier komt uw password",
  "filelocation": "online_locatie.nl/audio.mp3",
  "dialogue": "true of false"
}
Response - zonder dialogue
{
  "Text": "Hier komt alle transcribtie tekst uit uw audio-file."
}
Response - met dialogue
[
	{
		"speaker": "SPEAKER_00",
		"start": 498.0,
		"end": 700.0,
		"transcribtion": " Hier komt alles wat SPEAKER_01 gezegt heeft."
	},
	{
		"speaker": "SPEAKER_01",
		"start": 10000.0,
		"end": 25000.0,
		"transcribtion": " Hier komt alles wat SPEAKER_01 heeft gezegt."
	}

Translate

Met de “translate” API endpoint heeft u de mogelijkheid om tekst te vertalen. Deze AI activeren kan door een POST request naar het bovenstaande endpoint te sturen. 

  • UserToken: Dit is de username van uw account
  • userSecret: Dit is uw geheime wachtwoord
  • inputText: Stuur de tekst mee die u wilt laten vertalen.
  • inputLanguage: Shortcode van inputtaal. Bijvoorbeeld: nl, en, fr etc.
  • outputLanguage: Shortcode van outputtaal. Bijvoorbeeld: nl, en, fr etc.
Request [POST]
{
  "userToken": "Hier komt uw username",
  "userSecret": "Hier komt uw password",
  "inputText": "Hier komt de tekst die u wilt vertalen",
  "inputLanguage": "shortcode van input taal bijvoorbeeld (nl of en)",
  "outputLanguage": "shortcode van output taal"
}
Response
{
  "status": "Success",
  "inputText": "Hallo goedemorgen meneer",
  "inputLanguage": "nl",
  "ouputText": "hello good morning sir",
  "outputLanguage": "en"
}

Q & A

Met de “Q&A” API endpoint heeft u de mogelijkheid om context te geven en hier vragen over te stellen. Deze AI activeren kan door een POST request naar het bovenstaande endpoint te sturen. 

  • UserToken: Dit is de username van uw account
  • userSecret: Dit is uw geheime wachtwoord
  • inputQuestion: Dit is de vraag die u aan de AI wilt stellen.
  • inputContext: Dit is de tekst die u de AI als context voor uw vraag meegeeft. 

*ondersteunde talen voor de Q&A zijn momenteel NL en EN.

Request [POST]
{
  "userToken": "Hier komt uw username",
  "userSecret": "Hier komt uw password",
  "inputQuestion": "Hoeveel poten heeft een spin?",
  "inputContext": "Spinnen behoren tot de Araneae familie. Spinnen zijn kenmerkend voor het hebben van 8 poten. Normale insecten hebben er 6"
}
Response
{
  "status": "Success",
  "question": "Hoeveel poten heeft een spin?",
  "answer": "8",
  "score": 0.7366771697998047
}

*De ‘score’ in uw response geeft aan hoe zeker de AI is van het antwoord. 0.73 = 73%

Highlight

Met de “highlight” API endpoint heeft u de mogelijkheid om de belangrijkste zin / portie te selecteren. Deze AI activeren kan door een POST request naar het bovenstaande endpoint te sturen. 

  • UserToken: Dit is de username van uw account
  • userSecret: Dit is uw geheime wachtwoord
  • inputText: Stuur de tekst mee die u wilt analyseren.

Krijgt u de error “Not enough input tekst to detect highlight” dan heeft de AI niet genoeg tekst om duidelijk het belangrijkste deel te detecteren.

Request [POST]
{
  "userToken": "Hier komt uw username",
  "userSecret": "Hier komt uw password",
  "inputText": "Hier komt de tekst die u wilt analyseren"
}
Response
{
  "input_text": "Spinnen (Araneae) vormen een orde van geleedpotigen die behoren tot de klasse van de spinachtigen (Arachnida). Andere spinachtigen worden ook wel met de term 'spin' aangeduid, zoals de zeespinnen en de zweepspinnen. De vertegenwoordigers van de orde Araneae worden daarom ook wel 'echte spinnen' genoemd om ze van de andere groepen te onderscheiden. Er zijn bijna 50.000 spinnensoorten beschreven en benoemd, en dat aantal neemt nog jaarlijks toe.[2] Spinnen komen over de hele wereld voor en vertonen een grote variatie in lichaamsbouw, gedrag en voedselspecialisatie. De populatiedichtheid kan hoog zijn. De Britse spinnenkenner William Syer Bristowe omschreef de spinnen eens als een reusachtig tapijt dat de aarde omspant. Spinnen worden verdeeld in twee basale groepen: de tangkakigen (Araneomorphae) en de rechtkakigen of vogelspinachtigen (Mygalomorphae).",
  "status": "success",
  "Highlight": "Spinnen worden verdeeld in twee basale groepen: de tangkakigen (Araneomorphae) en de rechtkakigen of vogelspinachtigen (Mygalomorphae)."
}
Response - Niet genoeg tekst
{
  "ERROR": "Not enough input text to detect highlight"
}

Detect Language

Met de “Detect Language” API endpoint heeft u de mogelijkheid om de taal van een stuk tekst te detecteren. Deze AI activeren kan door een POST request naar het bovenstaande endpoint te sturen. 

  • UserToken: Dit is de username van uw account
  • userSecret: Dit is uw geheime wachtwoord
  • inputText: Stuur de tekst mee die u wilt analyseren.
  • inputType: article / conversation

*inputType, ‘article’ is te gebruiken bij algemene tekst. ‘conversation’ wordt gebruikt voor bijvoorbeeld chats tussen 2 of meer personen

Request [POST]
{
  "userToken": "Hier komt uw username",
  "userSecret": "Hier komt uw password",
  "inputText": "Hier komt de tekst die u wilt analyseren"
  "inputType": "article / conversation"
}
Response
{
  "input_text": "Hallo goedemorgen meneer",
  "status": "success",
  "language_detected": "Dutch"
}

Summary

Met de “Summary” API endpoint heeft u de mogelijkheid om grote teksten samen te vatten. Deze AI activeren kan door een POST request naar het bovenstaande endpoint te sturen. 

  • UserToken: Dit is de username van uw account
  • userSecret: Dit is uw geheime wachtwoord
  • inputText: Stuur de tekst mee die u wilt analyseren.
  • inputLanguage: shortcode voor input taal, nl of en.

*LETOP, deze endpoint werkt het best voor grote stukken tekst. Resultaten worden zwak bij slechts een paar zinnen.

Request [POST]
{
  "userToken": "Hier komt uw username",
  "userSecret": "Hier komt uw password",
  "inputText": "Spinnen (Araneae) vormen een orde van geleedpotigen die behoren tot de klasse van de spinachtigen (Arachnida). Andere spinachtigen worden ook wel met de term 'spin' aangeduid, zoals de zeespinnen en de zweepspinnen. De vertegenwoordigers van de orde Araneae worden daarom ook wel 'echte spinnen' genoemd om ze van de andere groepen te onderscheiden. Er zijn bijna 50.000 spinnensoorten beschreven en benoemd, en dat aantal neemt nog jaarlijks toe.[2] Spinnen komen over de hele wereld voor en vertonen een grote variatie in lichaamsbouw, gedrag en voedselspecialisatie. De populatiedichtheid kan hoog zijn. De Britse spinnenkenner William Syer Bristowe omschreef de spinnen eens als een reusachtig tapijt dat de aarde omspant. Spinnen worden verdeeld in twee basale groepen: de tangkakigen (Araneomorphae) en de rechtkakigen of vogelspinachtigen (Mygalomorphae).",
  "inputLanguage": "nl"
}
Response
{
    "inputText": "Ingezonden tekst",
    "status": "Succes",
    "outputText": "Samenvatting"
}

PDF Tekst Detection

Met de “Tekst Detection” API endpoint heeft u de mogelijkheid om PDF’s door onze geavanceerde Computer vision, OCR en NLP modellen te laten zoeken naar tekst en deze te exporteren.

  • UserToken: Dit is de username van uw account
  • userSecret: Dit is uw geheime wachtwoord
  • filelocation: Openbare online locatie
  • outputFormat: Structured , raw text

LETOP: Voor outputFormat “structured” geeft naast de woorden de structuur van het PDF terug. 

Elk “block”, “Line” en “words” heeft de volgende attributen:

  • Value: Dit is de daadwerkelijke waarde
  • Confidence: Procentuele zekerheid van AI model
  • Geometry: Coordinaten waar dit element in het document staat.  
Request [POST]
{
  "userToken": "Hier komt uw username",
  "userSecret": "Hier komt uw password",
  "filelocation": "https://uwonlinelocatie.nl/test.pdf",
  "outputFormat": "structured" / "raw text"
}
Response - raw text
{
    "text": "Hier komt uw PDF text"
}
Response - structured
{
  "document":{
    "block":{
      "lines":{
        "words":{
          "value": "Test",
		  "confidence":0.505984425544738,
		  "geometry": [[0.119140625,0.0908203125],[0.169921875,0.107421875]
        }
      }
    }
  }
}

Image Tekst Detection

Met de “Tekst Detection” API endpoint heeft u de mogelijkheid om afbeeldingen door onze geavanceerde Computer vision, OCR en NLP modellen te laten zoeken naar tekst en deze te exporteren.

  • UserToken: Dit is de username van uw account
  • userSecret: Dit is uw geheime wachtwoord
  • filelocation: Openbare online locatie (.JPG file)
  • outputFormat: Structured , raw text

LETOP: Voor outputFormat “structured” geeft naast de woorden de structuur van de afbeelding terug. 

Elk “block”, “Line” en “words” heeft de volgende attributen:

  • Value: Dit is de daadwerkelijke waarde
  • Confidence: Procentuele zekerheid van AI model
  • Geometry: Coordinaten waar dit element in het document staat.  
Request [POST]
{
  "userToken": "Hier komt uw username",
  "userSecret": "Hier komt uw password",
  "filelocation": "https://uwonlinelocatie.nl/test.jpg",
  "outputFormat": "structured" / "raw text"
}
Response - raw text
{
    "text": "Hier komt uw PDF text"
}
Response - structured
{
  "document":{
    "block":{
      "lines":{
        "words":{
          "value": "Test",
		  "confidence":0.505984425544738,
		  "geometry": [[0.119140625,0.0908203125],[0.169921875,0.107421875]
        }
      }
    }
  }
}