superdocs-app · Schema

ProcessUploadRequest

Artificial IntelligenceDocument EditingREST APIMCPSoftware-as-a-Service

Properties

Name Type Description
session_id string Session ID to load this document/attachment into. Must match the chat/async session-id format — letters, digits, '_', '-', '.' only (no ':'); max 256 chars.
filename string Same filename passed to request_upload_url.
parse_mode string 'document' = parse and load as the active editable doc; 'attachment' = process asynchronously as AI-searchable reference (returns job_id to poll).
return_html boolean When false (default), the response is compact — metadata only (chunks_count, version_id, page_setup), no document body — to keep your context small; the document is loaded into the session and you edi
open_mode string parse_mode='document' only. 'replace' (default): the document replaces the session's focused document. 'new_tab' / 'new_focused': it opens as an additional document and becomes the focused one. 'backg
View JSON Schema on GitHub

JSON Schema

superdocs-app-process-upload-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/superdocs-app/json-schema/superdocs-app-process-upload-request-schema.json",
  "title": "ProcessUploadRequest",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/superdocs-app-uploads-api-openapi.yml#/components/schemas/ProcessUploadRequest",
  "properties": {
    "session_id": {
      "type": "string",
      "maxLength": 256,
      "pattern": "^[a-zA-Z0-9_\\-\\.]+$",
      "title": "Session Id",
      "description": "Session ID to load this document/attachment into. Must match the chat/async session-id format — letters, digits, '_', '-', '.' only (no ':'); max 256 chars."
    },
    "filename": {
      "type": "string",
      "maxLength": 255,
      "title": "Filename",
      "description": "Same filename passed to request_upload_url."
    },
    "parse_mode": {
      "type": "string",
      "enum": [
        "document",
        "attachment"
      ],
      "title": "Parse Mode",
      "description": "'document' = parse and load as the active editable doc; 'attachment' = process asynchronously as AI-searchable reference (returns job_id to poll).",
      "default": "document"
    },
    "return_html": {
      "type": "boolean",
      "title": "Return Html",
      "description": "When false (default), the response is compact — metadata only (chunks_count, version_id, page_setup), no document body — to keep your context small; the document is loaded into the session and you edit it via chat. Set true only if you actually need the parsed HTML returned inline.",
      "default": false
    },
    "open_mode": {
      "type": "string",
      "enum": [
        "replace",
        "new_tab",
        "new_focused",
        "background"
      ],
      "title": "Open Mode",
      "description": "parse_mode='document' only. 'replace' (default): the document replaces the session's focused document. 'new_tab' / 'new_focused': it opens as an additional document and becomes the focused one. 'background': it opens as an additional document without changing which document is focused.",
      "default": "replace"
    }
  },
  "type": "object",
  "required": [
    "session_id",
    "filename"
  ]
}

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.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/superdocs-app-process-upload-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.