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