Documentos #
Sube, consulta y administra los documentos de tu 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.
La API pública vigente usa
/api/v2/documents. Upload acepta PDF, TXT, Markdown y HTML (.html/.htm), y devuelve 202 porque la indexación continúa en segundo plano. El límite de carga depende de tu plan y almacenamiento; el endpoint comprueba el cupo antes de aceptar el archivo.POST /api/v2/documents/upload
| 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. |
| file | multipart file | Sí | .pdf, .txt, .md, .html, .htm; archivo no vacío | — | Archivo por indexar; el controlador no acepta URL sin archivo. |
| title | form string | No | Texto | Nombre del archivo | Título visible. |
| sourceType | form string | No | Texto libre | file | Etiqueta de origen del documento. |
cURL
curl -X POST "$FLOWORDR_BASE_URL/api/v2/documents/upload" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID" -F '[email protected]' -F 'title=Manual'Respuesta: 202 {documentId, status, version, ...}; 400 archivo vacío/formato inválido; 429 cupo agotado.
GET /api/v2/documents/list
| 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. |
| page | query integer | No | ≥1; valores menores se ajustan a 1 | 1 | Página. |
| pageSize | query integer | No | 1–200; fuera del rango se sustituye por 50 | 50 | Documentos por página. |
| status | query enum | No | Queued, Processing, Completed, Failed (sin distinguir mayúsculas); desconocido se ignora | Todos | Estado de indexación. |
| isActive | query boolean | No | true, false | Todos | Filtra documentos activos. |
cURL
curl "$FLOWORDR_BASE_URL/api/v2/documents/list?page=1&pageSize=50" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"Respuesta: 200 {documents, totalCount, page, pageSize}.
GET /api/v2/documents/overview
| 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/documents/overview" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"Respuesta: 200 estadísticas de documentos del tenant.
GET /api/v2/documents/{documentId}
| 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. |
| documentId | path integer (long) | Sí | ID devuelto por upload/list | — | Documento del tenant actual. |
cURL
curl "$FLOWORDR_BASE_URL/api/v2/documents/<document-id>" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"Respuesta: 200 detalle; 404 si no existe en el tenant.
GET /api/v2/documents/{documentId}/versions
| 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. |
| documentId | path integer (long) | Sí | ID devuelto por upload/list | — | Documento del tenant actual. |
cURL
curl "$FLOWORDR_BASE_URL/api/v2/documents/<document-id>/versions" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"Respuesta: 200 versiones; 404 si no existe.
GET /api/v2/documents/{documentId}/status
| 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. |
| documentId | path integer (long) | Sí | ID devuelto por upload/list | — | Documento del tenant actual. |
cURL
curl "$FLOWORDR_BASE_URL/api/v2/documents/<document-id>/status" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"Respuesta: 200 estado de la versión activa; 404 si no existe.
GET /api/v2/documents/{documentId}/progress
| 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. |
| documentId | path integer (long) | Sí | ID devuelto por upload/list | — | Documento del tenant actual. |
cURL
curl "$FLOWORDR_BASE_URL/api/v2/documents/<document-id>/progress" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"Respuesta: 200 progreso de ingestión; 404 si no existe.
DELETE /api/v2/documents/{documentId}
| 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. |
| documentId | path integer (long) | Sí | ID devuelto por upload/list | — | Documento del tenant actual. |
cURL
curl -X DELETE "$FLOWORDR_BASE_URL/api/v2/documents/<document-id>" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"Respuesta: 200 confirmación; 404 documento ausente; 409 conflicto durante procesamiento.
POST /api/v2/documents/reindex-all
| 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 -X POST "$FLOWORDR_BASE_URL/api/v2/documents/reindex-all" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"Respuesta: 202 {queued, skipped, failed}; encola las versiones activas.
GET /api/v2/documents/tenant-usage
| 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/documents/tenant-usage" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"Respuesta: 200 cupos de documentos y almacenamiento; 404 tenant ausente.