API-Referenz: KI

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

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

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

Authentifizierung: Mandantengebundener API-Schlüssel · Berechtigungsbereich write

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	string	Pfad	Ja	Format: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	Pfad	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	Ergebnispayload für den jeweiligen Prompt (vorhanden, wenn der Status success lautet)
error	string	Nein	Fehlermeldung, wenn der Status error lautet

Fehler:

• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 429 Nutzungslimit erreicht

Laufende KI-Generierung abfragen (senden Sie exakt denselben Body wie beim POST-Aufruf zum Starten)

Die Abfrage erfolgt bewusst per POST: Die Generierung wird anhand von Prompt, promptType und summaryVariant identifiziert. Deshalb wiederholt die Abfrage den Body, statt eine Run-ID zu verwenden.

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

Authentifizierung: Mandantengebundener API-Schlüssel · Berechtigungsbereich write

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	string	Pfad	Ja	Format: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	Pfad	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	Ergebnispayload für den jeweiligen Prompt (vorhanden, wenn der Status success lautet)
error	string	Nein	Fehlermeldung, wenn der Status error lautet

Fehler:

• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 429 Nutzungslimit erreicht