api.document.m7.org Endpoint Documentation

Generated on 2026-07-19 from cli/endpoints.php --json, config/general.json, and the PHP handlers under lib/php/thisProject/api.

Conventions

  • Base URL: https://api.document.m7.org
  • Response format: json; error format: json.
  • Request parameters are read from the parsed request payload ($this->r), which may include query, form, or JSON body values depending on the router parser.
  • ANY means the route is registered without an HTTP-method constraint. Prefer POST for mutations and request bodies unless the caller contract says otherwise.
  • "Detected request fields" are statically extracted from handlers and delegated service methods; table-backed filters may accept additional fields.

Authentication

  • M7 token config: check soft, issuer id.m7.org; allowed algorithms RS512.
  • Principal route protection from config:
    • /v1/convert, /v1/document, /v1/job -> user, admin, root
    • /v1/admin -> admin, root

Endpoint Summary

Method Path Auth Handler
ANY /hello no explicit auth gate detected in route/handler hello\Controller
ANY /v1/admin/conversion/delete principal route rule: admin, root admin\conversion\Controller::delete
ANY /v1/admin/conversion/get principal route rule: admin, root admin\conversion\Controller::get
ANY /v1/admin/conversion/list principal route rule: admin, root admin\conversion\Controller::listItems
ANY /v1/admin/conversion/save principal route rule: admin, root admin\conversion\Controller::save
ANY /v1/admin/format/delete principal route rule: admin, root admin\format\Controller::delete
ANY /v1/admin/format/get principal route rule: admin, root admin\format\Controller::get
ANY /v1/admin/format/list principal route rule: admin, root admin\format\Controller::listItems
ANY /v1/admin/format/save principal route rule: admin, root admin\format\Controller::save
ANY /v1/admin/health principal route rule: admin, root; validated principal required by handler admin\Controller::health
ANY /v1/admin/job/cleanup principal route rule: admin, root; validated principal required by handler admin\job\Controller::cleanup
ANY /v1/admin/metrics principal route rule: admin, root; validated principal required by handler admin\Controller::metrics
ANY /v1/admin/profile/delete principal route rule: admin, root admin\profile\Controller::delete
ANY /v1/admin/profile/get principal route rule: admin, root admin\profile\Controller::get
ANY /v1/admin/profile/list principal route rule: admin, root admin\profile\Controller::listItems
ANY /v1/admin/profile/save principal route rule: admin, root admin\profile\Controller::save
ANY /v1/convert/async principal route rule: user, admin, root; validated principal required by handler convert\Controller::async
ANY /v1/convert/sync principal route rule: user, admin, root; validated principal required by handler convert\Controller::sync
ANY /v1/document/extract/links principal route rule: user, admin, root document\extract\Controller::links
ANY /v1/document/extract/meta principal route rule: user, admin, root document\extract\Controller::meta
ANY /v1/document/extract/text principal route rule: user, admin, root document\extract\Controller::text
ANY /v1/document/extract/toc principal route rule: user, admin, root document\extract\Controller::toc
ANY /v1/document/parse principal route rule: user, admin, root document\Controller::parse
ANY /v1/document/preview principal route rule: user, admin, root document\Controller::preview
ANY /v1/document/sanitize principal route rule: user, admin, root document\Controller::sanitize
ANY /v1/document/validate principal route rule: user, admin, root document\Controller::validateDocument
ANY /v1/format/input/list no explicit auth gate detected in route/handler format\input\Controller::listItems
ANY /v1/format/matrix no explicit auth gate detected in route/handler format\Controller::matrix
ANY /v1/format/output/list no explicit auth gate detected in route/handler format\output\Controller::listItems
ANY /v1/job/cancel principal route rule: user, admin, root; validated principal required by handler job\Controller::cancel
ANY /v1/job/delete principal route rule: user, admin, root; validated principal required by handler job\Controller::delete
ANY /v1/job/get principal route rule: user, admin, root; validated principal required by handler job\Controller::getJob
ANY /v1/job/list principal route rule: user, admin, root; validated principal required by handler job\Controller::listItems
ANY /v1/job/result principal route rule: user, admin, root; validated principal required by handler job\Controller::result

Endpoints

ANY /hello

Handles hello.

  • Handler: thisProject\api\hello\Controller
  • Source: lib/php/thisProject/api/hello/Controller.php
  • Auth: no explicit auth gate detected in route/handler
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): OK.

ANY /v1/admin/conversion/delete

