superdocs-app · Schema
DownloadUrlRequest
Artificial IntelligenceDocument EditingREST APIMCPSoftware-as-a-Service
Properties
| Name | Type | Description |
|---|---|---|
| session_id | string | Session ID whose current document should be exported and packaged for download. |
| format | string | Export format (docx, pdf, html, markdown, txt). |
| filename | object | Optional Content-Disposition filename for the download (without extension). Auto-detected from the document's first heading if not provided. |
| options | object | Customization (paper, margins, filename, watermark, etc.). Mirrors ExportRequest.options. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/superdocs-app/json-schema/superdocs-app-download-url-request-schema.json",
"title": "DownloadUrlRequest",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/superdocs-app-downloads-api-openapi.yml#/components/schemas/DownloadUrlRequest",
"properties": {
"session_id": {
"type": "string",
"maxLength": 256,
"title": "Session Id",
"description": "Session ID whose current document should be exported and packaged for download."
},
"format": {
"type": "string",
"enum": [
"docx",
"pdf",
"html",
"markdown",
"txt",
"doc"
],
"title": "Format",
"description": "Export format (docx, pdf, html, markdown, txt).",
"default": "docx"
},
"filename": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
],
"title": "Filename",
"description": "Optional Content-Disposition filename for the download (without extension). Auto-detected from the document's first heading if not provided."
},
"options": {
"$ref": "#/$defs/ExportOptions",
"description": "Customization (paper, margins, filename, watermark, etc.). Mirrors ExportRequest.options."
}
},
"type": "object",
"required": [
"session_id"
],
"$defs": {
"ExportOptions": {
"properties": {
"paper_size": {
"type": "string",
"enum": [
"A4",
"Letter",
"A3",
"Legal"
],
"title": "Paper Size",
"description": "Page size for DOCX/PDF/legacy .doc. HTML/MD/TXT exports ignore.",
"default": "Letter"
},
"orientation": {
"type": "string",
"enum": [
"portrait",
"landscape"
],
"title": "Orientation",
"description": "Page orientation for DOCX/PDF/legacy .doc.",
"default": "portrait"
},
"margins": {
"type": "string",
"enum": [
"narrow",
"normal",
"wide",
"custom"
],
"title": "Margins",
"description": "Page margins preset. 'narrow' = 0.5in, 'normal' = 1.0in, 'wide' = 1.5in. 'custom' uses custom_margins_inches.",
"default": "normal"
},
"custom_margins_inches": {
"anyOf": [
{
"additionalProperties": {
"type": "number"
},
"propertyNames": {
"enum": [
"top",
"right",
"bottom",
"left"
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Custom Margins Inches",
"description": "Required when margins='custom'. Each value 0.25-3.0 inches."
},
"filename": {
"anyOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
],
"title": "Filename",
"description": "Custom filename (no extension). Auto-detected from first <h1> if unset."
},
"embed_images": {
"type": "boolean",
"title": "Embed Images",
"description": "HTML export only. When True, images are base64-embedded for offline portability (raises size cap to 150 MB). When False, images are referenced by URL (smaller file, online-only).",
"default": false
},
"watermark_text": {
"anyOf": [
{
"type": "string",
"maxLength": 64
},
{
"type": "null"
}
],
"title": "Watermark Text",
"description": "PDF only. Optional text watermark overlaid on every page."
},
"watermark_opacity": {
"type": "number",
"maximum": 1.0,
"minimum": 0.05,
"title": "Watermark Opacity",
"description": "PDF watermark opacity, 0.05-1.0.",
"default": 0.3
},
"fidelity": {
"anyOf": [
{
"type": "string",
"enum": [
"strict",
"compat"
]
},
{
"type": "null"
}
],
"title": "Fidelity",
"description": "Export fidelity. 'strict' (server default) renders only the formatting the document carries — no imposed table widths/borders (except visual defaults on fully unstyled tables), overflow-only clamping, highlight colors honored. 'compat' reproduces the legacy normalized output."
}
},
"type": "object",
"title": "ExportOptions",
"description": "User-facing export customisation (page size, orientation, margins,\nfilename, watermark). Sent on every export request."
}
}
}
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/superdocs-app-download-url-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.