En esta página
> recursos > documentacion > api > Referencia de la API: IA

Referencia de la API: IA

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

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

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

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

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId cadena 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 cadena Sí Solicitud en lenguaje natural
Longitud máxima: 10000
summaryVariant cadena No

Respuesta (200):

Resultado de la 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 Datos del resultado específicos de la solicitud (presentes cuando el estado es success)
error cadena 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 alcanzó el límite de uso

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

La consulta se realiza mediante POST de forma intencionada: la generación se identifica por prompt + promptType + summaryVariant, por lo que la consulta repite el cuerpo en lugar de usar un ID de ejecución.

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

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

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId cadena 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 cadena Sí Solicitud en lenguaje natural
Longitud máxima: 10000
summaryVariant cadena No

Respuesta (200):

Resultado de la 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 Datos del resultado específicos de la solicitud (presentes cuando el estado es success)
error cadena 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 alcanzó el límite de uso

Documentación relacionada

Diseñe mejores procesos. Conecte su arquitectura. Mantenga el control.

Acceda de inmediato, sin tarjeta de crédito ni esperas. Transforme la forma de trabajar de su organización en diseños de procesos claros y conectados.

Defina la arquitectura de procesos, los responsables y los controles, y alinee las funciones y responsabilidades en todos los niveles.

Comience su prueba gratuita y establezca una base fiable para gobernar, gestionar y mejorar continuamente sus procesos.

Comience hoy su prueba gratuita