Deletes conversion.

  • Handler: thisProject\api\admin\conversion\Controller method delete
  • Source: lib/php/thisProject/api/admin/conversion/Controller.php
  • Delegates to: lib/php/thisProject/service/ReferenceCatalog.php::deleteConversion
  • Auth: principal route rule: admin, root
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
    • default_conversion (optional/detected). Detected in handler or delegated service code. Default: ''.
    • enabled (optional/detected). Detected in handler or delegated service code.
    • handler (optional/detected). Detected in handler or delegated service code.
    • input_format (optional/detected). Input format name or id.
    • meta (optional/detected). Detected in handler or delegated service code.
    • name (optional/detected). Name field. Default: ''.
    • output_format (optional/detected). Output format name or id.
    • replacement_conversion (optional/detected). Detected in handler or delegated service code. Default: ''.
    • replacement_name (optional/detected). Detected in handler or delegated service code. Default: ''.
    • sort_order (optional/detected). Detected in handler or delegated service code. Default: 100.
    • source (optional/detected). Source document/content payload. Default: ''.
  • Response: success comment(s): ADMIN_CONVERSION_DELETE; data key(s): id, deleted, name, input_format, input_format_name, output_format, output_format_name, handler, enabled, sort_order, meta.
  • Notable errors: id or name is required; conversion not found; cannot delete conversion.

ANY /v1/admin/conversion/get

Gets conversion.

  • Handler: thisProject\api\admin\conversion\Controller method get
  • Source: lib/php/thisProject/api/admin/conversion/Controller.php
  • Delegates to: lib/php/thisProject/service/ReferenceCatalog.php::getConversion
  • Auth: principal route rule: admin, root
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key.
    • enabled (optional/detected). Detected in handler or delegated service code.
    • handler (optional/detected). Detected in handler or delegated service code.
    • input_format (optional/detected). Input format name or id.
    • meta (optional/detected). Detected in handler or delegated service code.
    • name (optional/detected). Name field.
    • output_format (optional/detected). Output format name or id.
    • sort_order (optional/detected). Detected in handler or delegated service code. Default: 100.
  • Response: success comment(s): ADMIN_CONVERSION_GET; data key(s): id, name, input_format, input_format_name, output_format, output_format_name, handler, enabled, sort_order, meta.
  • Notable errors: id or name is required; conversion not found.

ANY /v1/admin/conversion/list

Lists conversion.

  • Handler: thisProject\api\admin\conversion\Controller method listItems
  • Source: lib/php/thisProject/api/admin/conversion/Controller.php
  • Delegates to: lib/php/thisProject/service/ReferenceCatalog.php::listConversions
  • Auth: principal route rule: admin, root
  • Detected request fields:
    • enabled (optional/detected). Detected in handler or delegated service code.
    • handler (optional/detected). Detected in handler or delegated service code.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • input_format (optional/detected). Input format name or id.
    • meta (optional/detected). Detected in handler or delegated service code.
    • name (optional/detected). Name field.
    • output_format (optional/detected). Output format name or id.
    • sort_order (optional/detected). Detected in handler or delegated service code. Default: 100.
  • Response: success comment(s): ADMIN_CONVERSION_LIST; data key(s): id, name, input_format, input_format_name, output_format, output_format_name, handler, enabled, sort_order, meta.
  • Notable errors: unable to load admin conversions.

ANY /v1/admin/conversion/save

Creates or updates conversion.

  • Handler: thisProject\api\admin\conversion\Controller method save
  • Source: lib/php/thisProject/api/admin/conversion/Controller.php
  • Delegates to: lib/php/thisProject/service/ReferenceCatalog.php::saveConversion
  • Auth: principal route rule: admin, root
  • Detected request fields:
    • name (required). Name field. Default: ''.
    • default_conversion (optional/detected). Detected in handler or delegated service code. Default: ''.
    • enabled (optional/detected). Detected in handler or delegated service code.
    • handler (optional/detected). Detected in handler or delegated service code.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
    • input_format (optional/detected). Input format name or id. Default: ''.
    • meta (optional/detected). Detected in handler or delegated service code.
    • output_format (optional/detected). Output format name or id. Default: ''.
    • replacement_conversion (optional/detected). Detected in handler or delegated service code. Default: ''.
    • replacement_name (optional/detected). Detected in handler or delegated service code. Default: ''.
    • sort_order (optional/detected). Detected in handler or delegated service code. Default: 100.
    • source (optional/detected). Source document/content payload. Default: ''.
  • Response: success comment(s): ADMIN_CONVERSION_SAVE; data key(s): id, name, input_format, input_format_name, output_format, output_format_name, handler, enabled, sort_order, meta.
  • Notable errors: name is required; duplicate conversion name; duplicate input/output pair; unsupported; invalid handler payload.

ANY /v1/admin/format/delete

