Saltar al contenido principal

​
Endpoint

POST /v1/folders/{folderId}/items/upload

​
Métodos de carga

Suba un archivo. Crea un item de tipo file.
curl -X POST "http://client-omni-api.argosidentity.com/v1/folders/{folderId}/items/upload" \
  -H "x-api-key: your-api-key-here" \
  -F "file=@/path/to/business_registration.pdf" \
  -F "metadata={\"documentType\":\"business_registration\"}"

​
Parámetros de solicitud (Form Data)

​
file
file
Archivo a subir. Se debe proporcionar file o content.
​
type
string
Tipo de item: file, text o json. Requerido cuando solo se proporciona content. Se ignora cuando se proporciona file.
​
name
string
Nombre visible (por defecto usa el nombre del archivo o se genera automáticamente)
​
content
string
Contenido de texto o JSON. Se debe proporcionar file o content.
​
metadata
string (JSON)
Metadata personalizado como cadena JSON

​
Respuesta (201 Created)

{
  "id": "item_abc123",
  "folderId": "fld_default001",
  "type": "file",
  "name": "business_registration.pdf",
  "content": null,
  "contentType": "application/pdf",
  "sizeBytes": 245678,
  "url": "https://omni-kb-documents.s3.us-east-1.amazonaws.com/.../extracted.txt",
  "s3OriginalUrl": "https://omni-kb-documents.s3.us-east-1.amazonaws.com/.../original.pdf",
  "detected": {
    "contentType": "application/pdf",
    "extension": "pdf",
    "fileCategory": "document"
  },
  "metadata": {
    "documentType": "business_registration"
  },
  "status": "PENDING",
  "processedAt": null,
  "rag": null,
  "createdAt": "2026-03-15T10:10:00Z"
}
​
s3OriginalUrl
string | null
URL del archivo original. Solo se incluye en las respuestas de carga/actualización, no en consultas de lista o detalle.
​
detected
object | null
Información del archivo detectada automáticamente: contentType, extension, fileCategory
​
rag
string | null
Texto extraído por OCR. null en la creación; se completa después del procesamiento.

​
Restricciones de archivo

RestricciónValor
Tamaño máximo de archivo10 MB
Máximo de items por folder5

​
Formatos de archivo compatibles

Tipo de archivoExtensionesProcesamiento
Imágenesjpg, jpeg, png, bmp, tiff, webpOCR (extracción automática de texto)
PDFpdfOCR (extracción automática de texto)
Documentos de textotxt, md, html, htm, csvLectura directa
Documentos de oficinadoc, docx, xls, xlsxExtracción automática de texto

​
Procesamiento

Después de la carga, los items se procesan automáticamente:
  • Imágenes y PDFs: Extracción OCR (coreano e inglés)
  • Documentos de oficina: Extracción de texto y datos
  • Flujo de estado: PENDING → ACTIVE (o FAILED)
Haga polling de GET /v1/profiles/{profileId}/items/status cada 1 segundo (máx. 60 segundos) para verificar cuándo todos los items están listos para el análisis.

​
Códigos de error

StatusCodeDescripción
400FILE_OR_CONTENT_REQUIREDSe debe proporcionar file o content
400TYPE_REQUIREDtype es requerido cuando solo se proporciona content
404FOLDER_NOT_FOUNDFolder no encontrado
409ITEM_LIMIT_EXCEEDEDSe superó el máximo de 5 items por folder
413FILE_TOO_LARGEEl archivo supera el límite de 10 MB
415UNSUPPORTED_FILE_TYPEFormato de archivo no compatible