API Use Cases
Common TextMine integration patterns for ingestion, reporting, workflows, records, and agents.
Use Public API v3 when you need TextMine to participate in a larger system or agent workflow.
Document ingestion
Upload local files into Vault or import provider files from connected systems. Then poll document status, apply metadata, and route the result into reports, playbooks, records, or workflows.
Provider import
Use integrations endpoints to discover connected providers, list folders and files, and import selected files into Vault. This supports both provider-based import and TextMine-native upload paths.
Compliance and reporting
Generate reports from Vault documents and retrieve structured output. Reports are useful when an external process needs a repeatable answer rather than a chat-style summary.
Workflow automation
Create workflows for scheduled jobs, document events, email-triggered work, intake forms, or manual operations. Workflows can call agents, apply playbooks, create records, request approvals, publish to Legislate, and notify users.
Agent access
Use ReadMe MCP at https://developers.textmine.com/mcp when an agent client should discover docs, schemas, and generated API-reference tools. Use the hosted TextMine MCP endpoint at https://app.textmine.com/mcp when an agent should call TextMine product tools through MCP.
For direct REST integrations, use Public API V3 with Authorization: Bearer tm_your_api_key. If a platform owns the Authorization header, use X-TextMine-Api-Key: tm_your_api_key. Autonomous third-party agents can use Agent self-service signup to create a dedicated organization and encrypted service-account API key.
Agent-friendly docs should prefer operation IDs, typed examples, and discovery calls before mutations.