Deletes format.

  • Handler: thisProject\api\admin\format\Controller method delete
  • Source: lib/php/thisProject/api/admin/format/Controller.php
  • Delegates to: lib/php/thisProject/service/ReferenceCatalog.php::deleteFormat
  • Auth: principal route rule: admin, root
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
    • enabled (optional/detected). Detected in handler or delegated service code.
    • job_id (optional/detected). Job id. Some handlers also accept id as an alias. Default: ''.
    • label (optional/detected). Display label. Default: null.
    • meta (optional/detected). Detected in handler or delegated service code.
    • name (optional/detected). Name field. Default: ''.
    • replacement_format (optional/detected). Detected in handler or delegated service code. Default: ''.
    • replacement_name (optional/detected). Detected in handler or delegated service code. Default: ''.
    • sort_order (optional/detected). Detected in handler or delegated service code. Default: 100.
    • source (optional/detected). Source document/content payload. Default: ''.
    • supports_input (optional/detected). Detected in handler or delegated service code.
    • supports_output (optional/detected). Detected in handler or delegated service code.
  • Response: success comment(s): ADMIN_FORMAT_DELETE; data key(s): id, deleted, name, label, enabled, supports_input, supports_output, sort_order, meta.
  • Notable errors: id or name is required; format not found; cannot delete format.

ANY /v1/admin/format/get

Gets format.

  • Handler: thisProject\api\admin\format\Controller method get
  • Source: lib/php/thisProject/api/admin/format/Controller.php
  • Delegates to: lib/php/thisProject/service/ReferenceCatalog.php::getFormat
  • Auth: principal route rule: admin, root
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key.
    • enabled (optional/detected). Detected in handler or delegated service code.
    • label (optional/detected). Display label.
    • meta (optional/detected). Detected in handler or delegated service code.
    • name (optional/detected). Name field.
    • sort_order (optional/detected). Detected in handler or delegated service code. Default: 100.
    • supports_input (optional/detected). Detected in handler or delegated service code.
    • supports_output (optional/detected). Detected in handler or delegated service code.
  • Response: success comment(s): ADMIN_FORMAT_GET; data key(s): id, name, label, enabled, supports_input, supports_output, sort_order, meta.
  • Notable errors: id or name is required; format not found.

ANY /v1/admin/format/list

Lists format.

  • Handler: thisProject\api\admin\format\Controller method listItems
  • Source: lib/php/thisProject/api/admin/format/Controller.php
  • Delegates to: lib/php/thisProject/service/ReferenceCatalog.php::listFormats
  • Auth: principal route rule: admin, root
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): ADMIN_FORMAT_LIST.
  • Notable errors: unable to load admin formats.

ANY /v1/admin/format/save

Creates or updates format.

  • Handler: thisProject\api\admin\format\Controller method save
  • Source: lib/php/thisProject/api/admin/format/Controller.php
  • Delegates to: lib/php/thisProject/service/ReferenceCatalog.php::saveFormat
  • Auth: principal route rule: admin, root
  • Detected request fields:
    • label (required). Display label. Default: ''.
    • name (required). Name field. Default: ''.
    • enabled (optional/detected). Detected in handler or delegated service code.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
    • meta (optional/detected). Detected in handler or delegated service code.
    • replacement_format (optional/detected). Detected in handler or delegated service code. Default: ''.
    • replacement_name (optional/detected). Detected in handler or delegated service code. Default: ''.
    • sort_order (optional/detected). Detected in handler or delegated service code. Default: 100.
    • source (optional/detected). Source document/content payload. Default: ''.
    • supports_input (optional/detected). Detected in handler or delegated service code.
    • supports_output (optional/detected). Detected in handler or delegated service code.
  • Response: success comment(s): ADMIN_FORMAT_SAVE; data key(s): id, name, label, enabled, supports_input, supports_output, sort_order, meta.
  • Notable errors: name is required; label is required; duplicate format name.

ANY /v1/admin/health

Returns health for controller.

  • Handler: thisProject\api\admin\Controller method health
  • Source: lib/php/thisProject/api/admin/Controller.php
  • Auth: principal route rule: admin, root; validated principal required by handler
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): HEALTH.

ANY /v1/admin/job/cleanup

Cleans up job.

  • Handler: thisProject\api\admin\job\Controller method cleanup
  • Source: lib/php/thisProject/api/admin/job/Controller.php
  • Delegates to: lib/php/thisProject/service/JobManager.php::cleanupExpiredPayloads
  • Auth: principal route rule: admin, root; validated principal required by handler
  • Detected request fields:
    • cutoff_at (optional/detected). Detected in handler or delegated service code.
    • dry_run (optional/detected). Detected in handler or delegated service code. Default: false.
    • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes.
    • status (optional/detected). Status filter or value.
    • statuses (optional/detected). Detected in handler or delegated service code.
  • Response: success comment(s): ADMIN_JOB_CLEANUP.
  • Notable errors: Admin principal required; invalid cutoff_at; invalid owner; invalid; invalid cleanup status filter.

ANY /v1/admin/metrics

