File analysis
What AI read out of a file — the fields it filled, and the markdown rendition it read them from.
Merge analysis results
Merges values into what AI read out of the file, field by field — fields absent from the body keep the values the analysis gave them.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Merge analysis results › Responses
Success
Preview an analysis
A dry run: shows what a profile would produce, and writes nothing to the file.
Requires the module-custom-analysis license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Preview an analysis › Responses
Success
Reanalyze a file
Runs a model — it consumes credits and counts against the expensive rate-limit tier.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Reanalyze a file › Responses
Success