Reference API: AI

AI endpointy spouštějí AI prompty asynchronně a umožňují opakovaně zjišťovat, zda je výsledek hotový.

Spuštění přímého AI promptu (asynchronně; výsledek zjišťujte voláním POST …/ai/{promptType}/status se stejným tělem požadavku)

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

Ověření: API key vázaný na tenant · rozsah oprávnění write

Parametry:

Název	Typ	Umístění	Povinné	Popis
tenantId	string	path	Ano	Formát: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	path	Ano	Povolené hodnoty: processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

Tělo požadavku:

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

Pole	Typ	Povinné	Popis
prompt	string	Ano	Prompt v přirozeném jazyce Maximální délka: 10 000
summaryVariant	string	Ne

Odpověď (200):

Výsledek AI (stav: success | generating | error)

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

Pole	Typ	Povinné	Popis
status	success | error | generating	Ano	Povolené hodnoty: success, error, generating
result	object | object | object | object | object | object	Ne	Výsledek specifický pro prompt (je k dispozici, když je status success)
error	string	Ne	Chybová zpráva, když je status error

Chyby:

• 401 Chybí API key, je neplatný, vypnutý nebo jeho platnost vypršela
• 429 Dosažen limit využití

Zjištění stavu probíhajícího generování AI (odešlete přesně stejné tělo jako v požadavku POST, kterým jste generování spustili)

Použití POST pro zjištění stavu je záměrné: generování se identifikuje podle promptu, promptType a summaryVariant. Proto se při dotazu opakuje tělo požadavku místo použití ID běhu.

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

Ověření: API key vázaný na tenant · rozsah oprávnění write

Parametry:

Název	Typ	Umístění	Povinné	Popis
tenantId	string	path	Ano	Formát: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	path	Ano	Povolené hodnoty: processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

Tělo požadavku:

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

Pole	Typ	Povinné	Popis
prompt	string	Ano	Prompt v přirozeném jazyce Maximální délka: 10 000
summaryVariant	string	Ne

Odpověď (200):

Výsledek AI (stav: success | generating | error)

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

Pole	Typ	Povinné	Popis
status	success | error | generating	Ano	Povolené hodnoty: success, error, generating
result	object | object | object | object | object | object	Ne	Výsledek specifický pro prompt (je k dispozici, když je status success)
error	string	Ne	Chybová zpráva, když je status error

Chyby:

• 401 Chybí API key, je neplatný, vypnutý nebo jeho platnost vypršela
• 429 Dosažen limit využití