เอกสารอ้างอิง API: AI

Endpoint AI เรียกใช้ prompt AI แบบไม่พร้อมกัน และให้คุณตรวจสอบผลลัพธ์ได้.

เริ่ม prompt AI โดยตรง (async; ตรวจสอบสถานะด้วย POST …/ai/{promptType}/status โดยใช้ body เดิม)

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

การยืนยันตัวตน: API key ที่จำกัดขอบเขตตาม tenant · ขอบเขตสิทธิ์ write

พารามิเตอร์:

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	path	ใช่	ค่าที่ใช้ได้: processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

Request Body:

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

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
prompt	string	ใช่	prompt ภาษาธรรมชาติ ความยาวสูงสุด: 10000
summaryVariant	string	ไม่

Response (200):

ผลลัพธ์ AI (สถานะ: success | generating | error)

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

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
status	success | error | generating	ใช่	ค่าที่ใช้ได้: success, error, generating
result	object | object | object | object | object | object	ไม่	ข้อมูลผลลัพธ์เฉพาะของ prompt (มีเมื่อสถานะเป็น success)
error	string	ไม่	ข้อความแสดงข้อผิดพลาดเมื่อสถานะเป็น error

ข้อผิดพลาด:

• 401 ไม่มี API key, key ไม่ถูกต้อง ถูกปิดใช้ หรือหมดอายุ
• 429 ใช้งานถึงขีดจำกัดแล้ว

ตรวจสอบการสร้าง AI ที่กำลังทำงาน (ส่ง body เดียวกับ POST ที่เริ่มการทำงานทุกประการ)

การส่ง POST แล้วตรวจสอบผลเป็นรูปแบบที่ตั้งใจไว้ ระบบระบุการสร้างด้วย prompt + promptType + summaryVariant ดังนั้นคำขอตรวจสอบจึงส่ง body เดิมซ้ำ แทนการระบุ run id.

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

การยืนยันตัวตน: API key ที่จำกัดขอบเขตตาม tenant · ขอบเขตสิทธิ์ write

พารามิเตอร์:

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	path	ใช่	ค่าที่ใช้ได้: processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

Request Body:

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

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
prompt	string	ใช่	prompt ภาษาธรรมชาติ ความยาวสูงสุด: 10000
summaryVariant	string	ไม่

Response (200):

ผลลัพธ์ AI (สถานะ: success | generating | error)

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

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
status	success | error | generating	ใช่	ค่าที่ใช้ได้: success, error, generating
result	object | object | object | object | object | object	ไม่	ข้อมูลผลลัพธ์เฉพาะของ prompt (มีเมื่อสถานะเป็น success)
error	string	ไม่	ข้อความแสดงข้อผิดพลาดเมื่อสถานะเป็น error

ข้อผิดพลาด:

• 401 ไม่มี API key, key ไม่ถูกต้อง ถูกปิดใช้ หรือหมดอายุ
• 429 ใช้งานถึงขีดจำกัดแล้ว