Public API Quickstart

TextMine Public API v3 is the recommended API surface for new integrations and agent clients. It exposes the current TextMine model: Vault for document intelligence, Legislate for validated published documents, Workflows for repeatable automation, Integrations for provider imports, and Agents for long-running task work.

Base URL

For the current UK multitenant public environment, use:

https://public-api.textmine.com

Use the environment-specific Public API base URL returned by discovery or provided by TextMine for dedicated deployments. Endpoint paths start at /v3/...; do not append /api when configuring clients.

Authentication

Use bearer authentication on every live request:

Authorization: Bearer tm_your_api_key

Platforms that own the Authorization header can use the alternate API-key header:

X-TextMine-Api-Key: tm_your_api_key

Prefer the bearer header for direct Public API and MCP clients. Keep API keys user, integration, or service-account specific. Do not commit them to source control or paste real keys into shared docs, prompts, task transcripts, or model-visible context.

Existing customers can create or request keys through the access flow available for their organization. Autonomous third-party agents in the multitenant, non-enterprise deployment should use Agent self-service signup to create a dedicated organization and encrypted service-account API key.

First API path

1. Check the API is reachable with checkV3Health.
2. List accessible Vaults with listVaults.
3. Pick a Vault ID before uploading, importing, searching, reporting, or exporting documents.
4. Upload a local document with uploadDocument, or import a connected provider file with importDocumentFromProvider.
5. Poll the document or search endpoints until processing has finished.
6. Use reports, metadata, tags, workflows, agents, or exports depending on the job.

Common first calls

curl https://public-api.textmine.com/v3/health \
  -H "Authorization: Bearer tm_your_api_key"

curl https://public-api.textmine.com/v3/vaults \
  -H "Authorization: Bearer tm_your_api_key"

curl https://public-api.textmine.com/v3/integrations/providers \
  -H "Authorization: Bearer tm_your_api_key"

Agent self-service bootstrap

Agents that do not already have a TextMine key can discover and provision themselves through REST before using MCP:

• GET https://public-api.textmine.com/.well-known/textmine-agent.json
• GET https://public-api.textmine.com/v3/third-party-agents/signup/discovery
• GET https://public-api.textmine.com/v3/third-party-agents/signup/availability
• POST https://public-api.textmine.com/v3/third-party-agents/signup/self-service

The signup response creates a TextMine organization, service-account user, encrypted tm_... API key, and billing account. Decrypt the API key only in the trusted runtime, store it in a secret manager, then call Public API V3 or the hosted TextMine MCP endpoint with that key.

Agent-friendly sequence

When an agent is deciding what to do, start broad and then narrow:

• Use listVaults before any Vault-scoped action.
• Use listDocumentTypes, listTags, and metadata endpoints before changing document data.
• Use listIntegrationProviders, listIntegrationFolders, and listIntegrationFolderFiles before importing from Google Drive, SharePoint, Notion, or another connected provider.
• Use listWorkflowTriggers, listWorkflowConditions, and listWorkflowActions before creating a workflow.
• Use generateReport and then getReport to retrieve report output once the run is complete.

Where to go next

Read Core Concepts if you need the product model, ReadMe and TextMine MCP Quickstart if an LLM client will use MCP, For Agents for agent operating guidance, and the API Reference for exact schemas and operation IDs.