Agent Context Pack

TextMine Agent Context Pack

This page is the fuller companion to /llms.txt. ReadMe owns the root llms.txt route; this page provides a durable, human-maintained context pack for agents that need more detail.

Canonical URLs

Product model

TextMine is the overall platform.

Vault is the active document intelligence surface. Use Vault for upload, provider import, processing, document types, tags, metadata, search, reports, reprocessing, playbooks, workflows, agents, exports, and records.

Legislate is the validated archive. Documents can be published from Vault into Legislate after review. Use Legislate when the user asks about validated or published team documents.

Workbench is the in-app orchestration surface for exploratory work, file uploads, provider imports, and user-enabled MCP providers.

Workflows make repeatable work durable. Agents, reports, playbooks, records, integrations, approvals, emails, Scribe templates, and Legislate publication can be workflow actions.

API map

Use Public API v3 for new integrations. V2 is legacy.

Important v3 operation groups:

  • Vaults: listVaults, getVault, createVault, updateVault, deleteVault
  • Documents: listDocuments, createOrUploadDocument, importDocumentFromProvider, getDocument, updateDocument, reprocessDocument
  • Search: searchDocuments, searchDocumentsGet
  • Metadata and tags: listDocumentMetadata, getDocumentMetadataField, updateDocumentMetadataField, listDocumentTags, validateDocumentTag
  • Integrations: listIntegrationProviders, getIntegrationProviderStatus, listIntegrationFolders, listIntegrationFolderFiles, importDocumentFromProvider
  • Workflows: listWorkflowTriggers, listWorkflowConditions, listWorkflowActions, createWorkflow
  • Reports: generateReport, getReport, exportReportPdf, exportReportDocx
  • Agents: createAgent
  • Records: listRecordSchemas, createBusinessRecord, upsertBusinessRecordFieldValue

Safe execution policy

  • Discover first, mutate second.
  • Use operation IDs, not guessed paths.
  • Never invent IDs.
  • Poll asynchronous operations.
  • Keep bearer tokens out of prompts and shared files.
  • Ask for confirmation before destructive actions, provider disconnects, credential creation, enabled workflows, scheduled agents, or bulk imports.
  • Include citations/evidence when validating metadata or creating records.

Common task sequences

Provider import:

listIntegrationProviders -> getIntegrationProviderStatus -> listIntegrationFolders -> listIntegrationFolderFiles -> listVaults -> importDocumentFromProvider -> getDocument

Direct upload:

listVaults -> listDocumentTypes -> createOrUploadDocument -> getDocument -> listDocumentMetadata

Report:

listVaults -> listDocuments or searchDocuments -> generateReport -> getReport -> exportReportPdf or exportReportDocx

Workflow:

listTeamUsers -> listWorkflowTriggers -> listWorkflowConditions -> listWorkflowActions -> createWorkflow

Metadata validation:

listDocumentMetadata -> getDocumentMetadataField -> updateDocumentMetadataField

Client setup pages

User-facing context

For product behavior, workflows, screenshots, and feature names, prefer docs.textmine.com. For exact endpoint schemas, use this ReadMe developer hub.