Referência da API: IA

Os endpoints de IA executam prompts de IA de forma assíncrona e permitem consultar o resultado.

Iniciar um prompt direto de IA (assíncrono; consulte POST …/ai/{promptType}/status com o mesmo corpo)

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

Autenticação: Chave de API vinculada ao tenant · escopo write

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	caminho	Sim	Valores permitidos: processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

Corpo da solicitação:

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

Campo	Tipo	Obrigatório	Descrição
prompt	string	Sim	Prompt em linguagem natural Comprimento máximo: 10000
summaryVariant	string	Não

Resposta (200):

Resultado da IA (status: success | generating | error)

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

Campo	Tipo	Obrigatório	Descrição
status	success | error | generating	Sim	Valores permitidos: success, error, generating
result	object | object | object | object | object | object	Não	Dados de resultado específicos do prompt (presentes quando o status é success)
error	string	Não	Mensagem de erro quando o status é error

Erros:

• 401 Chave de API ausente, inválida, desativada ou expirada
• 429 Limite de uso atingido

Consultar uma geração de IA em andamento (envie exatamente o mesmo corpo usado no POST que a iniciou)

O uso de POST para consulta é intencional: a geração é identificada pela combinação de prompt + promptType + summaryVariant, portanto a consulta repete o corpo em vez de usar um ID de execução.

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

Autenticação: Chave de API vinculada ao tenant · escopo write

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	caminho	Sim	Valores permitidos: processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

Corpo da solicitação:

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

Campo	Tipo	Obrigatório	Descrição
prompt	string	Sim	Prompt em linguagem natural Comprimento máximo: 10000
summaryVariant	string	Não

Resposta (200):

Resultado da IA (status: success | generating | error)

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

Campo	Tipo	Obrigatório	Descrição
status	success | error | generating	Sim	Valores permitidos: success, error, generating
result	object | object | object | object | object | object	Não	Dados de resultado específicos do prompt (presentes quando o status é success)
error	string	Não	Mensagem de erro quando o status é error

Erros:

• 401 Chave de API ausente, inválida, desativada ou expirada
• 429 Limite de uso atingido