deepread-api

A reference for integrating the DeepRead document-processing API into software. An API is a set of web endpoints that applications use to exchange data.

In plain words
What is it for?
Use it to write integrations for document reading, data extraction, PDF form filling, and personal-information redaction. Examples are provided for Python, JavaScript, and cURL.
Why use it?
It saves time looking up authentication, request formats, responses, errors, webhooks, and supported examples. It covers the information needed to connect an application to DeepRead.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/deepread-tech/skills/deepread-api
Clone the repo
git clone --depth 1 https://github.com/deepread-tech/skills

Made for: Cursor.

Per session 37 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 5,891 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 1 finding. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00037 $0.05891
Opus 5 $0.00018 $0.02946
Sonnet 5 $0.00007 $0.01178
Haiku 4.5 $0.00004 $0.00589

Measured yesterday against content hash dc73bce70c99, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

deepread-api scanned grade A with 1 finding against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

curl -X POST https://api.deepread.tech/v1/process \
.cursor/rules/deepread-api.mdc · 694 lines

How it starts

The opening of the file, as written. The whole thing — 694 lines — stays where its author put it; the contents beside it link to each section on GitHub.

DeepRead API Reference

You are helping a developer integrate DeepRead into their application. You know the full API and can write working integration code in any language.

Base URL: https://api.deepread.tech Auth: X-API-Key header with key from https://www.deepread.tech/dashboard or via the device authorization flow (see Agent Authentication below)


Agent Authentication (Device Authorization Flow)

These endpoints let an AI agent obtain an API key without the user ever copy/pasting secrets. Based on OAuth 2.0 Device Authorization Grant (RFC 8628).

POST /v1/agent/device/code — Request a Device Code

Auth: None (public endpoint) Content-Type: application/json

{"agent_name": "my-agent"}
Parameter Type Required Description
agent_name string No Display name shown to the user during approval (e.g. "Claude Code", "My CI Bot"). Optional but strongly recommended — without it, the user sees "Unknown Agent".

Response (200 OK):

{
  "device_code": "a7f3c9d2e1b8...",
  "user_code": "HXKP-3MNV",
  "verification_uri": "https://www.deepread.tech/activate",
  "verification_uri_complete": "https://www.deepread.tech/activate?code=HXKP-3MNV",
  "expires_in": 900,
  "interval": 5
}
Field Description
device_code Secret code for polling — never show this to the user
user_code Short code the user enters in their browser (format: XXXX-XXXX)
verification_uri Base URL for manual code entry
verification_uri_complete URL with code pre-filled — open this to skip manual entry (preferred)
expires_in Seconds until the code expires (default: 900 = 15 minutes)
interval Minimum seconds between poll requests

POST /v1/agent/device/token — Poll for API Key

Auth: None (public endpoint) Content-Type: application/json

{"device_code": "a7f3c9d2e1b8..."}

Poll this endpoint every interval seconds after the user has been shown the code.

Read the full file on GitHub · 694 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 694 lines · 37 tokens per session scan A dc73bce70c99

Subscribe to this mod's changes

deepread-api is a cursor rule published in the GitHub repository deepread-tech/skills (4 stars, last pushed 1mo ago), licensed MIT. It adds 37 tokens to every session and 5,891 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 1 finding (makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.