Documentazione di riferimento dell’API: AI

Gli endpoint AI eseguono i prompt AI in modo asincrono e consentono di verificare il risultato.

Avviare un prompt AI diretto (asincrono; inviare richieste POST …/ai/{promptType}/status con lo stesso corpo per verificarne lo stato)

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

Autenticazione: chiave API con ambito limitato al tenant · ambito write

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	percorso	Sì	Formato: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	percorso	Sì	Valori consentiti: processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

Corpo della richiesta:

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

Campo	Tipo	Obbligatorio	Descrizione
prompt	string	Sì	Prompt in linguaggio naturale Lunghezza massima: 10000
summaryVariant	string	No

Risposta (200):

Risultato AI (stato: success | generating | error)

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

Campo	Tipo	Obbligatorio	Descrizione
status	success | error | generating	Sì	Valori consentiti: success, error, generating
result	object | object | object | object | object | object	No	Dati del risultato specifici del prompt (presenti quando lo stato è success)
error	string	No	Messaggio di errore quando lo stato è error

Errori:

• 401 Chiave API mancante, non valida, disabilitata o scaduta
• 429 Limite di utilizzo raggiunto

Verificare una generazione AI in corso (inviare esattamente lo stesso corpo della richiesta POST che l’ha avviata)

La verifica tramite POST è intenzionale: la generazione è identificata da prompt + promptType + summaryVariant, quindi la richiesta di verifica ripete il corpo anziché fare riferimento a un ID di esecuzione.

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

Autenticazione: chiave API con ambito limitato al tenant · ambito write

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	percorso	Sì	Formato: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	percorso	Sì	Valori consentiti: processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

Corpo della richiesta:

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

Campo	Tipo	Obbligatorio	Descrizione
prompt	string	Sì	Prompt in linguaggio naturale Lunghezza massima: 10000
summaryVariant	string	No

Risposta (200):

Risultato AI (stato: success | generating | error)

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

Campo	Tipo	Obbligatorio	Descrizione
status	success | error | generating	Sì	Valori consentiti: success, error, generating
result	object | object | object | object | object | object	No	Dati del risultato specifici del prompt (presenti quando lo stato è success)
error	string	No	Messaggio di errore quando lo stato è error

Errori:

• 401 Chiave API mancante, non valida, disabilitata o scaduta
• 429 Limite di utilizzo raggiunto