Met de Externe Simpele tekst API kun je automatisch samenvattingen in eenvoudige taal laten genereren van teksten op jouw website.
Deze simpele teksten kun je vervolgens tonen aan bezoekers, bijvoorbeeld bij nieuwsartikelen of lange webpagina’s.
Je vindt deze functionaliteit als API-endpoint en kunt hem direct vanuit je eigen systeem aanroepen.
Wat doet deze API?
Met dit endpoint kun je:
één of meerdere tekstblokken aanleveren;
een automatische simpele tekst laten maken;
de simpele tekst opslaan en ophalen per pagina, per taal.
De API genereert een korte beschrijving én meerdere samenvattende punten.
Als er al eerder een simpele tekst voor dezelfde pagina is gemaakt en de tekst is niet gewijzigd, dan wordt automatisch de bestaande simpele tekst teruggegeven.
Authenticatie
Het endpoint maakt gebruik van token-authenticatie.
Stel de volgende header in:
Authorization: Token {jouw_token}Er is geen Origin-header nodig.
Aanvraag (request)
Endpoint:
POST https://api.tolkie.nl/api/v1/tolkie/summarize-external
Body:
{
"text_list": [
{ "id": 1, "text": "string" },
{ "id": 2, "text": "string" }
],
"url_field": "https://example.com/news/123",
"content_lang": "nl"
}Uitleg velden
text_list
Een lijst van tekstfragmenten die samen worden samengevat.
De totale lengte moet minimaal 150 tekens zijn.url_field
De volledige URL van de pagina waar de tekst op staat.
Deze waarde wordt gebruikt om de simpele tekst per pagina op te slaan.content_lang (optioneel)
De taalcode van de inhoud (bijv.nl,en-us).
Als dit ontbreekt, wordt de standaardtaal van de klant gebruikt.
Antwoord (response)
Als er een simpele tekst beschikbaar is, ziet het antwoord er zo uit:
{
"description": "Korte beschrijving van het artikel.",
"summaryLines": [
{ "text": "Belangrijk punt 1." },
{ "text": "Belangrijk punt 2." }
]
}Als er geen simpele tekst kan worden gemaakt, retourneert de API:
{}Belangrijk om te weten
Opslag en caching
Simpele teksten worden opgeslagen per klant + pad + taal.
Als de aangeleverde tekst hetzelfde blijft, retourneert de API de bestaande simpele tekst.
Als de tekst verandert, wordt automatisch een nieuwe simpele tekst aangemaakt.
Fouten en validatie
De API geeft:
400 bij ongeldige velden of te weinig tekst (minder dan 150 tekens);
401 bij een ontbrekend of ongeldig token;
403 wanneer de simpele teksten zijn uitgeschakeld voor dit account
200 met {} als er geen simpele tekst kan worden gegenereerd.