Asistentes #
Administra asistentes y asígnalos a los canales del tenant.
Prepara tu terminal una vez
Variables para bash o zsh
export FLOWORDR_BASE_URL="https://app.flowordr.com"
export FLOWORDR_API_KEY="<tu-api-key>"
export FLOWORDR_TENANT_ID="<tu-tenant-id>"Ejecuta este bloque antes de los cURL. Sustituye los valores entre ángulos por tus credenciales; ningún ejemplo contiene claves reales.
GET /api/agents
| Nombre | Tipo | Obligatorio | Valores aceptados / rango | Default | Descripción |
|---|---|---|---|---|---|
| X-Api-Key (header) | string | Sí | Clave activa del tenant | — | Autenticación. |
| X-Tenant-Id (header) | UUID | Condicional | Tenant autorizado | Tenant de la clave | Necesario si la clave permite varios tenants. |
cURL
curl "$FLOWORDR_BASE_URL/api/agents" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"Respuesta: 200 lista de asistentes.
POST /api/agents
| Nombre | Tipo | Obligatorio | Valores aceptados / rango | Default | Descripción |
|---|---|---|---|---|---|
| X-Api-Key (header) | string | Sí | Clave activa del tenant | — | Autenticación. |
| X-Tenant-Id (header) | UUID | Condicional | Tenant autorizado | Tenant de la clave | Necesario si la clave permite varios tenants. |
| agentKey | body string | Sí | Clave única | — | Identificador del asistente. |
| name / tagline / description / icon | body string | No | Texto | — | Presentación. |
| systemPrompt | body string | No | Hasta 8000 caracteres | — | Instrucciones del asistente. |
| temperature / minScore | body number | No | 0–1 | Defaults del agente | Parámetros RAG. |
| maxChunks / maxHistoryTurns / maxTokens | body integer | No | Límites validados por el handler | Defaults del agente | Tamaño de contexto y respuesta. |
cURL
curl -X POST "$FLOWORDR_BASE_URL/api/agents" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID" -H "Content-Type: application/json" -d '{"agentKey":"soporte","name":"Soporte"}'Respuesta: 200 asistente creado o actualizado; 400 validación.
GET /api/agents/{agentKey}
| Nombre | Tipo | Obligatorio | Valores aceptados / rango | Default | Descripción |
|---|---|---|---|---|---|
| X-Api-Key (header) | string | Sí | Clave activa del tenant | — | Autenticación. |
| X-Tenant-Id (header) | UUID | Condicional | Tenant autorizado | Tenant de la clave | Necesario si la clave permite varios tenants. |
| agentKey | path string | Sí | Clave del asistente | — | Identifica el asistente del tenant. |
cURL
curl "$FLOWORDR_BASE_URL/api/agents/<agent-key>" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"Respuesta: 200 asistente; 404 si no existe.
DELETE /api/agents/{agentKey}
| Nombre | Tipo | Obligatorio | Valores aceptados / rango | Default | Descripción |
|---|---|---|---|---|---|
| X-Api-Key (header) | string | Sí | Clave activa del tenant | — | Autenticación. |
| X-Tenant-Id (header) | UUID | Condicional | Tenant autorizado | Tenant de la clave | Necesario si la clave permite varios tenants. |
| agentKey | path string | Sí | Clave del asistente | — | Identifica el asistente del tenant. |
cURL
curl -X DELETE "$FLOWORDR_BASE_URL/api/agents/<agent-key>" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"Respuesta: 204; 404 ausente; 409 si está asignado.
GET /api/agents/channels
| Nombre | Tipo | Obligatorio | Valores aceptados / rango | Default | Descripción |
|---|---|---|---|---|---|
| X-Api-Key (header) | string | Sí | Clave activa del tenant | — | Autenticación. |
| X-Tenant-Id (header) | UUID | Condicional | Tenant autorizado | Tenant de la clave | Necesario si la clave permite varios tenants. |
cURL
curl "$FLOWORDR_BASE_URL/api/agents/channels" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"Respuesta: 200 asignaciones por canal.
GET /api/agents/channels/{channel}
| Nombre | Tipo | Obligatorio | Valores aceptados / rango | Default | Descripción |
|---|---|---|---|---|---|
| X-Api-Key (header) | string | Sí | Clave activa del tenant | — | Autenticación. |
| X-Tenant-Id (header) | UUID | Condicional | Tenant autorizado | Tenant de la clave | Necesario si la clave permite varios tenants. |
| channel | path string | Sí | web, widget, telegram, whatsapp, api | — | Canal cuya asignación se consulta. |
cURL
curl "$FLOWORDR_BASE_URL/api/agents/channels/widget" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"Respuesta: 200 asignación; 404 canal ausente.
PUT /api/agents/channels/{channel}
| Nombre | Tipo | Obligatorio | Valores aceptados / rango | Default | Descripción |
|---|---|---|---|---|---|
| X-Api-Key (header) | string | Sí | Clave activa del tenant | — | Autenticación. |
| X-Tenant-Id (header) | UUID | Condicional | Tenant autorizado | Tenant de la clave | Necesario si la clave permite varios tenants. |
| channel | path string | Sí | web, widget, telegram, whatsapp, api | — | Canal cuya asignación se consulta. |
| agentKey | body string | Sí | Asistente existente | — | Asistente que atenderá el canal. |
| dataCaptureEnabled / dataCaptureFields / captureAfterTurns / rejectPolicy | body | No | boolean / string[] / integer / string | Configuración actual | Captura de datos por canal. |
cURL
curl -X PUT "$FLOWORDR_BASE_URL/api/agents/channels/widget" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID" -H "Content-Type: application/json" -d '{"agentKey":"soporte"}'Respuesta: 200 asignación; 400 o 404.
PUT /api/agents/channels/{channel}/agent
| Nombre | Tipo | Obligatorio | Valores aceptados / rango | Default | Descripción |
|---|---|---|---|---|---|
| X-Api-Key (header) | string | Sí | Clave activa del tenant | — | Autenticación. |
| X-Tenant-Id (header) | UUID | Condicional | Tenant autorizado | Tenant de la clave | Necesario si la clave permite varios tenants. |
| channel | path string | Sí | web, widget, telegram, whatsapp, api | — | Canal cuya asignación se consulta. |
| agentKey | body string | Sí | Asistente existente | — | Nueva asignación. |
cURL
curl -X PUT "$FLOWORDR_BASE_URL/api/agents/channels/widget/agent" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID" -H "Content-Type: application/json" -d '{"agentKey":"soporte"}'Respuesta: 200 asignación; 400 o 404.