Returns metrics for controller.

  • Handler: thisProject\api\admin\Controller method metrics
  • Source: lib/php/thisProject/api/admin/Controller.php
  • Delegates to: lib/php/thisProject/service/ReferenceCatalog.php::ensureTables, lib/php/thisProject/service/ReferenceCatalog.php::listFormats, lib/php/thisProject/service/ReferenceCatalog.php::listConversions, lib/php/thisProject/service/ReferenceCatalog.php::listProfiles, lib/php/thisProject/service/JobManager.php::listJobs
  • Auth: principal route rule: admin, root; validated principal required by handler
  • Detected request fields:
    • active (optional/detected). Detected in handler or delegated service code.
    • conversion_rules (optional/detected). Detected in handler or delegated service code.
    • cursor (optional/detected). Opaque pagination cursor.
    • enabled (optional/detected). Detected in handler or delegated service code.
    • format (optional/detected). Detected in handler or delegated service code.
    • handler (optional/detected). Detected in handler or delegated service code.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • input_format (optional/detected). Input format name or id. Default: ''.
    • label (optional/detected). Display label.
    • limit (optional/detected). Page size limit. Default: 3.
    • meta (optional/detected). Detected in handler or delegated service code.
    • name (optional/detected). Name field.
    • offset (optional/detected). Zero-based pagination offset.
    • output_format (optional/detected). Output format name or id. Default: ''.
    • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
    • page_number (optional/detected). One-based page number.
    • sanitize_policy (optional/detected). Detected in handler or delegated service code.
    • sort_order (optional/detected). Detected in handler or delegated service code. Default: 100.
    • status (optional/detected). Status filter or value. Default: ''.
    • supports_input (optional/detected). Detected in handler or delegated service code.
    • supports_output (optional/detected). Detected in handler or delegated service code.
  • Response: success comment(s): METRICS; data key(s): id, name, input_format, input_format_name, output_format, output_format_name, handler, enabled, sort_order, meta, label, supports_input, supports_output, items, limit, total_count.
  • Notable errors: unable to load metrics; invalid status filter; invalid offset; invalid page_number; invalid cursor.

ANY /v1/admin/profile/delete

Deletes profile.

  • Handler: thisProject\api\admin\profile\Controller method delete
  • Source: lib/php/thisProject/api/admin/profile/Controller.php
  • Delegates to: lib/php/thisProject/service/ReferenceCatalog.php::deleteProfile
  • Auth: principal route rule: admin, root
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
    • active (optional/detected). Detected in handler or delegated service code.
    • conversion_rules (optional/detected). Detected in handler or delegated service code.
    • format (optional/detected). Detected in handler or delegated service code.
    • label (optional/detected). Display label.
    • name (optional/detected). Name field. Default: 'profile'.
    • replacement_name (optional/detected). Detected in handler or delegated service code. Default: ''.
    • replacement_profile (optional/detected). Detected in handler or delegated service code. Default: ''.
    • sanitize_policy (optional/detected). Detected in handler or delegated service code.
    • sort_order (optional/detected). Detected in handler or delegated service code. Default: 100.
    • source (optional/detected). Source document/content payload. Default: ''.
  • Response: success comment(s): ADMIN_PROFILE_DELETE; data key(s): id, deleted.
  • Notable errors: id or name is required; profile not found; cannot delete profile.

ANY /v1/admin/profile/get

Gets profile.

  • Handler: thisProject\api\admin\profile\Controller method get
  • Source: lib/php/thisProject/api/admin/profile/Controller.php
  • Delegates to: lib/php/thisProject/service/ReferenceCatalog.php::getProfile
  • Auth: principal route rule: admin, root
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key.
    • active (optional/detected). Detected in handler or delegated service code.
    • conversion_rules (optional/detected). Detected in handler or delegated service code.
    • format (optional/detected). Detected in handler or delegated service code.
    • label (optional/detected). Display label.
    • name (optional/detected). Name field.
    • sanitize_policy (optional/detected). Detected in handler or delegated service code.
    • sort_order (optional/detected). Detected in handler or delegated service code. Default: 100.
  • Response: success comment(s): ADMIN_PROFILE_GET.
  • Notable errors: id or name is required; profile not found.

ANY /v1/admin/profile/list

Lists profile.

  • Handler: thisProject\api\admin\profile\Controller method listItems
  • Source: lib/php/thisProject/api/admin/profile/Controller.php
  • Delegates to: lib/php/thisProject/service/ReferenceCatalog.php::listProfiles
  • Auth: principal route rule: admin, root
  • Detected request fields:
    • active (optional/detected). Detected in handler or delegated service code.
    • conversion_rules (optional/detected). Detected in handler or delegated service code.
    • enabled (optional/detected). Detected in handler or delegated service code.
    • format (optional/detected). Detected in handler or delegated service code.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • label (optional/detected). Display label.
    • meta (optional/detected). Detected in handler or delegated service code.
    • name (optional/detected). Name field.
    • sanitize_policy (optional/detected). Detected in handler or delegated service code.
    • sort_order (optional/detected). Detected in handler or delegated service code. Default: 100.
    • supports_input (optional/detected). Detected in handler or delegated service code.
    • supports_output (optional/detected). Detected in handler or delegated service code.
  • Response: success comment(s): ADMIN_PROFILE_LIST; data key(s): id, name, label, enabled, supports_input, supports_output, sort_order, meta.
  • Notable errors: unable to load admin profiles.

