API referansı: yapay zekâ

Yapay zekâ uç noktaları, yapay zekâ istemlerini eşzamansız çalıştırır ve sonucu sorgulamanıza olanak tanır.

Doğrudan yapay zekâ istemi başlatma (eşzamansız; aynı gövdeyle POST …/ai/{promptType}/status adresini sorgulayın)

Uç nokta: POST /v1/tenant/{tenantId}/ai/{promptType}

Kimlik doğrulama: Kiracı kapsamındaki API anahtarı · write kapsamı

Parametreler:

Ad	Tür	Konum	Gerekli	Açıklama
tenantId	string	path	Evet	Biçim: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	path	Evet	İzin verilen değerler: processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

İstek gövdesi:

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

Alan	Tür	Gerekli	Açıklama
prompt	string	Evet	Doğal dilde istem Maksimum uzunluk: 10000
summaryVariant	string	Hayır

Yanıt (200):

Yapay zekâ sonucu (durum: success | generating | error)

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

Alan	Tür	Gerekli	Açıklama
status	success | error | generating	Evet	İzin verilen değerler: success, error, generating
result	object | object | object | object | object | object	Hayır	İsteme özel sonuç verisi (status success olduğunda bulunur)
error	string	Hayır	status error olduğunda hata mesajı

Hatalar:

• 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
• 429 Kullanım sınırına ulaşıldı

Devam eden yapay zekâ oluşturma işlemini sorgulama (başlatan POST isteğiyle aynı gövdeyi gönderin)

POST isteğiyle sorgulama yapılması bilinçli bir tercihtir: oluşturma işlemi prompt + promptType + summaryVariant değerleriyle tanımlanır. Bu nedenle sorguda bir işlem kimliği kullanmak yerine aynı gövde yeniden gönderilir.

Uç nokta: POST /v1/tenant/{tenantId}/ai/{promptType}/status

Kimlik doğrulama: Kiracı kapsamındaki API anahtarı · write kapsamı

Parametreler:

Ad	Tür	Konum	Gerekli	Açıklama
tenantId	string	path	Evet	Biçim: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	path	Evet	İzin verilen değerler: processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

İstek gövdesi:

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

Alan	Tür	Gerekli	Açıklama
prompt	string	Evet	Doğal dilde istem Maksimum uzunluk: 10000
summaryVariant	string	Hayır

Yanıt (200):

Yapay zekâ sonucu (durum: success | generating | error)

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

Alan	Tür	Gerekli	Açıklama
status	success | error | generating	Evet	İzin verilen değerler: success, error, generating
result	object | object | object | object | object | object	Hayır	İsteme özel sonuç verisi (status success olduğunda bulunur)
error	string	Hayır	status error olduğunda hata mesajı

Hatalar:

• 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
• 429 Kullanım sınırına ulaşıldı