# VisibleThread API API

> VisibleThread API API on Apizie: 12 endpoints (Get your list of dictionaries, Upload a dictionary (CSV), Get your list of documents, Upload a document, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/ai:visiblethread/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `ai:visiblethread`
- Category: Artificial Intelligence
- Status: byok
- Source: https://visiblethread.com
- Page: https://apizie.tech/api/ai/visiblethread
- OpenAPI: https://apizie.tech/api/ai/visiblethread/openapi.json

## 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…

## Endpoints

### Get your list of dictionaries
`GET https://apizie.tech/v1/ai:visiblethread/get-dictionaries` (byok)

### Upload a dictionary (CSV)
`POST https://apizie.tech/v1/ai:visiblethread/upload-dictionary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | Form fields as a JSON object |

### Get your list of documents
`GET https://apizie.tech/v1/ai:visiblethread/get-documents` (byok)

### Upload a document
`POST https://apizie.tech/v1/ai:visiblethread/upload-doc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | Form fields as a JSON object |

### Get data from a previously submitted document
`GET https://apizie.tech/v1/ai:visiblethread/get-doc-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| docId | integer | yes | Id of document to fetch |

### Get your list of searches
`GET https://apizie.tech/v1/ai:visiblethread/get-searches` (byok)

### Run a search
`POST https://apizie.tech/v1/ai:visiblethread/run-search` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Gets search results for a particular document/dictionary
`GET https://apizie.tech/v1/ai:visiblethread/get-search-results` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| docId | integer | yes | Id of document |
| dictionaryId | integer | yes | Id of dictionary |
| matchingOnly | boolean | yes | Only returning paragraphs containing a match |

### Get your list of scans
`GET https://apizie.tech/v1/ai:visiblethread/get-webscans` (byok)

### Run a new scan
`POST https://apizie.tech/v1/ai:visiblethread/run-scan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get data from a previously run scan
`GET https://apizie.tech/v1/ai:visiblethread/get-scan-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| scanId | integer | yes | Id of scan to fetch |

### Gets data for a particular scan/webUrl
`GET https://apizie.tech/v1/ai:visiblethread/get-scan-url-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| scanId | integer | yes | Id of scan |
| urlId | integer | yes | Id of url to fetch |

## Example
```
curl "https://apizie.tech/v1/ai:visiblethread/get-dictionaries" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the VisibleThread API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/ai:visiblethread/get-dictionaries with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the VisibleThread API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. VisibleThread API itself also needs your own key from visiblethread.com.

### Can AI agents use the VisibleThread API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key ai:visiblethread.

### What is the status of the VisibleThread API API?
Needs your own provider key (bring your own key)