Dokumentacja API: AI

Endpointy AI przetwarzają prompty asynchronicznie. Wynik można sprawdzać za pomocą kolejnych żądań.

Uruchom bezpośredni prompt AI (asynchronicznie; sprawdzaj POST …/ai/{promptType}/status, przesyłając tę samą treść żądania)

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

Uwierzytelnianie: klucz API przypisany do tenanta · zakres write

Parametry:

Nazwa	Typ	Lokalizacja	Wymagany	Opis
tenantId	string	path	Tak	Format: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	path	Tak	Dozwolone wartości: processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

Treść żądania:

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

Pole	Typ	Wymagane	Opis
prompt	string	Tak	Prompt w języku naturalnym Maksymalna długość: 10000
summaryVariant	string	Nie

Odpowiedź (200):

Wynik AI (status: success | generating | error)

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

Pole	Typ	Wymagane	Opis
status	success | error | generating	Tak	Dozwolone wartości: success, error, generating
result	object | object | object | object | object | object	Nie	Wynik zależny od promptu (dostępny, gdy status ma wartość success)
error	string	Nie	Komunikat o błędzie, gdy status ma wartość error

Błędy:

• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 429 Osiągnięto limit użycia

Sprawdzanie trwającego generowania AI (należy przesłać dokładnie tę samą treść żądania co w POST, który je uruchomił)

Sprawdzanie wyniku odbywa się za pomocą POST. Generowanie jest identyfikowane na podstawie promptu, promptType i summaryVariant, dlatego w żądaniu sprawdzającym należy ponownie przesłać treść żądania zamiast podawać identyfikator uruchomienia.

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

Uwierzytelnianie: klucz API przypisany do tenanta · zakres write

Parametry:

Nazwa	Typ	Lokalizacja	Wymagany	Opis
tenantId	string	path	Tak	Format: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	path	Tak	Dozwolone wartości: processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

Treść żądania:

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

Pole	Typ	Wymagane	Opis
prompt	string	Tak	Prompt w języku naturalnym Maksymalna długość: 10000
summaryVariant	string	Nie

Odpowiedź (200):

Wynik AI (status: success | generating | error)

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

Pole	Typ	Wymagane	Opis
status	success | error | generating	Tak	Dozwolone wartości: success, error, generating
result	object | object | object | object | object | object	Nie	Wynik zależny od promptu (dostępny, gdy status ma wartość success)
error	string	Nie	Komunikat o błędzie, gdy status ma wartość error

Błędy:

• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 429 Osiągnięto limit użycia