canonical: https://jentic.com/apis/visiblethread.com/visiblethread-api

# VisibleThread API

Introduction The VisibleThread b API provides services for analyzing/searching documents and web pages. To use the service you need an API key. **Contact us at support@visiblethread.com to request an API key**. The services are split into **Documents** and **Webscans**. Documents Upload documents and dictionaries so you can : - Measure the readability of your document - search a document for all t. The API exposes 12 endpoints secured with apiKey authentication.

## For AI agents

Programmatically upload a dictionary (csv), get your list of dictionaries. Covers 12 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or developer tools - use for crm only.

## Capabilities

- Upload a dictionary (CSV)
- Get your list of dictionaries
- Run a search
- Query and filter VisibleThread API records by parameters
- Monitor VisibleThread API operational status and events

## Use cases

### CRM Operations

Use the VisibleThread API to perform crm operations programmatically. The API provides 12 endpoints covering core functionality including upload a dictionary (csv), get your list of dictionaries, upload a document.

Example prompt: Call POST /dictionaries to upload a dictionary (csv)

### Automated Documents Management

Automate documents operations by combining multiple VisibleThread API endpoints. Agents can get your list of dictionaries and then upload a document in a single workflow.

Example prompt: Call GET /dictionaries to get your list of dictionaries, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call VisibleThread API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'upload a dictionary (csv)', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/dictionaries` | Upload a dictionary (CSV) |
| GET | `/dictionaries` | Get your list of dictionaries |
| POST | `/documents` | Upload a document |
| GET | `/documents` | Get your list of documents |
| GET | `/documents/{docId}` | Get data from a previously submitted document |
| POST | `/searches` | Run a search |
| GET | `/searches` | Get your list of searches |
| GET | `/searches/{docId}/{dictionaryId}` | Gets search results for a particular document/dictionary |

## Key resources

- **Documents** — Operations related to Documents
- **Webscans** — Operations related to Webscans

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 61 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 93 / 100
  - Developer Experience & Jentic Compatibility: 67 / 100
  - AI-Readiness & Agent Experience: 38 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/visiblethread.com/visiblethread-api/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the VisibleThread API by hand means passing its apiKey header and coordinating its dictionary, document, and search calls yourself. Through Jentic you install once, import the VisibleThread API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** VisibleThread puts the document id in the URL path (`/documents/{docId}`), so a rule can pin your agent to one document and the operations around it. You choose the operations it may call, so it can read a document and its search results without being able to upload new dictionaries unless you add that.
- **Credential handling:** Your VisibleThread API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'upload a dictionary' or 'run a document search', and Jentic returns the matching VisibleThread operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Hubspot** — Alternative crm API
- **Salesforce** — Alternative crm API
- **Pipedrive** — Complementary crm API
- **Zoho** — Complementary crm API

## FAQ

### What authentication does the VisibleThread API use?

The VisibleThread API uses an API key passed in the `apiKey` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I upload a dictionary (csv) with the VisibleThread API?

Yes. Use the POST /dictionaries endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the VisibleThread API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I upload a dictionary (csv) through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'upload a dictionary (csv)'. Jentic returns the matching VisibleThread API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the VisibleThread API have?

The VisibleThread API exposes 12 endpoints covering documents, webscans operations.

### Can I limit what my agent is allowed to do with the VisibleThread API?

Yes. Jentic One is self-hosted, so you run it and your own rules decide which VisibleThread operations and credentials your agent may use. Because VisibleThread puts the document id in the URL path (GET `/documents/{docId}`), a rule can pin the agent to a single document and the calls around it, such as reading that document and its search results from GET `/searches/{docId}/{dictionaryId}.` You pick the operations it may call, so it can read documents and results without being able to upload new dictionaries via POST /dictionaries unless you allow that.