Alo Files

Files

Alo Files lets you upload, organize, search, and parse files in an Alomana workspace.

An uploaded file becomes searchable once processing brings its status to indexed; you can then search it or download it. Start by uploading a file, then search it; Reference lists the headers, formats, and statuses these pages share.

Reference

Headers

X-API-Key: sk-...
X-Space-Slug: your-workspace
EndpointsX-API-Key (auth)Workspace (X-Space-Slug)
File, folder, contents, batch, search, SharePoint syncRequiredRequired
Parse-onlyRequiredOnly for a workspace key, which must send its own workspace (Parse a file without indexing it)

Supported files

TypeFormats
DocumentsPDF, DOCX, PPTX, DOC, PPT
SpreadsheetsXLSX, XLS, XLSM, XLSB, ODS, CSV
Text and dataJSON, HTML, Markdown, TXT
ImagesPNG, JPEG
EmailEML, MSG

File statuses

StatusMeaning
uploadedUploaded, waiting to be processed.
parsingReading the file contents.
parsedText or table extraction done; processing may still continue.
indexingPreparing the file for search.
indexedReady to search.
errorProcessing failed; see error_message on the file.
  • PDF, Office, and legacy Office files parse asynchronously and are searchable only once indexed.
  • Structured files are stored as profile and table chunks; images are embedded as image records.
  • A failed refresh keeps the previous indexed generation available until a replacement is ready.

Errors

Alo Files errors are JSON {"code", "message", "details"}; details is null or an object such as {"reason": "duplicate_in_folder", …}.

codeStatusMeaning
validation_error400Invalid input, such as a malformed parent_id
unsupported_mime400File type not supported; details.allowed lists the accepted MIME types
forbidden403The credential cannot do this, such as an API key on copy-to-space
not_found404The file, folder, or sync source does not exist in this workspace
conflict409The request conflicts with the current state; details.reason, when set, names the case
payload_too_large413File too large for POST /parse/sync
parse_failed502The parser failed
resource_busy503Temporarily busy; details.retryable is true, so retry

This differs from Central Hub's errors, which carry detail (Errors); Alo Files keeps that {"detail": …} shape only for authentication failures, a missing X-Space-Slug, a key used outside its workspace, and 422 request validation.

On this page