ANY /v1/admin/profile/save

Creates or updates profile.

  • Handler: thisProject\api\admin\profile\Controller method save
  • Source: lib/php/thisProject/api/admin/profile/Controller.php
  • Delegates to: lib/php/thisProject/service/ReferenceCatalog.php::saveProfile
  • Auth: principal route rule: admin, root
  • Detected request fields:
    • label (required). Display label. Default: ''.
    • name (required). Name field. Default: ''.
    • active (optional/detected). Detected in handler or delegated service code.
    • conversion_rules (optional/detected). Detected in handler or delegated service code.
    • format (optional/detected). Detected in handler or delegated service code.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
    • input_formats (optional/detected). Detected in handler or delegated service code.
    • output_formats (optional/detected). Detected in handler or delegated service code.
    • replacement_name (optional/detected). Detected in handler or delegated service code. Default: ''.
    • replacement_profile (optional/detected). Detected in handler or delegated service code. Default: ''.
    • sanitize_policy (optional/detected). Detected in handler or delegated service code.
    • sort_order (optional/detected). Detected in handler or delegated service code. Default: 100.
    • source (optional/detected). Source document/content payload. Default: ''.
  • Response: success comment(s): ADMIN_PROFILE_SAVE.
  • Notable errors: name is required; label is required; duplicate profile name; unsupported.

ANY /v1/convert/async

Queues async conversion for convert.

  • Handler: thisProject\api\convert\Controller method async
  • Source: lib/php/thisProject/api/convert/Controller.php
  • Delegates to: lib/php/thisProject/service/JobManager.php::queue
  • Auth: principal route rule: user, admin, root; validated principal required by handler
  • Detected request fields:
    • source (required). Source document/content payload. Default: ''.
    • duration_ms (optional/detected). Detected in handler or delegated service code. Default: null.
    • filename (optional/detected). Original or display filename.
    • input (optional/detected). Detected in handler or delegated service code.
    • input_format (optional/detected). Input format name or id. Default: ''.
    • issues (optional/detected). Detected in handler or delegated service code.
    • job_ttl (optional/detected). Job time-to-live in seconds. Default: 3600.
    • locale (optional/detected). Locale hint.
    • metadata (optional/detected). Caller-supplied metadata object.
    • options (optional/detected). Handler-specific options object.
    • output_format (optional/detected). Output format name or id. Default: ''.
    • profile (optional/detected). Optional conversion/profile id or name. Default: ''.
    • result (optional/detected). Detected in handler or delegated service code.
    • result_format (optional/detected). Detected in handler or delegated service code.
    • warnings (optional/detected). Detected in handler or delegated service code.
  • Response: success comment(s): CONVERT_ASYNC; data key(s): job_id, mode, status, input_format, output_format, expires_at, metadata.
  • Notable errors: source is required; Principal not found; job input not found.

ANY /v1/convert/sync

Runs sync conversion for convert.

  • Handler: thisProject\api\convert\Controller method sync
  • Source: lib/php/thisProject/api/convert/Controller.php
  • Delegates to: lib/php/thisProject/service/JobManager.php::sync
  • Auth: principal route rule: user, admin, root; validated principal required by handler
  • Detected request fields:
    • source (required). Source document/content payload. Default: ''.
    • duration_ms (optional/detected). Detected in handler or delegated service code. Default: null.
    • filename (optional/detected). Original or display filename.
    • input (optional/detected). Detected in handler or delegated service code.
    • input_format (optional/detected). Input format name or id. Default: ''.
    • issues (optional/detected). Detected in handler or delegated service code.
    • job_ttl (optional/detected). Job time-to-live in seconds. Default: 3600.
    • locale (optional/detected). Locale hint.
    • metadata (optional/detected). Caller-supplied metadata object.
    • options (optional/detected). Handler-specific options object.
    • output_format (optional/detected). Output format name or id. Default: ''.
    • profile (optional/detected). Optional conversion/profile id or name. Default: ''.
    • result (optional/detected). Detected in handler or delegated service code.
    • result_format (optional/detected). Detected in handler or delegated service code.
    • warnings (optional/detected). Detected in handler or delegated service code.
  • Response: success comment(s): CONVERT_SYNC.
  • Notable errors: source is required; Principal not found; job input not found.

ANY /v1/document/extract/links

Handles document extract links.

  • Handler: thisProject\api\document\extract\Controller method links
  • Source: lib/php/thisProject/api/document/extract/Controller.php
  • Delegates to: lib/php/thisProject/service/ConversionHandler.php::extractDocument
  • Auth: principal route rule: user, admin, root
  • Detected request fields:
    • source (required). Source document/content payload. Default: ''.
    • input_format (optional/detected). Input format name or id. Default: ''.
  • Response: JSON response from the handler/delegated service.
  • Notable errors: source is required; unsupported extract kind.

ANY /v1/document/extract/meta

