-
Notifications
You must be signed in to change notification settings - Fork 66
Expand file tree
/
Copy pathllms.txt
More file actions
183 lines (152 loc) · 18.1 KB
/
Copy pathllms.txt
File metadata and controls
183 lines (152 loc) · 18.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
# Venice API
> Venice is a privacy-first, uncensored AI API platform offering text generation, image generation, audio synthesis, video generation, music, embeddings, and developer tools (web search, document parsing, blockchain RPC) with zero data retention and OpenAI SDK compatibility.
Venice provides permissionless access to AI models with no content filtering, making it ideal for developers building applications that require uncensored outputs, privacy guarantees, and full control over AI interactions. The API is fully compatible with OpenAI's SDK—just change the base URL to `https://api.venice.ai/api/v1`. Venice also offers developer tools including web search, web scraping, document parsing, and blockchain RPC—see the **Tools** section below.
Venice offers four tiers of privacy: **Anonymized** (third-party models with identifying metadata stripped), **Private** (zero data retention, self-hosted open-source models), **TEE** (models running inside hardware-secured enclaves—Venice cannot access the computation), and **E2EE** (end-to-end encrypted models where prompts are encrypted client-side before being sent, and only the TEE can decrypt them).
**AI agents:** see [agents.md](https://docs.venice.ai/agents.md) for a token-optimized agent guide, [claude.md](https://docs.venice.ai/claude.md) for Claude-specific notes, and [skill.md](https://docs.venice.ai/skill.md) for an installable Agent Skill (`npx skills add docs.venice.ai`). Any docs page is available as raw Markdown by appending `.md` to its URL.
## Getting Started
- [Quick Start Guide](https://docs.venice.ai/overview/getting-started): Get your API key and make your first request in minutes
- [API Key Generation](https://docs.venice.ai/guides/getting-started/generating-api-key): Step-by-step guide to creating API keys
- [About Venice](https://docs.venice.ai/overview/about-venice): Overview of Venice's capabilities and OpenAI compatibility
## API Reference
### Text & Chat
- [API Specification](https://docs.venice.ai/api-reference/api-spec): Complete API specification with Venice-specific parameters
- [Chat Completions](https://docs.venice.ai/api-reference/endpoint/chat/completions): Text generation endpoint with streaming, vision, audio input, video input, and tool calling
- [Responses API (Alpha)](https://docs.venice.ai/api-reference/api-spec): OpenAI-compatible `POST /responses` endpoint with typed output blocks for reasoning, messages, function calls, and web search. Stateless, supports streaming via SSE, API key or x402 wallet auth. E2EE models not supported — use `/chat/completions` instead.
- [Model Feature Suffixes](https://docs.venice.ai/api-reference/endpoint/chat/model_feature_suffix): Enable features via model name suffixes (e.g., `model-name:web` for web search)
### Image
- [Image Generation](https://docs.venice.ai/api-reference/endpoint/image/generate): Create images from text prompts
- [Image Generations (OpenAI-compatible)](https://docs.venice.ai/api-reference/endpoint/image/generations): OpenAI-compatible image generation endpoint
- [Image Upscaling](https://docs.venice.ai/api-reference/endpoint/image/upscale): Enhance and upscale images
- [Image Editing](https://docs.venice.ai/api-reference/endpoint/image/edit): AI-powered image inpainting
- [Image Multi-Edit](https://docs.venice.ai/api-reference/endpoint/image/multi-edit): Combine and edit up to 3 images with layered inputs
- [Background Remove](https://docs.venice.ai/api-reference/endpoint/image/background-remove): Remove image backgrounds
- [Image Styles](https://docs.venice.ai/api-reference/endpoint/image/styles): List available image generation styles
### Audio
- [Text-to-Speech](https://docs.venice.ai/api-reference/endpoint/audio/speech): Convert text to audio with 50+ voices
- [Speech-to-Text](https://docs.venice.ai/api-reference/endpoint/audio/transcriptions): Transcribe audio to text with optional word-level timestamps
- [Music Generation (Queue)](https://docs.venice.ai/api-reference/endpoint/audio/queue): Queue music/sound effects generation
- [Music Generation (Retrieve)](https://docs.venice.ai/api-reference/endpoint/audio/retrieve): Retrieve generated audio by ID
- [Music Generation (Quote)](https://docs.venice.ai/api-reference/endpoint/audio/quote): Get price quote for audio generation
- [Music Generation (Complete)](https://docs.venice.ai/api-reference/endpoint/audio/complete): Queue and wait for audio generation in one call
### Video
- [Video Generation (Queue)](https://docs.venice.ai/api-reference/endpoint/video/queue): Queue video generation (text-to-video or image-to-video)
- [Video Generation (Retrieve)](https://docs.venice.ai/api-reference/endpoint/video/retrieve): Retrieve generated video by ID
- [Video Generation (Quote)](https://docs.venice.ai/api-reference/endpoint/video/quote): Get price quote for video generation
- [Video Generation (Complete)](https://docs.venice.ai/api-reference/endpoint/video/complete): Queue and wait for video generation in one call
- [Video Transcription](https://docs.venice.ai/api-reference/endpoint/video/transcriptions): Extract text/speech from videos
### Tools
- [Text Parser](https://docs.venice.ai/api-reference/endpoint/augment/text-parser): Extract text from PDF, DOCX, XLSX, and plain text files. Runs in-memory on Venice infrastructure with zero data retention ($0.01/request)
- [Web Scrape](https://docs.venice.ai/api-reference/endpoint/augment/scrape): Scrape a web page and return its content as markdown ($0.01/request)
- [Web Search](https://docs.venice.ai/api-reference/endpoint/augment/search): Search the web with privacy-preserving providers — Brave (ZDR, zero data retention) or Google (proxied through Venice so your identity is not associated with the search) ($0.01/request)
- [Crypto Networks](https://docs.venice.ai/api-reference/endpoint/crypto/networks): List all supported blockchain networks (public endpoint, no auth required)
- [Crypto RPC](https://docs.venice.ai/api-reference/endpoint/crypto/rpc): **Venice provides blockchain RPC access** — send JSON-RPC requests to Ethereum, Base, Arbitrum, Optimism, Polygon, Linea, Avalanche, BSC, Blast, zkSync Era, and Starknet (mainnet + testnets). One API key, unified billing in Venice credits. Supports batch requests (up to 100), idempotent retries, and x402 wallet auth. No separate RPC provider signup needed.
- [Crypto RPC Postman Collection](https://www.postman.com/veniceai/workspace/venice-ai-workspace/folder/38652128-2cf5a817-41cd-438b-ad37-5d07c3f13005?action=share&creator=48156591&active-environment=38652128-ef110f4e-d3e1-43b5-8029-4d6877e62041): 27 ready-to-run examples for crypto RPC calls
### Embeddings
- [Embeddings](https://docs.venice.ai/api-reference/endpoint/embeddings/generate): Generate vector embeddings for semantic search
### Models
- [List Models](https://docs.venice.ai/api-reference/endpoint/models/list): Get available models with capabilities and pricing
- [Model Traits](https://docs.venice.ai/api-reference/endpoint/models/traits): List model trait categories (e.g., `text:uncensored`, `image:fast`)
- [Compatibility Mapping](https://docs.venice.ai/api-reference/endpoint/models/compatibility_mapping): Map OpenAI model names to Venice equivalents
### Characters
- [List Characters](https://docs.venice.ai/api-reference/endpoint/characters/list): List available AI character personas
- [Get Character](https://docs.venice.ai/api-reference/endpoint/characters/get): Get details for a specific character
- [Character Reviews](https://docs.venice.ai/api-reference/endpoint/characters/reviews): Get reviews for a character
### API Keys
- [List API Keys](https://docs.venice.ai/api-reference/endpoint/api_keys/list): List your API keys
- [Get API Key](https://docs.venice.ai/api-reference/endpoint/api_keys/get): Get details for a specific API key
- [Create API Key](https://docs.venice.ai/api-reference/endpoint/api_keys/create): Create a new API key
- [Update API Key](https://docs.venice.ai/api-reference/endpoint/api_keys/update): Update an existing API key
- [Delete API Key](https://docs.venice.ai/api-reference/endpoint/api_keys/delete): Delete an API key
- [Generate Web3 Key](https://docs.venice.ai/api-reference/endpoint/api_keys/generate_web3_key/post): Generate API key via Web3 wallet signature
- [Rate Limits](https://docs.venice.ai/api-reference/endpoint/api_keys/rate_limits): Get rate limit configuration for an API key
- [Rate Limit Logs](https://docs.venice.ai/api-reference/endpoint/api_keys/rate_limit_logs): Get rate limit event logs
### Billing
- [Balance](https://docs.venice.ai/api-reference/endpoint/billing/balance): Get current account balance
- [Usage](https://docs.venice.ai/api-reference/endpoint/billing/usage): Get usage history
- [Usage Analytics](https://docs.venice.ai/api-reference/endpoint/billing/usage-analytics): Get detailed usage analytics
### x402 Wallet Authentication
- [x402 Balance](https://docs.venice.ai/api-reference/endpoint/x402/balance): Get wallet credit balance
- [x402 Top-Up](https://docs.venice.ai/api-reference/endpoint/x402/top-up): Add USDC credits via Ethereum wallet
- [x402 Transactions](https://docs.venice.ai/api-reference/endpoint/x402/transactions): Get wallet transaction history
### Reference
- [Rate Limiting](https://docs.venice.ai/api-reference/rate-limiting): Rate limits and best practices
- [Error Codes](https://docs.venice.ai/api-reference/error-codes): API error reference
## Models
- [Model Overview](https://docs.venice.ai/models/overview): Browse all available models
- [Text Models](https://docs.venice.ai/models/text): LLMs including venice-uncensored, GLM-4.7, Qwen3, Mistral, Llama, Grok, DeepSeek, Kimi
- [Image Models](https://docs.venice.ai/models/image): Diffusion models for image generation (Flux, Stable Diffusion)
- [Text-to-Speech Models](https://docs.venice.ai/models/text-to-speech): TTS models with multilingual voice support (Kokoro, Qwen 3 TTS)
- [Speech-to-Text Models](https://docs.venice.ai/models/speech-to-text): Audio transcription models (Whisper, Parakeet)
- [Music Models](https://docs.venice.ai/models/music): Music and sound effects generation with lyrics support
- [Video Models](https://docs.venice.ai/models/video): Text-to-video and image-to-video models
- [Embedding Models](https://docs.venice.ai/models/embeddings): Vector embedding models
## Guides
- [Guides Overview](https://docs.venice.ai/guides/overview): Index of all practical guides for building with the Venice API
- [Structured Responses](https://docs.venice.ai/guides/features/structured-responses): Get JSON responses with guaranteed schemas using `response_format`
- [Reasoning Models](https://docs.venice.ai/guides/features/reasoning-models): Use models with step-by-step reasoning (supports `reasoning_effort` parameter)
- [File Inputs](https://docs.venice.ai/guides/features/file-inputs): Attach PDF, Office, text, data, and source-code files directly to chat completions — Venice extracts them to text before inference
- [TEE & E2EE Models](https://docs.venice.ai/guides/features/tee-e2ee-models): Privacy-enhanced AI with Trusted Execution Environments (TEE) and End-to-End Encryption (E2EE)
- [Prompt Caching](https://docs.venice.ai/guides/features/prompt-caching): Reduce latency and costs with prompt caching
- [Image Generation Guide](https://docs.venice.ai/guides/media/image-generation): Best practices for image generation
- [Image Editing Guide](https://docs.venice.ai/guides/media/image-editing): Image editing and inpainting techniques
- [Video Generation Guide](https://docs.venice.ai/guides/media/video-generation): Video generation best practices
- [Reference to Video](https://docs.venice.ai/guides/media/reference-to-video): Lock in characters, objects, and scenes across AI video generations using reference images on Kling O3 and Grok Imagine R2V
- [Voice Cloning](https://docs.venice.ai/guides/media/voice-cloning): Clone a voice from a short reference sample with Chatterbox HD, then generate speech with Venice text-to-speech
- [Video Upscaling](https://docs.venice.ai/guides/media/video-upscaling): Enhance existing videos to higher resolution (2x/4x) or quality using the Topaz Video Upscale model
- [x402 Wallet API](https://docs.venice.ai/guides/integrations/x402-venice-api): Use Venice API with Ethereum wallet authentication (no API key required)
- [AI Agents](https://docs.venice.ai/guides/integrations/ai-agents): Build autonomous agents with Eliza framework
- [Autonomous Agent API Key Creation](https://docs.venice.ai/guides/getting-started/generating-api-key-agent): Let agents programmatically mint their own Venice API key by staking VVV on Base — no human interaction required
- [Crypto RPC for Agents](https://docs.venice.ai/guides/integrations/crypto-rpc-agents): Give AI agents inference and on-chain access through a single Venice credential. Covers JSON-RPC across 11 chains, x402 wallet auth, autonomous VVV staking, and DIEM-funded credits
- [Venice MCP Server](https://docs.venice.ai/guides/integrations/venice-mcp): Official Model Context Protocol server exposing the full Venice API as 31 tools for Claude Desktop, Cursor, LM Studio, and any MCP host
- [Venice Skills](https://docs.venice.ai/guides/integrations/venice-skills): Official Agent Skills that load Venice API knowledge into Claude Code, Cursor, Codex, OpenCode, Hermes, and Cline
- [Venice Video Harness](https://docs.venice.ai/guides/integrations/venice-video-harness): Agent-first toolkit for consistency-first AI video creation across 50+ Venice video, image, audio, and music models
- [LangChain](https://docs.venice.ai/guides/integrations/langchain): Use Venice with LangChain
- [LlamaIndex](https://docs.venice.ai/guides/integrations/llamaindex): Build RAG pipelines, agents, and query engines with Venice models via LlamaIndex's OpenAILike client
- [Vercel AI SDK](https://docs.venice.ai/guides/integrations/vercel-ai-sdk): Use Venice with Vercel AI SDK
- [CrewAI](https://docs.venice.ai/guides/integrations/crewai): Use Venice with CrewAI
- [OpenAI Migration](https://docs.venice.ai/guides/getting-started/openai-migration): Migrate from OpenAI to Venice
- [Claude Code](https://docs.venice.ai/guides/integrations/claude-code): Use Venice with Claude Code CLI
- [Cursor IDE](https://docs.venice.ai/guides/integrations/cursor): Use Venice with Cursor IDE
- [Codex CLI](https://docs.venice.ai/guides/integrations/codex-cli): Use Venice with OpenAI Codex CLI
- [OpenClaw](https://docs.venice.ai/guides/integrations/openclaw-bot): Self-hosted AI gateway connecting Venice to WhatsApp, Telegram, Discord, iMessage, and Slack
- [Hermes Agent](https://docs.venice.ai/guides/integrations/hermes-agent): Self-improving AI agent by Nous Research with persistent memory, skills, and 15+ messaging platforms, powered by Venice as a custom provider
- [NanoClaw](https://docs.venice.ai/guides/integrations/nanoclaw-venice): Lightweight self-hosted personal AI assistant for WhatsApp and Telegram powered by Venice
- [Integrations](https://docs.venice.ai/guides/integrations/integrations): Third-party integrations (Brave Leo, etc.)
- [Postman Collection](https://docs.venice.ai/guides/getting-started/postman): Import ready-to-use API examples
## Projects
- [Building a Private RAG Bot](https://docs.venice.ai/guides/projects/private-rag-bot): Modern private RAG with Venice embeddings, Qdrant vector search, FastEmbed re-ranking, and Venice chat completions
- [Building a Private Research Agent](https://docs.venice.ai/guides/projects/private-research-agent): Python research agent that plans searches, reads sources with Venice's scrape API, extracts evidence, and writes cited Markdown reports
- [Building a Codebase Security Reviewer](https://docs.venice.ai/guides/projects/security-code-reviewer): Python security agent that finds vulnerabilities and chains them into exploit paths using Venice, an AST repo map, and Pydantic guardrails
- [Building a Rust LLM Gateway](https://docs.venice.ai/guides/projects/rust-llm-gateway): OpenAI-compatible Rust gateway with Axum, Postgres-backed API keys, fixed-window rate limits, streaming responses, and OpenTelemetry
## Key Features
### Venice-Specific Parameters
The `venice_parameters` object in chat completions supports:
- `enable_web_search`: Enable real-time web search (`auto`, `on`, `off`)
- `enable_web_scraping`: Scrape URLs in user messages via Firecrawl
- `enable_web_citations`: Request inline citations in responses
- `enable_x_search`: Enable xAI native search (web + X/Twitter) for supported models
- `character_slug`: Use a Venice AI character persona
- `include_venice_system_prompt`: Include/exclude Venice's default system prompt
- `strip_thinking_response`: Remove `<think>` blocks from reasoning model responses
- `disable_thinking`: Disable thinking entirely on reasoning models
- `enable_e2ee`: Enable/disable E2EE on E2EE-capable models
### Multimodal Support
Chat completions support multiple input types on compatible models:
- **Text**: Standard text messages
- **Images**: Via `image_url` content type (URL or base64)
- **Audio**: Via `input_audio` content type (base64-encoded)
- **Video**: Via `video_url` content type (URL, YouTube links, or base64)
### Authentication Options
- **API Key**: Standard Bearer token authentication
- **x402 Wallet**: USDC credits via Ethereum wallet (no account required, pay-as-you-go)
## Optional
- [Pricing](https://docs.venice.ai/overview/pricing): Pay-as-you-go and DIEM staking options
- [VVV & DIEM](https://docs.venice.ai/overview/vvv-diem): Stake DIEM for $1/day API credit; mint DIEM from staked VVV on Base
- [Privacy Architecture](https://docs.venice.ai/overview/privacy): Zero data retention, TEE/E2EE encrypted models, and privacy guarantees
- [Deprecations](https://docs.venice.ai/overview/deprecations): Model deprecation notices
- [Beta Models](https://docs.venice.ai/overview/beta-models): Experimental models in beta
- [OpenAPI Spec](https://docs.venice.ai/swagger.yaml): Full OpenAPI/Swagger specification
- [Agent Guide (agents.md)](https://docs.venice.ai/agents.md): Token-optimized guide for AI agents using the Venice API
- [Claude Guide (claude.md)](https://docs.venice.ai/claude.md): Claude / Claude Code-specific notes for building against Venice
- [Agent Skill (skill.md)](https://docs.venice.ai/skill.md): Installable Agent Skill for the Venice API (`npx skills add docs.venice.ai`)
- [Full Docs Dump (llms-full.txt)](https://docs.venice.ai/llms-full.txt): Entire documentation in a single file for LLM ingestion