API-Referenz: KI

Die KI-Endpunkte führen KI-Prompts asynchron aus und ermöglichen es Ihnen, das Ergebnis abzufragen.

Direkten KI-Prompt starten (asynchron; POST …/ai/{promptType}/status mit demselben Body abfragen)

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

Authentifizierung: Mandantengebundener API-Schlüssel · Bereich write

Parameter:

Name	Typ	Position	Erforderlich	Beschreibung
tenantId	string	path	Ja	Format: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	path	Ja	Zulässige Werte: processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

Request Body:

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

Feld	Typ	Erforderlich	Beschreibung
prompt	string	Ja	Prompt in natürlicher Sprache Maximale Länge: 10000
summaryVariant	string	Nein

Antwort (200):

KI-Ergebnis (Status: success | generating | error)

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

Feld	Typ	Erforderlich	Beschreibung
status	success | error | generating	Ja	Zulässige Werte: success, error, generating
result	object | object | object | object | object | object	Nein	Prompt-spezifische Ergebnisdaten (vorhanden, wenn der Status success ist)
error	string	Nein	Fehlermeldung, wenn der Status error ist

Fehler:

• 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 429 Nutzungslimit erreicht

Laufende KI-Generierung abfragen (exakt denselben Body wie beim auslösenden POST senden)

Die Abfrage per POST ist beabsichtigt: Die Generierung wird anhand von Prompt, promptType und summaryVariant identifiziert. Daher wiederholt die Abfrage den Body, statt eine Run-ID anzusprechen.

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

Authentifizierung: Mandantengebundener API-Schlüssel · Bereich write

Parameter:

Name	Typ	Position	Erforderlich	Beschreibung
tenantId	string	path	Ja	Format: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	path	Ja	Zulässige Werte: processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

Request Body:

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

Feld	Typ	Erforderlich	Beschreibung
prompt	string	Ja	Prompt in natürlicher Sprache Maximale Länge: 10000
summaryVariant	string	Nein

Antwort (200):

KI-Ergebnis (Status: success | generating | error)

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

Feld	Typ	Erforderlich	Beschreibung
status	success | error | generating	Ja	Zulässige Werte: success, error, generating
result	object | object | object | object | object | object	Nein	Prompt-spezifische Ergebnisdaten (vorhanden, wenn der Status success ist)
error	string	Nein	Fehlermeldung, wenn der Status error ist

Fehler:

• 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 429 Nutzungslimit erreicht