Opciones RAG y uso #
Los controles del playground se envían en el objeto options de /api/rag/answer. Los defaults efectivos dependen del canal y se consultan con /api/rag/defaults.
bash
curl "$FLOWORDR_BASE_URL/api/rag/defaults?channel=web" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"El DTO acepta temperature 0–1, minScore 0–1, maxChunks -1–1000, maxHistoryTurns -1–50 y maxTokens 50–2048. Un 0 explícito en maxHistoryTurns desactiva el historial. Consulta la tabla completa en Chat.
API de uso
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/v2/usage/stats
| Nombre | Tipo | Obligatorio | Valores aceptados / rango | Default | Descripción |
|---|---|---|---|---|---|
| X-Api-Key (header) | string | Sí | Clave activa de tu tenant | — | Autentica la integración. |
| X-Tenant-Id (header) | UUID | Condicional | Tenant autorizado para la clave | Tenant de la clave | Envíalo si tu clave permite varios tenants; los ejemplos lo incluyen siempre. |
| from / to | query fecha | No | Fecha ISO-8601 | Últimos 30 días / ahora | Ventana estadística. |
cURL
curl "$FLOWORDR_BASE_URL/api/v2/usage/stats" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"Respuesta: 200 estadísticas; 403 sin tenant.
GET /api/v2/usage/history
| Nombre | Tipo | Obligatorio | Valores aceptados / rango | Default | Descripción |
|---|---|---|---|---|---|
| X-Api-Key (header) | string | Sí | Clave activa de tu tenant | — | Autentica la integración. |
| X-Tenant-Id (header) | UUID | Condicional | Tenant autorizado para la clave | Tenant de la clave | Envíalo si tu clave permite varios tenants; los ejemplos lo incluyen siempre. |
| limit | query integer | No | Se ajusta a 1–200 | 50 | Registros por página. |
| offset | query integer | No | Se ajusta a ≥0 | 0 | Registros omitidos. |
cURL
curl "$FLOWORDR_BASE_URL/api/v2/usage/history?limit=50&offset=0" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"Respuesta: 200 historial; 403 sin tenant.
GET /api/v2/usage/api-key-info
| Nombre | Tipo | Obligatorio | Valores aceptados / rango | Default | Descripción |
|---|---|---|---|---|---|
| X-Api-Key (header) | string | Sí | Clave activa de tu tenant | — | Autentica la integración. |
| X-Tenant-Id (header) | UUID | Condicional | Tenant autorizado para la clave | Tenant de la clave | Envíalo si tu clave permite varios tenants; los ejemplos lo incluyen siempre. |
cURL
curl "$FLOWORDR_BASE_URL/api/v2/usage/api-key-info" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"Respuesta: 200 información de la clave actual; 401 si el principal no tiene una API key.
GET /api/v2/usage/summary
| Nombre | Tipo | Obligatorio | Valores aceptados / rango | Default | Descripción |
|---|---|---|---|---|---|
| X-Api-Key (header) | string | Sí | Clave activa de tu tenant | — | Autentica la integración. |
| X-Tenant-Id (header) | UUID | Condicional | Tenant autorizado para la clave | Tenant de la clave | Envíalo si tu clave permite varios tenants; los ejemplos lo incluyen siempre. |
cURL
curl "$FLOWORDR_BASE_URL/api/v2/usage/summary" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"Respuesta: 200 resumen de uso.
GET /api/v2/usage/by-channel
| Nombre | Tipo | Obligatorio | Valores aceptados / rango | Default | Descripción |
|---|---|---|---|---|---|
| X-Api-Key (header) | string | Sí | Clave activa de tu tenant | — | Autentica la integración. |
| X-Tenant-Id (header) | UUID | Condicional | Tenant autorizado para la clave | Tenant de la clave | Envíalo si tu clave permite varios tenants; los ejemplos lo incluyen siempre. |
| from / to | query fecha | No | Fecha ISO-8601 | Primer día del mes / ahora | Periodo por canal. |
cURL
curl "$FLOWORDR_BASE_URL/api/v2/usage/by-channel" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"Respuesta: 200 distribución por canal.
GET /api/v2/usage/mcp-audit
| Nombre | Tipo | Obligatorio | Valores aceptados / rango | Default | Descripción |
|---|---|---|---|---|---|
| X-Api-Key (header) | string | Sí | Clave activa de tu tenant | — | Autentica la integración. |
| X-Tenant-Id (header) | UUID | Condicional | Tenant autorizado para la clave | Tenant de la clave | Envíalo si tu clave permite varios tenants; los ejemplos lo incluyen siempre. |
| limit | query integer | No | Se ajusta a 1–200 | 50 | Registros por página. |
| offset | query integer | No | Se ajusta a ≥0 | 0 | Registros omitidos. |
cURL
curl "$FLOWORDR_BASE_URL/api/v2/usage/mcp-audit?limit=50&offset=0" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"Respuesta: 200 auditoría MCP del tenant; 403 sin contexto válido.