Folder Extract API
Inventory approved files with explicit scope, identities, and parser outcomes.
A focused use case
Scan a project folder for selected document types and produce a manifest of accepted files, extraction results, and items requiring review.
A practical workflow
Configure a root directory, define recursion and symbolic-link rules, filter permitted types, and stage each accepted file for a bounded parser. Publish a complete manifest so skipped files do not disappear silently.
An example record contract
These fields illustrate the decisions to make before implementation. Adapt the names and required values to the receiving system; the table is not a promise of a live endpoint or a provider-specific response.
| Example field | Meaning in this contract |
|---|---|
| relative_path | Location within the approved root |
| content_hash | Content identity where appropriate |
| file_type | Accepted parser family |
| parse_outcome | Success, skipped, or failure |
Limits worth keeping visible
Do not follow paths outside the approved scope or execute file content. Treat archives, links, changing files, and permission failures as explicit cases to test.
Before increasing the workload
Run a small, authorized test set through the whole path, including the receiving application. Keep accepted, rejected, and incomplete outcomes distinguishable. A result should retain the context needed to explain its meaning after it leaves the extractor.
Continue with SQL Extract API: Controlled Queries, Dependable Exports for the full implementation discussion, and use the sample contract documentation to review the shape of a handoff.
Consult the source documentation for implementation details and current access conditions. The workflow above is an editorial planning pattern.
Connected topics.
CSV Extract API
Deliver flat rows with stable columns, explicit quoting, and predictable import behavior.
Explore the workflowEmail Extract API
Parse permissioned messages into purpose-limited records, not an indiscriminate contact list.
Explore the workflowSpreadsheet Extract API
Turn a selected worksheet range into records without losing cell meaning.
Explore the workflow