Endpoint /api/knowledge-processing-status

URL

Descripción

Este endpoint permite consultar el estado de un trabajo de procesamiento de la base de conocimiento. Puede consultar el último trabajo iniciado para la empresa o un trabajo específico proporcionando su ID.

Los trabajos de procesamiento son creados por el endpoint /api/process-knowledgey pueden tener los siguientes estados:

• pending: El trabajo ha sido creado pero aún no ha comenzado el procesamiento.
• processing: El procesamiento está en curso.
• completed: El procesamiento ha finalizado correctamente.
• error: Ha ocurrido un error durante el procesamiento.

Autenticación

Parámetros

Respuesta

La respuesta incluye información sobre el estado del trabajo de procesamiento:

{
  "company": {
    "name": "Nombre de la empresa"
  },
  "job": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "completed",
    "started_at": "2023-08-09T12:34:56.789Z",
    "finished_at": "2023-08-09T12:45:30.123Z",
    "created_at": "2023-08-09T12:34:56.789Z",
    "updated_at": "2023-08-09T12:45:30.123Z"
  },
  "success": true
}

Si el trabajo ha fallado, la respuesta incluirá un mensaje de error:

{
  "company": {
    "name": "Nombre de la empresa"
  },
  "job": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "error",
    "started_at": "2023-08-09T12:34:56.789Z",
    "finished_at": "2023-08-09T12:40:20.456Z",
    "created_at": "2023-08-09T12:34:56.789Z",
    "updated_at": "2023-08-09T12:40:20.456Z",
    "error_message": "Error al procesar base de conocimiento: timeout of 30000ms exceeded"
  },
  "success": true
}

Ejemplos

# Consultar el último trabajo de procesamiento
curl -X GET https://api.integrationit.co/api/knowledge-processing-status \
  -H "x-api-key: SU_API_KEY_AQUI"

# Consultar un trabajo específico
curl -X GET https://api.integrationit.co/api/knowledge-processing-status?jobId=123e4567-e89b-12d3-a456-426614174000 \
  -H "x-api-key: SU_API_KEY_AQUI"

// Usando fetch - Consultar último trabajo
const response = await fetch('https://api.integrationit.co/api/knowledge-processing-status', {
  method: 'GET',
  headers: {
    'x-api-key': 'SU_API_KEY_AQUI'
  }
});

const data = await response.json();
console.log(data);

// Consultar un trabajo específico
const jobId = '123e4567-e89b-12d3-a456-426614174000';
const responseJob = await fetch(`https://api.integrationit.co/api/knowledge-processing-status?jobId=${jobId}`, {
  method: 'GET',
  headers: {
    'x-api-key': 'SU_API_KEY_AQUI'
  }
});

const jobData = await responseJob.json();
console.log(jobData);

import requests

# Consultar último trabajo
url = "https://api.integrationit.co/api/knowledge-processing-status"
headers = {
    "x-api-key": "SU_API_KEY_AQUI"
}

response = requests.get(url, headers=headers)
print(response.json())

# Consultar un trabajo específico
job_id = "123e4567-e89b-12d3-a456-426614174000"
url_job = f"https://api.integrationit.co/api/knowledge-processing-status?jobId={job_id}"
response_job = requests.get(url_job, headers=headers)
print(response_job.json())