API-documentatie: AI

De AI-endpoints voeren AI-prompts asynchroon uit. Je kunt de resultaten opvragen.

Een rechtstreekse AI-prompt starten (asynchroon; vraag de status op via POST …/ai/{promptType}/status met dezelfde body)

Endpoint: POST /v1/tenant/{tenantId}/ai/{promptType}

Authenticatie: Tenantgebonden API-sleutel · scope write

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Indeling: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	pad	Ja	Toegestane waarden: processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

Request body:

{
	"prompt": "string",
	"summaryVariant": "string"
}

Veld	Type	Verplicht	Beschrijving
prompt	string	Ja	Prompt in natuurlijke taal Maximale lengte: 10000
summaryVariant	string	Nee

Response (200):

AI-resultaat (status: success | generating | error)

{
	"status": "success",
	"result": {
		"type": "processAnalysis",
		"analysis": "string"
	},
	"error": "string"
}

Veld	Type	Verplicht	Beschrijving
status	success | error | generating	Ja	Toegestane waarden: success, error, generating
result	object | object | object | object | object | object	Nee	Resultaatgegevens voor de betreffende prompt (aanwezig als de status success is)
error	string	Nee	Foutmelding als de status error is

Fouten:

• 401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
• 429 Gebruikslimiet bereikt

Een lopende AI-generatie opvragen (stuur exact dezelfde body als bij de POST waarmee deze is gestart)

De POST-aanroep wordt gebruikt om de status op te vragen. De generatie is gekoppeld aan prompt + promptType + summaryVariant. Daarom herhaalt de statusaanvraag de body in plaats van een run-id te gebruiken.

Endpoint: POST /v1/tenant/{tenantId}/ai/{promptType}/status

Authenticatie: Tenantgebonden API-sleutel · scope write

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Indeling: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	pad	Ja	Toegestane waarden: processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

Request body:

{
	"prompt": "string",
	"summaryVariant": "string"
}

Veld	Type	Verplicht	Beschrijving
prompt	string	Ja	Prompt in natuurlijke taal Maximale lengte: 10000
summaryVariant	string	Nee

Response (200):

AI-resultaat (status: success | generating | error)

{
	"status": "success",
	"result": {
		"type": "processAnalysis",
		"analysis": "string"
	},
	"error": "string"
}

Veld	Type	Verplicht	Beschrijving
status	success | error | generating	Ja	Toegestane waarden: success, error, generating
result	object | object | object | object | object | object	Nee	Resultaatgegevens voor de betreffende prompt (aanwezig als de status success is)
error	string	Nee	Foutmelding als de status error is

Fouten:

• 401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
• 429 Gebruikslimiet bereikt