Flows API
Crear, publicar y operar flujos de automatizacion de tu organizacion
La Flows API de Mirlo te permite administrar por codigo los flujos visuales (automatizaciones) de tu organizacion: crearlos, validarlos, publicarlos, versionarlos, probarlos y consultar sus ejecuciones.
URL Base
https://api.mirlo.com/v1/flowsAmbiente de desarrollo: https://api-dev.mirlo.com/v1/flows.
Autenticacion
Envia tu API Key en el header X-API-Key. Tambien se acepta un JWT con Authorization: Bearer <jwt>.
curl "https://api.mirlo.com/v1/flows" \
-H "X-API-Key: sk_live_..."La organizacion se toma de la API Key: las rutas no llevan organization_id. Si tu usuario pertenece a varias organizaciones, elige una con el header x-organization-id:
curl "https://api.mirlo.com/v1/flows" \
-H "Authorization: Bearer eyJhbGci..." \
-H "x-organization-id: <organization_id>"Podes obtener tu API Key en Mi Organizacion → API Keys en el dashboard de Mirlo.
Permisos
Cada endpoint exige un permiso de la API Key o del usuario: flows:view (lecturas), flows:create, flows:update, flows:delete, flows:publish y flows:pause. Sin el permiso la respuesta es 403.
Endpoints
| Metodo | Ruta | Descripcion |
|---|---|---|
GET | /flows | Listar flujos |
POST | /flows | Crear un flujo |
GET | /flows/:id | Obtener un flujo |
PATCH | /flows/:id | Actualizar un flujo |
DELETE | /flows/:id | Eliminar un flujo |
POST | /flows/:id/publish | Publicar |
POST | /flows/:id/pause | Pausar |
POST | /flows/:id/archive | Archivar |
POST | /flows/:id/duplicate | Duplicar |
POST | /flows/:id/test | Probar con datos de ejemplo |
GET | /flows/:id/revisions | Listar versiones |
GET | /flows/:id/revisions/:version | Obtener una version |
POST | /flows/:id/rollback | Volver a una version |
GET | /flows/:id/unpublished-changes | Cambios sin publicar |
POST | /flows/:id/validate | Validar un flujo guardado |
POST | /flows/validate-canvas | Validar un canvas sin guardarlo |
GET | /flows/node-catalog | Catalogo de nodos |
GET | /flows/:id/export | Exportar |
POST | /flows/import | Importar |
GET | /flows/:id/executions | Historial de ejecuciones |
GET | /flows/:id/executions/:executionId | Detalle de una ejecucion |
GET | /flows/by-agent/:agentId | Flujos que usan un agente |
GET | /flows/phone-numbers/mappings | Numeros asociados a flujos |
GET POST PATCH DELETE | /flows/folders | Carpetas |
Errores
| Codigo | Cuando |
|---|---|
400 | Body invalido, canvas con errores estructurales al publicar, executionId mal formado |
403 | La API Key o el usuario no tiene el permiso del endpoint |
404 | El flujo, la carpeta, la version o la ejecucion no existe en tu organizacion |
409 | Carpeta con nombre repetido o con subcarpetas; canal ya tomado por otro flujo activo al publicar |