Namirial · Schema
FilePrepareRequest
The request model for parsing documents.
CompanyDigital TrustE-SignatureIdentity VerificationDigital IdentityTrust ServicesCompliance
Properties
| Name | Type | Description |
|---|---|---|
| FileIds | array | The identifiers of the uploaded files. |
| ClearAdvancedDocumentTags | boolean | If true, the parsed advanced document tags are deleted from the document. |
| SigStringConfigurations | array | The configurations for the parsing of SigString. The default [`sig`] is always added. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/namirial/json-schema/namirial-file-prepare-request-schema.json",
"title": "FilePrepareRequest",
"description": "The request model for parsing documents.",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/namirial-file-api-openapi.yml#/components/schemas/FilePrepareRequest",
"required": [
"FileIds"
],
"type": "object",
"properties": {
"FileIds": {
"description": "The identifiers of the uploaded files.",
"maxItems": 100,
"minItems": 1,
"type": "array",
"items": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"ClearAdvancedDocumentTags": {
"description": "If true, the parsed advanced document tags are deleted from the document.",
"type": "boolean"
},
"SigStringConfigurations": {
"description": "The configurations for the parsing of SigString. The default [`sig`] is always added.",
"maxItems": 50,
"type": "array",
"items": {
"$ref": "#/$defs/FilePrepareSigStringConfiguration"
}
}
},
"$defs": {
"FilePrepareSigStringConfiguration": {
"description": "The configuration for parsing of a SigString.",
"required": [
"StartPattern"
],
"type": "object",
"properties": {
"StartPattern": {
"description": "Define the start pattern.",
"maxLength": 500,
"minLength": 0,
"type": "string"
},
"EndPattern": {
"description": "Define the end pattern.",
"maxLength": 500,
"minLength": 0,
"type": "string"
},
"ClearSigString": {
"description": "If true, the parsed SigString is deleted from the document",
"type": "boolean"
},
"SearchEntireWordOnly": {
"description": "If true, the patterns are only matched as a whole word.",
"type": "boolean"
}
}
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/namirial-file-prepare-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.