Agents · LeadForge docs

Een agent is de chat-agent op je website. Met dit adres haal je je agents op, samen met kant-en-klare embedcodes. Zo kun je de code voor je site automatisch ophalen in plaats van hem uit de app te kopiëren.

GET https://leadforge.nl/api/v1/agents

Vraagt read

De agents van je werkruimte met hun embedcodes, oudste eerst.

Parameters

Geen. De lijst heeft geen paginering en geen filters. Gearchiveerde agents komen niet mee.

Antwoord

Velden

Naam	Type	Beschrijving
id	tekst	De publieke sleutel van de agent. Dit is de waarde die in de embedcode staat.
name	tekst	De naam van de agent.
status	tekst	ACTIVE (actief), PAUSED (gepauzeerd) of DRAFT (concept).
createdAt	datum (ISO)	Wanneer de agent is aangemaakt.
updatedAt	datum (ISO)	Wanneer de agent voor het laatst is gewijzigd.
embeds.banner.url	tekst	Het adres van de banner met vraagveld voor deze agent.
embeds.banner.html	tekst	Een iframe met de banner, 64 pixels hoog en over de volle breedte.
embeds.widget.scriptUrl	tekst	Het adres van het widgetscript lf-widget.js.
embeds.widget.html	tekst	De scripttag van de widget, met data-agent en defer.
embeds.fullscreen.url	tekst	De chat op een eigen pagina op volledige grootte.

curl

curl https://leadforge.nl/api/v1/agents \
  -H "Authorization: Bearer LF_LIVE_SLEUTEL"

JSON Antwoord 200

{
	"data": [
		{
			"id": "<publieke sleutel van de agent>",
			"name": "Assistent op de site",
			"status": "ACTIVE",
			"createdAt": "2026-10-01T08:00:00.000Z",
			"updatedAt": "2026-11-03T15:20:00.000Z",
			"embeds": {
				"banner": {
					"url": "<adres van de banner>?agent=<id>",
					"html": "<iframe src=\"<adres van de banner>?agent=<id>\" style=\"border:0;width:100%;height:64px\" title=\"Chat met ons\"></iframe>"
				},
				"widget": {
					"scriptUrl": "<adres van lf-widget.js>",
					"html": "<script src=\"<adres van lf-widget.js>\" data-agent=\"<id>\" defer></script>"
				},
				"fullscreen": {
					"url": "https://leadforge.nl/chat?agent=<id>"
				}
			}
		}
	]
}

Goed om te weten

De adressen in embeds staan in het echte antwoord volledig ingevuld. Neem html ongewijzigd over in je site; je hoeft er zelf geen adres in te zetten. In het voorbeeld hierboven staan plaatshouders.

Status	Code	Wanneer
200		De lijst met agents. Zonder agents is data een lege lijst.
401	unauthorized	Geen geldige sleutel.
403	forbidden	De sleutel heeft geen read, of hoort niet bij één werkruimte.
429	rate_limited	Meer dan 120 verzoeken per minuut.

Verder lezen

De widget op je site zetten
Banner met vraagveld
Content gaps: de vragen die je agent niet kon beantwoorden