Handles document extract meta.

  • Handler: thisProject\api\document\extract\Controller method meta
  • Source: lib/php/thisProject/api/document/extract/Controller.php
  • Delegates to: lib/php/thisProject/service/ConversionHandler.php::extractDocument
  • Auth: principal route rule: user, admin, root
  • Detected request fields:
    • source (required). Source document/content payload. Default: ''.
    • input_format (optional/detected). Input format name or id. Default: ''.
  • Response: JSON response from the handler/delegated service.
  • Notable errors: source is required; unsupported extract kind.

ANY /v1/document/extract/text

Handles document extract text.

  • Handler: thisProject\api\document\extract\Controller method text
  • Source: lib/php/thisProject/api/document/extract/Controller.php
  • Delegates to: lib/php/thisProject/service/ConversionHandler.php::extractDocument
  • Auth: principal route rule: user, admin, root
  • Detected request fields:
    • source (required). Source document/content payload. Default: ''.
    • input_format (optional/detected). Input format name or id. Default: ''.
  • Response: JSON response from the handler/delegated service.
  • Notable errors: source is required; unsupported extract kind.

ANY /v1/document/extract/toc

Handles document extract toc.

  • Handler: thisProject\api\document\extract\Controller method toc
  • Source: lib/php/thisProject/api/document/extract/Controller.php
  • Delegates to: lib/php/thisProject/service/ConversionHandler.php::extractDocument
  • Auth: principal route rule: user, admin, root
  • Detected request fields:
    • source (required). Source document/content payload. Default: ''.
    • input_format (optional/detected). Input format name or id. Default: ''.
  • Response: JSON response from the handler/delegated service.
  • Notable errors: source is required; unsupported extract kind.

ANY /v1/document/parse

Parses document.

  • Handler: thisProject\api\document\Controller method parse
  • Source: lib/php/thisProject/api/document/Controller.php
  • Delegates to: lib/php/thisProject/service/ConversionHandler.php::parseDocument, lib/php/thisProject/service/JobManager.php::syncDocumentOperation
  • Auth: principal route rule: user, admin, root
  • Detected request fields:
    • source (required). Source document/content payload. Default: ''.
    • duration_ms (optional/detected). Detected in handler or delegated service code. Default: null.
    • filename (optional/detected). Original or display filename.
    • input_format (optional/detected). Input format name or id. Default: ''.
    • issues (optional/detected). Detected in handler or delegated service code.
    • job_ttl (optional/detected). Job time-to-live in seconds. Default: 3600.
    • locale (optional/detected). Locale hint.
    • metadata (optional/detected). Caller-supplied metadata object.
    • options (optional/detected). Handler-specific options object.
    • output_format (optional/detected). Output format name or id.
    • result (optional/detected). Detected in handler or delegated service code.
    • result_format (optional/detected). Detected in handler or delegated service code.
    • warnings (optional/detected). Detected in handler or delegated service code.
  • Response: success comment(s): PARSE.
  • Notable errors: source is required; operation handler not callable; Principal not found; operation failed.

ANY /v1/document/preview

Builds preview for document.

  • Handler: thisProject\api\document\Controller method preview
  • Source: lib/php/thisProject/api/document/Controller.php
  • Delegates to: lib/php/thisProject/service/ConversionHandler.php::previewDocument, lib/php/thisProject/service/JobManager.php::syncDocumentOperation
  • Auth: principal route rule: user, admin, root
  • Detected request fields:
    • source (required). Source document/content payload. Default: ''.
    • duration_ms (optional/detected). Detected in handler or delegated service code. Default: null.
    • filename (optional/detected). Original or display filename.
    • input_format (optional/detected). Input format name or id. Default: ''.
    • issues (optional/detected). Detected in handler or delegated service code.
    • job_ttl (optional/detected). Job time-to-live in seconds. Default: 3600.
    • locale (optional/detected). Locale hint.
    • metadata (optional/detected). Caller-supplied metadata object.
    • options (optional/detected). Handler-specific options object.
    • output_format (optional/detected). Output format name or id.
    • result (optional/detected). Detected in handler or delegated service code.
    • result_format (optional/detected). Detected in handler or delegated service code.
    • warnings (optional/detected). Detected in handler or delegated service code.
  • Response: success comment(s): PREVIEW.
  • Notable errors: source is required; operation handler not callable; Principal not found; operation failed.

ANY /v1/document/sanitize

