API

/web_api/public/text_document/file

/web_api/public/text_document/file ​

This page is built from the JSON Schema snapshot in the documentation repository. The snapshot is updated by a separate command from the main app catalog and is not rewritten when the site is built.

Request ​

main-app://schemas/api_public_text_document/file.request.json

GET /web_api/public/text_document/file query

NameTypeRequiredConstraint
tokenstringNo-
share_tokenstringNo-
file_uuidstringNo-
passwordstringNo-

Other top-level fields are allowed.

Response ​

main-app://schemas/api_public_text_document/file.response.json

GET /web_api/public/text_document/file is not JSON

The schema names no fields.

Source schema ​

The files below are copied from the snapshot unchanged. A $ref fragment is a separate block. The schemas are not merged.

Request: main-app://schemas/api_public_text_document/file.request.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_public_text_document/file.request.json",
  "title": "GET /web_api/public/text_document/file query",
  "type": "object",
  "required": [],
  "additionalProperties": true,
  "properties": {
    "token": {
      "type": "string"
    },
    "share_token": {
      "type": "string"
    },
    "file_uuid": {
      "type": "string"
    },
    "password": {
      "type": "string"
    }
  }
}
Response: main-app://schemas/api_public_text_document/file.response.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_public_text_document/file.response.json",
  "title": "GET /web_api/public/text_document/file is not JSON",
  "description": "Raw file bytes. Headers Content-Type, Cache-Control, X-Robots-Tag. Not the api_code envelope.",
  "type": "string"
}

Version 1.0.0 · Last updated 2026-10-07

Did this page help?