- Public Zapier page: TextMine on Zapier
- Developer API docs: developers.textmine.com
- Service-account provisioning: Third-party agent signup
Choose a setup path
| Situation | What to do |
|---|---|
| New third-party agent or automation customer | Use third-party agent signup when available. Signup provisions an organization, service account, API key, billing account, and getting-started checklist. |
| Existing TextMine organization | Use the service-account API key and Public API base URL issued or shown by TextMine for that organization. |
| Service-account access is not enabled | Use Contact TextMine from the Zapier section in TextMine Settings, or ask an administrator to enable third-party access for the tenant. |
Find TextMine in Zapier
Open TextMine on Zapier, then choose TextMine when building or editing a Zap. TextMine Settings also links to the TextMine Zapier app directory page when service-account access is enabled. Use that route when users need to discover supported triggers, searches, actions, and popular app pairings.Discover signup availability
Before asking a new third-party agent to connect Zapier, check whether self-service signup is available:| Endpoint | Purpose |
|---|---|
https://public-api.textmine.com/.well-known/textmine-agent.json | Public discovery document for third-party agent signup, billing, API, and MCP metadata. |
https://public-api.textmine.com/v3/third-party-agents/signup/discovery | Public API V3 discovery document with the same setup metadata. |
https://public-api.textmine.com/v3/third-party-agents/signup/availability | Returns whether self-service signup is currently available and includes terms, privacy, pricing, and setup checklist metadata. |
POST https://public-api.textmine.com/v3/third-party-agents/signup/self-service with credentialDeliveryPublicKey. The response returns encryptedApiKey; decrypt it only inside the trusted runtime or support-managed credential setup, then enter the decrypted service-account API key in Zapier. Do not expose the raw key to model-visible prompts, logs, or shared documentation.
Find values in TextMine Settings
For existing TextMine organizations, open Settings and find the Zapier section. The Zapier section shows:| Value | What to use it for |
|---|---|
| Service account status | Confirms whether Zapier API access is enabled for the organization. |
| Public API V3 URL | Copy this into Zapier as the Public API Base URL. |
| Authentication | Confirms that the connection uses a TextMine service-account API key. |
Connect TextMine in Zapier
In Zapier, add or reconnect the TextMine app. Enter these fields:| Zapier field | Value |
|---|---|
| TextMine API Key | The decrypted service-account API key from third-party agent signup, or the key issued by TextMine provisioning. |
| Public API Base URL | The root Public API URL shown in TextMine Settings or issued during provisioning. Do not add /v3. Enter this manually; Zapier should not show preset tenant choices. |
https://public-api.textmine.com as the Public API Base URL. Do not enter https://app.textmine.com or the internal API host.
Zapier tests the connection by calling the Public API health endpoint with the API key. If the key or base URL does not match the service account’s environment, authentication fails.
Available Zapier capabilities
The current Zapier integration is aligned to Public API V3 and includes visible triggers for:| Trigger | Use it for |
|---|---|
| New Document | Start a Zap when a document is uploaded, imported, or processed in a TextMine Vault. |
| New or Updated Agent Task | Start a Zap when a TextMine agent task appears or changes status. |
| New Business Record | Start a Zap when extracted or validated business data appears in a record schema. |
| New Report | Start a Zap when a report appears in a TextMine Vault. |
| Search | Use it for |
|---|---|
| Find Document | Retrieve one document by ID. |
| Search Documents | Search documents by query, team, Vault, document type, status, or date. |
| Find Task | Retrieve one agent task by ID. |
| Find Business Record | Retrieve one business record by ID. |
| Search Business Records | Search records in a TextMine record schema. |
| Find Report | Retrieve one report by ID. |
| Action | Use it for |
|---|---|
| Import Document From Connected App | Import a file from Google Drive, Box, OneDrive, or SharePoint into TextMine document processing. |
| Update Document | Rename a document, change its document type, or queue reprocessing. |
| Reprocess Document | Queue processing for an existing document. |
| Create Agent Task | Create a TextMine agent task for document review, extraction, or follow-up work. |
| Add Task Message | Add a follow-up instruction or clarification to a task. |
| Start Task | Start or resume a draft or waiting task. |
| Cancel Task | Cancel a non-terminal task. |
| Decide Task Approval | Approve or reject a pending task approval. |
| Create Vault | Create a Vault for an existing team. |
| Create Record Schema | Create a business record schema. |
| Suggest Record Schema | Create a suggested record schema from a prompt or supplied definition. |
| Create Business Record | Create a business record. |
| Create or Replace Record Field Value | Create or replace a field value on a business record. |
| Generate AI Report | Generate a report from a prompt, documents, or a Vault. |
| Create Report Template | Create a custom report template. |
| Create Magic Workflow | Create an enabled Magic Workflow. |
| Create Agent | Create a TextMine Magic Agent. |
| Add Document Assignee | Add an assignee or reviewer to a document. |
Tenant and permission behavior
The Public API base URL is an auth/config field so different TextMine deployments can connect to the correct Public API host. Users should use the URL shown in TextMine Settings or issued by TextMine for their service account. Do not prefill this field, and do not present a tenant picker or tenant-name list in Zapier; the service-account API key scopes the connection to its organization. The service account API key controls the organization, permissions, Vault access, available records, workflows, and other resources. Entering another customer’s Public API host does not grant access to that customer’s data. Keep API keys environment-specific. Do not use a staging key against production, or a production key against another deployment.Popular Zap patterns
Common TextMine automations include:- Send new processed document metadata to Google Sheets.
- Notify Slack when an agent task needs review or approval.
- Update HubSpot, Salesforce, or Pipedrive when TextMine extracts validated business records.
- Generate a TextMine AI report from newly imported documents.
- Import files from a connected storage app into Vault processing.
Troubleshooting
If signup is unavailable:- Check
https://public-api.textmine.com/v3/third-party-agents/signup/availabilityfor the availability message. - Confirm third-party access is enabled for the tenant.
- Confirm self-service signup is enabled for the deployment.
- Contact TextMine if the tenant or deployment is not configured.
- Confirm the API key was decrypted from the signup response or issued by TextMine for the correct organization.
- Confirm the Public API Base URL is the root URL only, without
/v3or another path. - Confirm the key and Public API URL belong to the same TextMine environment.
- Confirm the key has been decrypted and stored exactly.
- Contact TextMine if the Settings page says setup is required or if the key has expired.