Sanitizes document.

  • Handler: thisProject\api\document\Controller method sanitize
  • Source: lib/php/thisProject/api/document/Controller.php
  • Delegates to: lib/php/thisProject/service/ConversionHandler.php::sanitizeDocument, lib/php/thisProject/service/JobManager.php::syncDocumentOperation
  • Auth: principal route rule: user, admin, root
  • Detected request fields:
    • source (required). Source document/content payload. Default: ''.
    • duration_ms (optional/detected). Detected in handler or delegated service code. Default: null.
    • filename (optional/detected). Original or display filename.
    • input_format (optional/detected). Input format name or id. Default: ''.
    • issues (optional/detected). Detected in handler or delegated service code.
    • job_ttl (optional/detected). Job time-to-live in seconds. Default: 3600.
    • locale (optional/detected). Locale hint.
    • metadata (optional/detected). Caller-supplied metadata object.
    • options (optional/detected). Handler-specific options object.
    • output_format (optional/detected). Output format name or id.
    • result (optional/detected). Detected in handler or delegated service code.
    • result_format (optional/detected). Detected in handler or delegated service code.
    • warnings (optional/detected). Detected in handler or delegated service code.
  • Response: success comment(s): SANITIZE.
  • Notable errors: source is required; operation handler not callable; Principal not found; operation failed.

ANY /v1/document/validate

Validates document.

  • Handler: thisProject\api\document\Controller method validateDocument
  • Source: lib/php/thisProject/api/document/Controller.php
  • Delegates to: lib/php/thisProject/service/ConversionHandler.php::validateDocument, lib/php/thisProject/service/JobManager.php::syncDocumentOperation
  • Auth: principal route rule: user, admin, root
  • Detected request fields:
    • source (required). Source document/content payload. Default: ''.
    • duration_ms (optional/detected). Detected in handler or delegated service code. Default: null.
    • filename (optional/detected). Original or display filename.
    • input_format (optional/detected). Input format name or id. Default: ''.
    • issues (optional/detected). Detected in handler or delegated service code.
    • job_ttl (optional/detected). Job time-to-live in seconds. Default: 3600.
    • locale (optional/detected). Locale hint.
    • metadata (optional/detected). Caller-supplied metadata object.
    • options (optional/detected). Handler-specific options object.
    • output_format (optional/detected). Output format name or id. Default: null.
    • result (optional/detected). Detected in handler or delegated service code.
    • result_format (optional/detected). Detected in handler or delegated service code.
    • warnings (optional/detected). Detected in handler or delegated service code.
  • Response: success comment(s): VALIDATE.
  • Notable errors: source is required; operation handler not callable; Principal not found; operation failed.

ANY /v1/format/input/list

Lists format input.

  • Handler: thisProject\api\format\input\Controller method listItems
  • Source: lib/php/thisProject/api/format/input/Controller.php
  • Delegates to: lib/php/thisProject/service/ReferenceCatalog.php::listInputFormats
  • Auth: no explicit auth gate detected in route/handler
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): INPUT_FORMAT_LIST.
  • Notable errors: unable to load input formats.

ANY /v1/format/matrix

Returns matrix for format.

  • Handler: thisProject\api\format\Controller method matrix
  • Source: lib/php/thisProject/api/format/Controller.php
  • Delegates to: lib/php/thisProject/service/ReferenceCatalog.php::formatMatrix
  • Auth: no explicit auth gate detected in route/handler
  • Detected request fields:
    • active (optional/detected). Detected in handler or delegated service code.
    • conversion_rules (optional/detected). Detected in handler or delegated service code.
    • enabled (optional/detected). Detected in handler or delegated service code.
    • handler (optional/detected). Detected in handler or delegated service code.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • input_format (optional/detected). Input format name or id.
    • label (optional/detected). Display label.
    • meta (optional/detected). Detected in handler or delegated service code.
    • name (optional/detected). Name field.
    • output_format (optional/detected). Output format name or id.
    • sanitize_policy (optional/detected). Detected in handler or delegated service code.
    • sort_order (optional/detected). Detected in handler or delegated service code. Default: 100.
  • Response: success comment(s): FORMAT_MATRIX; data key(s): id, name, input_format, input_format_name, output_format, output_format_name, handler, enabled, sort_order, meta.
  • Notable errors: unable to load format matrix.

ANY /v1/format/output/list

Lists format output.

  • Handler: thisProject\api\format\output\Controller method listItems
  • Source: lib/php/thisProject/api/format/output/Controller.php
  • Delegates to: lib/php/thisProject/service/ReferenceCatalog.php::listOutputFormats
  • Auth: no explicit auth gate detected in route/handler
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): OUTPUT_FORMAT_LIST.
  • Notable errors: unable to load output formats.

ANY /v1/job/cancel

Cancels job.

  • Handler: thisProject\api\job\Controller method cancel
  • Source: lib/php/thisProject/api/job/Controller.php
  • Delegates to: lib/php/thisProject/service/JobManager.php::cancel
  • Auth: principal route rule: user, admin, root; validated principal required by handler
  • Detected request fields:
    • job_id (required). Job id. Some handlers also accept id as an alias.
  • Response: success comment(s): JOB_CANCEL; data key(s): job_id, status, cancelled_at.
  • Notable errors: job already completed; job cannot be cancelled; job_id is required; Job not found.

ANY /v1/job/delete

