Venice Augment (text parse / scrape / search)
Three lightweight helpers for agent pipelines that need document text, web pages, or search results without spinning up your own crawler.
| Endpoint |
Input |
Output |
Privacy |
POST /augment/text-parser |
multipart/form-data file (PDF / DOCX / XLSX / plain text, ≤ 25 MB) |
{ text, tokens } JSON or plain text |
In-memory only, zero retention |
POST /augment/scrape |
{ url } |
{ url, content (markdown), format: "markdown" } |
Zero retention |
POST /augment/search |
{ query, limit?, search_provider? } |
{ query, results: [{ title, url, content, date }] } |
Brave ZDR / Google anonymized; zero retention |
All three accept Bearer API key or SIWE (x402 wallet). All three are priced dynamically ($0.001–$10.00).
POST /augment/text-parser — extract text from documents
Request
Always multipart/form-data:
| Field |
Notes |
file |
Required. PDF, DOCX, XLSX, or plain text. Max 25 MB. |
response_format |
json (default) or text. |
curl -X POST https://api.venice.ai/api/v1/augment/text-parser \
-H "Authorization: Bearer $VENICE_API_KEY" \
-F "file=@./contract.pdf" \
-F "response_format=json"
Response
response_format=json:
{
"text": "…extracted plaintext…",
"tokens": 3821
}
response_format=text — raw plaintext body (Content-Type: text/plain).
Tips
tokens is the count of the extracted text — use it to pre-budget a downstream chat request.- Scanned image PDFs are not OCR'd. Run images through a vision model via
/chat/completions instead.
- Documents are processed in memory only and content is not retained after the response. (Operational metadata like request IDs and error traces may still be logged for debugging — this is a no-content-retention guarantee, not a zero-log guarantee.)
POST /augment/scrape — URL → markdown
Request
{ "url": "https://example.com/article" }
curl -X POST https://api.venice.ai/api/v1/augment/scrape \
-H "Authorization: Bearer $VENICE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com"}'
Response
{
"url": "https://example.com",
"content": "# Example Domain\n\nThis domain is for use in …",
"format": "markdown"
}
Tips
- Blocked sites — X/Twitter and Reddit reject automated access and return
400 immediately. Use enable_x_search or enable_web_search on /chat/completions for those.
- Some sites may return a partial body. Verify with the returned
content length before piping into a model.
- Use together with
/chat/completions: scrape → feed markdown into messages → summarize.
- For bulk scraping, issue requests in parallel; each is billed independently.
POST /augment/search — web search
Request
| Field |
Notes |
query |
1–400 chars. Required. |
limit |
1–20. Default 10. |
search_provider |
"brave" (default, ZDR) or "google" (anonymized). |
curl -X POST https://api.venice.ai/api/v1/augment/search \
-H "Authorization: Bearer $VENICE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "venice ai api pricing",
"limit": 5,
"search_provider": "brave"
}'
Response
{
"query": "venice ai api pricing",
"results": [
{
"title": "Pricing — Venice.ai",
"url": "https://venice.ai/pricing",
"content": "Venice offers per-token pricing …",
"date": "2026-04-10"
}
]
}
Providers
| Provider |
Retention |
Bias / filter |
brave (default) |
Zero Data Retention — Brave never stores queries. |
Safesearch defaults, Brave Index. |
google |
Anonymized — proxied through Venice so Google doesn't see you; Venice doesn't log queries. |
Google ranking. |
Tips
- Pair with
/chat/completions + venice_parameters.enable_web_citations to generate cited answers. See venice-chat.
- For "search + read" pipelines, feed
results[*].url into /augment/scrape in parallel.
query is validated as 1–400 chars. Anything longer is rejected (400 INVALID_REQUEST), not truncated.
Errors
| Status |
Cause |
400 |
Missing/oversized file, unsupported format, URL on a blocklist (X, Reddit), empty query, query > 400 chars. |
401 |
Missing/invalid Bearer or SIWE. |
402 |
Insufficient balance. x402 wallets receive the PAYMENT-REQUIRED header with base64 top-up instructions; Bearer users get INSUFFICIENT_BALANCE. |
403 |
Unauthorized access. |
429 |
Rate limit tripped. Back off with jitter. |
500 |
Upstream fetch / parse failure. Safe to retry. |
Response headers
X-Balance-Remaining — remaining x402 credit (x402 auth only).Content-Encoding — present when Accept-Encoding: gzip, br is sent (text-parser + scrape outputs compress well).
Patterns
- Document QA — Upload PDF via
/augment/text-parser, pass text into a /chat/completions system message, ask questions.
- Research agent —
/augment/search → parallel /augment/scrape → /chat/completions with all markdown bodies.
- Data extraction — XLSX via text-parser surfaces tab-delimited cell data you can then pipe to a model with
response_format: { type: "json_schema", ... }.
- Citation pipeline — Use
/augment/search to pick sources, then give the chat model venice_parameters.enable_web_citations: true for inline [n] marks.
1---2name: venice-augment3description: Venice augmentation endpoints for agent pipelines. Covers POST /augment/text-parser (extract text from PDF/DOCX/XLSX/plain text, multipart, up to 25MB, JSON or plain text response), POST /augment/scrape (fetch a URL and return markdown; blocks X/Reddit), and POST /augment/search (Brave ZDR or anonymized Google; structured title/url/content/date results, up to 20 per query). Privacy (zero data retention), rate limits, and error shapes.4---5
6# Venice Augment (text parse / scrape / search)
7
8Three lightweight helpers for agent pipelines that need document text, web pages, or search results without spinning up your own crawler.
9
10| Endpoint | Input | Output | Privacy |
11|---|---|---|---|
12| `POST /augment/text-parser` | `multipart/form-data` file (PDF / DOCX / XLSX / plain text, ≤ 25 MB) | `{ text, tokens }` JSON or plain text | In-memory only, zero retention |
13| `POST /augment/scrape` | `{ url }` | `{ url, content (markdown), format: "markdown" }` | Zero retention |
14| `POST /augment/search` | `{ query, limit?, search_provider? }` | `{ query, results: [{ title, url, content, date }] }` | Brave ZDR / Google anonymized; zero retention |
15
16All three accept **Bearer API key** or **SIWE** (x402 wallet). All three are priced dynamically (`$0.001–$10.00`).
17
18## `POST /augment/text-parser` — extract text from documents
19
20### Request
21
22Always `multipart/form-data`:
23
24| Field | Notes |
25|---|---|
26| `file` | Required. PDF, DOCX, XLSX, or plain text. Max **25 MB**. |
27| `response_format` | `json` (default) or `text`. |
28
29```bash
30curl -X POST https://api.venice.ai/api/v1/augment/text-parser \
31 -H "Authorization: Bearer $VENICE_API_KEY" \
32 -F "file=@./contract.pdf" \
33 -F "response_format=json"
34```
35
36### Response
37
38`response_format=json`:
39
40```json
41{
42 "text": "…extracted plaintext…",
43 "tokens": 3821
44}
45```
46
47`response_format=text` — raw plaintext body (`Content-Type: text/plain`).
48
49### Tips
50
51- `tokens` is the count of the extracted text — use it to pre-budget a downstream chat request.
52- Scanned image PDFs are not OCR'd. Run images through a vision model via `/chat/completions` instead.
53- Documents are processed **in memory only** and **content is not retained** after the response. (Operational metadata like request IDs and error traces may still be logged for debugging — this is a no-content-retention guarantee, not a zero-log guarantee.)
54
55## `POST /augment/scrape` — URL → markdown
56
57### Request
58
59```json
60{ "url": "https://example.com/article" }
61```
62
63```bash
64curl -X POST https://api.venice.ai/api/v1/augment/scrape \
65 -H "Authorization: Bearer $VENICE_API_KEY" \
66 -H "Content-Type: application/json" \
67 -d '{"url":"https://example.com"}'
68```
69
70### Response
71
72```json
73{
74 "url": "https://example.com",
75 "content": "# Example Domain\n\nThis domain is for use in …",
76 "format": "markdown"
77}
78```
79
80### Tips
81
82- **Blocked sites** — X/Twitter and Reddit reject automated access and return `400` immediately. Use `enable_x_search` or `enable_web_search` on `/chat/completions` for those.
83- Some sites may return a partial body. Verify with the returned `content` length before piping into a model.
84- Use together with `/chat/completions`: scrape → feed markdown into messages → summarize.
85- For bulk scraping, issue requests in parallel; each is billed independently.
86
87## `POST /augment/search` — web search
88
89### Request
90
91| Field | Notes |
92|---|---|
93| `query` | 1–400 chars. Required. |
94| `limit` | 1–20. Default `10`. |
95| `search_provider` | `"brave"` (default, ZDR) or `"google"` (anonymized). |
96
97```bash
98curl -X POST https://api.venice.ai/api/v1/augment/search \
99 -H "Authorization: Bearer $VENICE_API_KEY" \
100 -H "Content-Type: application/json" \
101 -d '{
102 "query": "venice ai api pricing",
103 "limit": 5,
104 "search_provider": "brave"
105 }'
106```
107
108### Response
109
110```json
111{
112 "query": "venice ai api pricing",
113 "results": [
114 {
115 "title": "Pricing — Venice.ai",
116 "url": "https://venice.ai/pricing",
117 "content": "Venice offers per-token pricing …",
118 "date": "2026-04-10"
119 }
120 ]
121}
122```
123
124### Providers
125
126| Provider | Retention | Bias / filter |
127|---|---|---|
128| `brave` (default) | Zero Data Retention — Brave never stores queries. | Safesearch defaults, Brave Index. |
129| `google` | Anonymized — proxied through Venice so Google doesn't see you; Venice doesn't log queries. | Google ranking. |
130
131### Tips
132
133- Pair with `/chat/completions` + `venice_parameters.enable_web_citations` to generate cited answers. See [`venice-chat`](../venice-chat/SKILL.md).
134- For "search + read" pipelines, feed `results[*].url` into `/augment/scrape` in parallel.
135- `query` is validated as 1–400 chars. Anything longer is **rejected** (400 `INVALID_REQUEST`), not truncated.
136
137## Errors
138
139| Status | Cause |
140|---|---|
141| `400` | Missing/oversized file, unsupported format, URL on a blocklist (X, Reddit), empty query, query > 400 chars. |
142| `401` | Missing/invalid Bearer or SIWE. |
143| `402` | Insufficient balance. x402 wallets receive the `PAYMENT-REQUIRED` header with base64 top-up instructions; Bearer users get `INSUFFICIENT_BALANCE`. |
144| `403` | Unauthorized access. |
145| `429` | Rate limit tripped. Back off with jitter. |
146| `500` | Upstream fetch / parse failure. Safe to retry. |
147
148## Response headers
149
150- `X-Balance-Remaining` — remaining x402 credit (x402 auth only).
151- `Content-Encoding` — present when `Accept-Encoding: gzip, br` is sent (text-parser + scrape outputs compress well).
152
153## Patterns
154
155- **Document QA** — Upload PDF via `/augment/text-parser`, pass `text` into a `/chat/completions` system message, ask questions.
156- **Research agent** — `/augment/search` → parallel `/augment/scrape` → `/chat/completions` with all markdown bodies.
157- **Data extraction** — XLSX via text-parser surfaces tab-delimited cell data you can then pipe to a model with `response_format: { type: "json_schema", ... }`.
158- **Citation pipeline** — Use `/augment/search` to pick sources, then give the chat model `venice_parameters.enable_web_citations: true` for inline `[n]` marks.
aibot88