submit_document
Submit a document for indexing on OpenArx. Supports LaTeX, Markdown, and PDF formats. Returns a core_document_id for status tracking. Published documents are immutable. To correct or update one later, publish a new version rather than editing in place. Content is file-only: provide a base64-encoded ZIP archive (content_archive_base64) OR a content_ref from an out-of-band upload — exactly one. A ZIP may hold a single PDF, markdown + figures, or multifile LaTeX. Inline text is no longer accepted. For content above ~10 KB, prefer create_upload_url → PUT the file to the returned URL → pass the returned file_id as content_ref (avoids base64 token bloat). content_archive_base64 and content_ref are mutually exclusive — provide exactly one. Limits: title ≤5,000 chars; abstract ≤50,000 chars; archive ≤50 MB; keywords ≤50 items × ≤100 chars each. Set dry_run=true to validate without committing: no document is created, nothing is queued, no credits are charged; the response shows what would be saved and the estimated cost.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| doi | No | DOI of the work. | |
| hubs | No | Portal hub / topic slugs to associate. | |
| title | Yes | Document title | |
| run_id | No | Optional. The active methodist run_id (as returned by the methodist diagnose / get_current_dose door). Pass it whenever you call this tool while working inside a run, so the call is attributed to that run for the §8 usage crosscheck — attribution is run-anchored, so it stays correct even if your access token refreshes mid-run. Must be YOUR run: a run_id owned by a different principal, or a non-existent run_id, is rejected. | |
| authors | Yes | Author list | |
| dry_run | No | Validate only — no document created, no file written, no queue entry, 0 credits. Response: {dry_run:true, validation:"ok", estimated_cost, would_save}. | |
| funding | No | Funding sources, e.g. [{ funder_name, award_number? }]. | |
| license | No | License (e.g. cc-by-4.0) | cc-by-4.0 |
| abstract | Yes | Document abstract | |
| arxiv_id | No | arXiv identifier, if cross-posted. | |
| keywords | No | Keywords | |
| language | No | Document language (ISO 639-1) | en |
| main_file | No | Filename within the archive to treat as primary content. If exactly one .pdf / .tex / .md file exists at the archive root, auto-inferred when omitted. Otherwise required. For a content_ref ZIP this selects the entry; ignored for a content_ref single file. | |
| categories | No | List of subject categories. arXiv format recommended: `{domain}.{subcategory}` where domain is lowercase (with optional hyphens) and subcategory is two uppercase letters. Examples: "cs.CL" (Computation and Language), "math.PR" (Probability), "cond-mat.str-el" (Strongly Correlated Electrons), "physics.gen-ph" (General Physics). Other formats accepted but may render inconsistently in search facets. | |
| code_links | No | Source-code repositories, e.g. [{ url }]. | |
| source_url | No | Canonical source URL. | |
| content_ref | No | file_id from a successful create_upload_url + PUT upload flow. The uploaded ZIP / PDF / LaTeX / Markdown becomes the document content. Mutually exclusive with content_archive_base64. | |
| coi_statement | No | Conflict-of-interest statement. | |
| dataset_links | No | Datasets, e.g. [{ name, url? }]. | |
| embargo_until | No | ISO-8601 timestamp; the document is embargoed until then. | |
| content_format | Yes | Content format | |
| benchmark_links | No | Benchmark-result references. | |
| arxiv_categories | No | arXiv subject categories. | |
| data_availability | No | Data-availability statement or status. | |
| related_identifiers | No | Related identifiers, e.g. [{ identifier_type, identifier_value, relation? }]. | |
| data_availability_url | No | URL to the dataset / data-availability record. | |
| content_archive_base64 | No | Base64-encoded ZIP archive (PK\x03\x04). Must contain main_file plus any attachments. Mutually exclusive with content_ref. Prefer content_ref (create_upload_url) above ~10 KB. |