Deletes job.

  • Handler: thisProject\api\job\Controller method delete
  • Source: lib/php/thisProject/api/job/Controller.php
  • Delegates to: lib/php/thisProject/service/JobManager.php::delete
  • Auth: principal route rule: user, admin, root; validated principal required by handler
  • Detected request fields:
    • job_id (required). Job id. Some handlers also accept id as an alias.
  • Response: success comment(s): JOB_DELETE; data key(s): job_id, deleted.
  • Notable errors: job_id is required; Job not found.

ANY /v1/job/get

Gets job.

  • Handler: thisProject\api\job\Controller method getJob
  • Source: lib/php/thisProject/api/job/Controller.php
  • Delegates to: lib/php/thisProject/service/JobManager.php::get
  • Auth: principal route rule: user, admin, root; validated principal required by handler
  • Detected request fields:
    • job_id (required). Job id. Some handlers also accept id as an alias.
    • cancelled (optional/detected). Detected in handler or delegated service code.
    • completed (optional/detected). Detected in handler or delegated service code.
    • created (optional/detected). Detected in handler or delegated service code.
    • duration_ms (optional/detected). Detected in handler or delegated service code.
    • errors (optional/detected). Detected in handler or delegated service code. Default: [].
    • expires (optional/detected). Expiration timestamp.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • input (optional/detected). Detected in handler or delegated service code.
    • input_format (optional/detected). Input format name or id.
    • input_row (optional/detected). Detected in handler or delegated service code.
    • issues (optional/detected). Detected in handler or delegated service code. Default: [].
    • meta (optional/detected). Detected in handler or delegated service code.
    • metadata (optional/detected). Caller-supplied metadata object.
    • mode (optional/detected). Detected in handler or delegated service code.
    • operation (optional/detected). Detected in handler or delegated service code.
    • output_format (optional/detected). Output format name or id.
    • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes.
    • profile (optional/detected). Optional conversion/profile id or name.
    • result_bytes (optional/detected). Detected in handler or delegated service code.
    • source_row (optional/detected). Detected in handler or delegated service code.
    • started (optional/detected). Detected in handler or delegated service code.
    • status (optional/detected). Status filter or value.
    • warnings (optional/detected). Detected in handler or delegated service code. Default: [].
  • Response: success comment(s): JOB_GET.
  • Notable errors: job_id is required; Job not found.

ANY /v1/job/list

Lists job.

  • Handler: thisProject\api\job\Controller method listItems
  • Source: lib/php/thisProject/api/job/Controller.php
  • Delegates to: lib/php/thisProject/service/JobManager.php::listJobs
  • Auth: principal route rule: user, admin, root; validated principal required by handler
  • Detected request fields:
    • cursor (optional/detected). Opaque pagination cursor.
    • input_format (optional/detected). Input format name or id. Default: ''.
    • limit (optional/detected). Page size limit. Default: 3.
    • offset (optional/detected). Zero-based pagination offset.
    • output_format (optional/detected). Output format name or id. Default: ''.
    • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
    • page_number (optional/detected). One-based page number.
    • status (optional/detected). Status filter or value. Default: ''.
  • Response: success comment(s): JOB_LIST; data key(s): items, limit, total_count, next_offset, page_number, page_total, next_cursor.
  • Notable errors: invalid status filter; invalid offset; invalid page_number; invalid cursor.

ANY /v1/job/result

Handles job result.

  • Handler: thisProject\api\job\Controller method result
  • Source: lib/php/thisProject/api/job/Controller.php
  • Delegates to: lib/php/thisProject/service/JobManager.php::result
  • Auth: principal route rule: user, admin, root; validated principal required by handler
  • Detected request fields:
    • job_id (required). Job id. Some handlers also accept id as an alias.
    • cancelled (optional/detected). Detected in handler or delegated service code.
    • completed (optional/detected). Detected in handler or delegated service code.
    • created (optional/detected). Detected in handler or delegated service code.
    • duration_ms (optional/detected). Detected in handler or delegated service code.
    • expires (optional/detected). Expiration timestamp.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • input (optional/detected). Detected in handler or delegated service code.
    • input_format (optional/detected). Input format name or id.
    • input_row (optional/detected). Detected in handler or delegated service code.
    • issues (optional/detected). Detected in handler or delegated service code. Default: [].
    • meta (optional/detected). Detected in handler or delegated service code.
    • metadata (optional/detected). Caller-supplied metadata object.
    • mode (optional/detected). Detected in handler or delegated service code.
    • operation (optional/detected). Detected in handler or delegated service code.
    • output_format (optional/detected). Output format name or id.
    • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes.
    • profile (optional/detected). Optional conversion/profile id or name.
    • result_bytes (optional/detected). Detected in handler or delegated service code.
    • source_row (optional/detected). Detected in handler or delegated service code.
    • started (optional/detected). Detected in handler or delegated service code.
    • status (optional/detected). Status filter or value.
    • warnings (optional/detected). Detected in handler or delegated service code. Default: [].
  • Response: success comment(s): JOB_RESULT.
  • Notable errors: job failed; job not completed; job expired; job_id is required; Job not found.
1