Referensi API: AI

Endpoint AI menjalankan prompt AI secara asinkron. Anda dapat memeriksa statusnya hingga hasil tersedia.

Mulai prompt AI langsung (asinkron; periksa dengan POST …/ai/{promptType}/status menggunakan isi permintaan yang sama)

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

Autentikasi: API key khusus tenant · cakupan write

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	path	Ya	Nilai yang diizinkan: processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

Isi permintaan:

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

Kolom	Tipe	Wajib	Deskripsi
prompt	string	Ya	Prompt dalam bahasa alami Panjang maksimum: 10000
summaryVariant	string	Tidak

Respons (200):

Hasil AI (status: success | generating | error)

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

Kolom	Tipe	Wajib	Deskripsi
status	success | error | generating	Ya	Nilai yang diizinkan: success, error, generating
result	object | object | object | object | object | object	Tidak	Data hasil khusus untuk prompt (tersedia jika status success)
error	string	Tidak	Pesan kesalahan jika status error

Kesalahan:

• 401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 429 Batas penggunaan tercapai

Periksa proses pembuatan AI yang sedang berjalan (kirim isi permintaan yang persis sama dengan POST awal)

Pemeriksaan menggunakan POST memang dirancang demikian. Proses pembuatan ditentukan oleh prompt + promptType + summaryVariant, sehingga pemeriksaan mengirim ulang isi permintaan, bukan menggunakan ID proses.

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

Autentikasi: API key khusus tenant · cakupan write

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	path	Ya	Nilai yang diizinkan: processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

Isi permintaan:

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

Kolom	Tipe	Wajib	Deskripsi
prompt	string	Ya	Prompt dalam bahasa alami Panjang maksimum: 10000
summaryVariant	string	Tidak

Respons (200):

Hasil AI (status: success | generating | error)

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

Kolom	Tipe	Wajib	Deskripsi
status	success | error | generating	Ya	Nilai yang diizinkan: success, error, generating
result	object | object | object | object | object | object	Tidak	Data hasil khusus untuk prompt (tersedia jika status success)
error	string	Tidak	Pesan kesalahan jika status error

Kesalahan:

• 401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 429 Batas penggunaan tercapai