API de prueba de Workflow (actualizar / publicar)
Permite a los desarrolladores, en herramientas de IA como CodeX, Claude, etc. (con el GPTBots Agent Skill instalado), importar la configuración del archivo .flow generada por las Skills a un Workflow de destino en la plataforma GPTBots y publicarlo.
⚠️ Solo se pueden invocar los Workflows en «modo de prueba». Las invocaciones en modo formal devuelven
403200. El modo de prueba se selecciona al crear el Workflow y no se puede modificar después de la creación.
API de actualización de Workflow (importar .flow para reemplazar la versión actual)
Importa el archivo .flow al Workflow de destino (modo de prueba) y guarda la configuración actual reemplazada como una nueva versión de borrador (que pasa a ser también la «versión actual»). Las reglas concretas son las siguientes:
- Bases de conocimiento (grupos de datos) / tablas de base de datos / documentos de conocimiento dentro de los nodos: según la dimensión WorkflowID, se conservan los que sigan perteneciendo al Workflow de destino; en caso contrario, se descartan;
- Workflows / herramientas (plugins) asociados: según la dimensión organización, se conservan los que sigan siendo válidos; en caso contrario, se descartan;
- Credenciales de terceros: al importar a un Workflow existente, se rellenan las credenciales ya configuradas en el destino según el «mismo ID de nodo/plugin», sin vaciar los nodos ya autenticados, para garantizar su disponibilidad;
Método de solicitud
POST
URL de solicitud
https://api-${endpoint}.gptbots.ai/v1/workflow/version/import
Solicitud
Ejemplo de solicitud
curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/workflow/version/import' \
-H 'Authorization: Bearer {WORKFLOW_API_KEY}' \
-H 'Content-Type: multipart/form-data' \
-F 'file=@my-workflow.flow' \
-F 'versionDesc=Imported by AI tool'
Cabeceras de la solicitud
| Campo | Tipo | Descripción |
|---|---|---|
| Authorization | Bearer {API Key} | Use Authorization: Bearer {API Key} para la autenticación de la invocación; obtenga la clave en el canal «Integración / API» del Workflow de destino y úsela como API Key. |
| Content-Type | multipart/form-data | Tipo de datos; su valor es multipart/form-data. |
Parámetros de la solicitud
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| file | file | Sí | Archivo .flow binario. |
| versionDesc | text | No | Descripción de la versión. |
El número de versión lo genera automáticamente el servidor (se toma el último segmento de la versión más reciente +1; si no hay versiones históricas, será
1.0.0).
Respuesta
Ejemplo de respuesta
{
"code": 0,
"msg": "OK",
"data": {
"botId": "xxx",
"botType": "Workflow",
"version": "1.0.3"
}
}
Respuesta de éxito
| Campo | Tipo | Descripción |
|---|---|---|
| botId | string | ID del Workflow de destino. |
| botType | string | Fijo en Workflow. |
| version | string | Número de versión guardado en esta operación (es decir, la versión actual). |
Respuesta de error
| Campo | Tipo | Descripción |
|---|---|---|
| code | int | Código de error. |
| msg | string | Detalles del error. |
API de publicación de Workflow (publicar como versión en producción según el número de versión)
Publica el número de versión especificado del Workflow de destino (modo de prueba) como versión de producción en línea (esa versión pasa a estar «en línea» y las demás versiones vuelven al estado de borrador).
Método de solicitud
POST
URL de solicitud
https://api-${endpoint}.gptbots.ai/v1/workflow/version/release
Solicitud
Ejemplo de solicitud
curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/workflow/version/release' \
-H 'Authorization: Bearer {WORKFLOW_API_KEY}' \
-H 'Content-Type: application/json' \
-d '{
"version": "1.0.3"
}'
Cabeceras de la solicitud
| Campo | Tipo | Descripción |
|---|---|---|
| Authorization | Bearer {API Key} | Use Authorization: Bearer {API Key} para la autenticación de la invocación; obtenga la clave en el canal «Integración / API» del Workflow de destino y úsela como API Key. |
| Content-Type | application/json | Tipo de datos; su valor es application/json. |
Parámetros de la solicitud
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| version | string | Sí | Número de versión que se publicará en línea (por ejemplo, 1.0.3); normalmente se toma del version devuelto por la interfaz de «actualización». |
Respuesta
Ejemplo de respuesta
{
"code": 0,
"msg": "OK"
}
Respuesta de éxito
Sin cuerpo de datos; si code es 0, la publicación se ha realizado correctamente.
Respuesta de error
| Campo | Tipo | Descripción |
|---|---|---|
| code | int | Código de error. |
| msg | string | Detalles del error. |
Códigos de error
Las interfaces de actualización y publicación comparten el mismo conjunto de códigos de error:
| Code | Message |
|---|---|
| 0 | Éxito |
| 40348 | El Workflow no existe |
| 403200 | No está en modo de prueba: solo los Workflows en modo de prueba pueden actualizarse o publicarse mediante esta API |
| 403201 | El tipo de archivo importado no coincide con el tipo del Workflow de destino |
| 403202 | Error al analizar el archivo .flow importado |
| 403203 | El número de versión especificado no existe |
| 403204 | El tipo de API Key no coincide con la interfaz: esta interfaz solo acepta Workflow Key |
| 40353 | La cantidad publicada supera el límite del plan |
