Obtener la lista de ejecuciones del Workflow
Obtener la lista de ejecuciones del Workflow
Se utiliza para obtener la lista de registros de ejecución del Workflow. El Workflow se determina automáticamente mediante la autenticación con la API Key, por lo que no es necesario pasar un workflow_id adicional.
| Nombre del ID | Descripción |
|---|---|
| log_id | ID del registro de ejecución del Workflow. |
| workflow_run_id | ID de una ejecución individual del Workflow, utilizado para identificar una ejecución del Workflow. |
| input | Contenido de entrada de esta ejecución del Workflow. |
| output | Contenido de salida de esta ejecución del Workflow. |
Método
GET
URL
https://api-${endpoint}.gptbots.ai/v1/workflow/run/logs
Autenticación
Se utiliza la API Key del Workflow para la validación de la llamada.
Solicitud
Ejemplo
curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/workflow/run/logs?conversation_type=API&user_id=your_user_id&start_time=1785125443602&end_time=1785125447498&page=1&page_size=10' \
-H 'Authorization: Bearer ${API Key}'
curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/workflow/run/logs?conversation_type=API&user_id=your_user_id&start_time=1785125443602&end_time=1785125447498&page=1&page_size=10' \
-H 'Authorization: Bearer ${API Key}'
Este bloque de código en una ventana flotante
Encabezados
| Campo | Tipo | Descripción |
|---|---|---|
| Authorization | Bearer ${API Key} | Validación de llamadas mediante Authorization: Bearer ${API Key}; utilizar la API Key del Workflow. |
Parámetros de la solicitud
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| conversation_type | string | Y | Tipo de origen de la ejecución. Se admiten: ALL, API, AGENT, SHARE, C_WORKFLOW. No se admite la ejecución de prueba DEBUG. |
| user_id | string | N | Identificador del usuario, utilizado para filtrar los registros de ejecución del Workflow de un usuario específico. |
| start_time | number | Y | Hora de inicio de la consulta, en marca de tiempo en milisegundos. |
| end_time | number | Y | Hora de fin de la consulta, en marca de tiempo en milisegundos. |
| page | number | Y | Número de página, empezando desde 1. |
| page_size | number | Y | Cantidad por página, con un rango de valores de 10-100. |
Respuesta
Ejemplo
{
"list": [
{
"log_id": "6a66da44435da934b2e67e49",
"workflow_run_id": "6a66da44435da934b2e67e49",
"input": "{}",
"output": "{\"output\":\"{\\\"text\\\":\\\"Workflow output text\\\",\\\"image\\\":[],\\\"audio\\\":[]}\"}"
}
],
"total": 1
}
{
"list": [
{
"log_id": "6a66da44435da934b2e67e49",
"workflow_run_id": "6a66da44435da934b2e67e49",
"input": "{}",
"output": "{\"output\":\"{\\\"text\\\":\\\"Workflow output text\\\",\\\"image\\\":[],\\\"audio\\\":[]}\"}"
}
],
"total": 1
}
Este bloque de código en una ventana flotante
Respuesta correcta
| Campo | Tipo | Descripción |
|---|---|---|
| list | array | Lista de registros de ejecución del Workflow. |
| total | number | Número total de resultados que cumplen las condiciones de la consulta. |
| list[].log_id | string | ID del registro de ejecución del Workflow. |
| list[].workflow_run_id | string | ID de una ejecución individual del Workflow. |
| list[].input | string | Contenido de entrada, cadena JSON. |
| list[].output | string | Contenido de salida, cadena JSON. |
Respuesta de error
| Campo | Tipo | Descripción |
|---|---|---|
| code | int | Código de error. |
| message | string | Detalles del error. |
Códigos de error
| Code | Message |
|---|---|
| 40000 | Parámetro no válido |
| 40001 | Demasiadas solicitudes |
| 40101 | La cabecera Authorization está vacía |
| 40127 | Error de autenticación del desarrollador |
