Tài liệu API: AI

Các endpoint AI chạy prompt không đồng bộ và cho phép bạn kiểm tra kết quả.

Bắt đầu prompt AI trực tiếp (không đồng bộ; kiểm tra bằng POST …/ai/{promptType}/status với cùng body)

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

Xác thực: API key theo tenant · phạm vi quyền write

Tham số:

Tên	Kiểu	Vị trí	Bắt buộc	Mô tả
tenantId	string	path	Có	Định dạng: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	path	Có	Giá trị được phép: processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

Request body:

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

Trường	Kiểu	Bắt buộc	Mô tả
prompt	string	Có	Prompt bằng ngôn ngữ tự nhiên Độ dài tối đa: 10000
summaryVariant	string	Không

Response (200):

Kết quả AI (trạng thái: success | generating | error)

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

Trường	Kiểu	Bắt buộc	Mô tả
status	success | error | generating	Có	Giá trị được phép: success, error, generating
result	object | object | object | object | object | object	Không	Dữ liệu kết quả riêng cho prompt (có khi trạng thái là success)
error	string	Không	Thông báo lỗi khi trạng thái là error

Lỗi:

• 401 Thiếu, không hợp lệ, bị vô hiệu hóa hoặc hết hạn API key
• 429 Đã đạt giới hạn sử dụng

Kiểm tra tiến trình tạo AI đang chạy (gửi đúng body đã dùng trong POST khởi chạy)

Dùng POST để kiểm tra là có chủ đích: tiến trình tạo được xác định bằng prompt + promptType + summaryVariant, nên yêu cầu kiểm tra gửi lại body thay vì dùng mã lượt chạy.

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

Xác thực: API key theo tenant · phạm vi quyền write

Tham số:

Tên	Kiểu	Vị trí	Bắt buộc	Mô tả
tenantId	string	path	Có	Định dạng: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	path	Có	Giá trị được phép: processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

Request body:

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

Trường	Kiểu	Bắt buộc	Mô tả
prompt	string	Có	Prompt bằng ngôn ngữ tự nhiên Độ dài tối đa: 10000
summaryVariant	string	Không

Response (200):

Kết quả AI (trạng thái: success | generating | error)

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

Trường	Kiểu	Bắt buộc	Mô tả
status	success | error | generating	Có	Giá trị được phép: success, error, generating
result	object | object | object | object | object | object	Không	Dữ liệu kết quả riêng cho prompt (có khi trạng thái là success)
error	string	Không	Thông báo lỗi khi trạng thái là error

Lỗi:

• 401 Thiếu, không hợp lệ, bị vô hiệu hóa hoặc hết hạn API key
• 429 Đã đạt giới hạn sử dụng