Referencia de la API: IA

Los endpoints de IA ejecutan solicitudes de IA de forma asíncrona y permiten consultar el resultado.

Iniciar una solicitud directa de IA (asíncrona; consulte mediante POST …/ai/{promptType}/status con el mismo cuerpo)

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

Autenticación: Clave de API asociada al inquilino · ámbito write

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	ruta	Sí	Valores permitidos: processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

Cuerpo de la solicitud:

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

Campo	Tipo	Obligatorio	Descripción
prompt	string	Sí	Solicitud en lenguaje natural Longitud máxima: 10.000
summaryVariant	string	No

Respuesta (200):

Resultado de IA (estado: success | generating | error)

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

Campo	Tipo	Obligatorio	Descripción
status	success | error | generating	Sí	Valores permitidos: success, error, generating
result	object | object | object | object | object | object	No	Carga de resultado específica de la solicitud (presente cuando el estado es success)
error	string	No	Mensaje de error cuando el estado es error

Errores:

• 401 Falta la clave de API, no es válida, está desactivada o ha caducado
• 429 Se ha alcanzado el límite de uso

Consultar una generación de IA en curso (envíe exactamente el mismo cuerpo que en el POST que la inició)

El uso de POST para consultar el estado es intencionado: la generación se identifica mediante prompt + promptType + summaryVariant, por lo que la consulta repite el cuerpo en lugar de dirigirse a un identificador de ejecución.

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

Autenticación: Clave de API asociada al inquilino · ámbito write

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	ruta	Sí	Valores permitidos: processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

Cuerpo de la solicitud:

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

Campo	Tipo	Obligatorio	Descripción
prompt	string	Sí	Solicitud en lenguaje natural Longitud máxima: 10.000
summaryVariant	string	No

Respuesta (200):

Resultado de IA (estado: success | generating | error)

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

Campo	Tipo	Obligatorio	Descripción
status	success | error | generating	Sí	Valores permitidos: success, error, generating
result	object | object | object | object | object | object	No	Carga de resultado específica de la solicitud (presente cuando el estado es success)
error	string	No	Mensaje de error cuando el estado es error

Errores:

• 401 Falta la clave de API, no es válida, está desactivada o ha caducado
• 429 Se ha alcanzado el límite de uso