Venice API

https://docs.venice.ai/
Admin
Venice API allows developers to build AI applications with no data retention, permissionless access,...
Tokens:232,146
Snippets:2,120
Trust Score:9.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Quick Start x402 Client Usage

Source: https://docs.venice.ai/api-reference/endpoint/api_keys/rate_limits

A brief example showing how to initialize the VeniceClient, top up credits, and perform a chat request.

```javascript

import { VeniceClient } from '@venice-ai/x402-client'

const venice = new VeniceClient(process.env.WALLET_KEY)

await venice.topUp(10) // $10 USDC on a supported x402 rail

const res = await venice.chat({ model: 'zai-org-glm-5-1', messages: [{
role: 'user', content: 'Hello!' }] })
```

--------------------------------

### Install Aider

Source: https://docs.venice.ai/guides/integrations/aider

Use the official installer to set up Aider on your machine.

```bash
python -m pip install aider-install
aider-install
```

--------------------------------

### Install Dependencies with uv

Source: https://docs.venice.ai/guides/projects/private-research-agent

Install the required HTTP and parsing libraries using uv.

```bash
uv add httpx beautifulsoup4 python-dotenv
```

--------------------------------

### Initialize project and install dependencies

Source: https://docs.venice.ai/guides/projects/security-code-reviewer

Commands to create the project directory and install required packages using uv or pip.

```bash
mkdir venice-security-reviewer
cd venice-security-reviewer
uv init
uv add "openai>=1.54" "pydantic>=2.9" "typer>=0.12" "jinja2>=3.1" "python-dotenv>=1.0" "rich>=13.0"
```

```bash
python -m venv .venv
source .venv/bin/activate
pip install "openai>=1.54" "pydantic>=2.9" "typer>=0.12" "jinja2>=3.1" "python-dotenv>=1.0" "rich>=13.0"
```

--------------------------------

### Authentication Configuration Examples

Source: https://docs.venice.ai/api-reference/endpoint/image/edit

Examples of API key and x402 wallet authentication configuration settings.

```yaml
apiKey:
  header: 'Authorization: Bearer YOUR_API_KEY'
  getKey: https://venice.ai/settings/api
  docs: https://docs.venice.ai/api-reference
x402Wallet:
  header: SIGN-IN-WITH-X
  legacyHeader: X-Sign-In-With-X
  topUp: POST /api/v1/x402/top-up
  docs: https://docs.venice.ai/api-reference/endpoint/x402/top-up
```

--------------------------------

### Install Skills for OpenCode

Source: https://docs.venice.ai/guides/integrations/venice-skills

Commands to install skills globally for OpenCode.

```bash
git clone https://github.com/veniceai/skills.git ~/src/venice-skills
ln -s ~/src/venice-skills/skills ~/.config/opencode/skills/venice
```

--------------------------------

### Install Kilo CLI

Source: https://docs.venice.ai/guides/integrations/kilo-code

Commands to install the Kilo CLI package globally and verify the installation.

```bash
npm install -g @kilocode/cli
kilo --version
```

--------------------------------

### Prompt Structure Example

Source: https://docs.venice.ai/guides/media/reference-to-video

A concrete example of a prompt following the recommended structure.

```text
@Element1 hops happily across the candy ground of @Image1, stops to look at a
giant lollipop, tilts its head curiously. Cinematic tracking shot, soft warm lighting.
```

--------------------------------

### Install Venice x402 Client

Source: https://docs.venice.ai/guides/integrations/crypto-rpc-agents

Install the required SDK package via npm.

```bash
npm install venice-x402-client
```

--------------------------------

### Clone and Install Dependencies

Source: https://docs.venice.ai/guides/integrations/nanoclaw-venice

Initializes the project environment by cloning the repository and installing required Node.js packages.

```bash
git clone https://github.com/lorenzovenice/nanoclaw-venice.git
cd nanoclaw-venice
npm install
```

--------------------------------

### Install OpenClaw

Source: https://docs.venice.ai/guides/integrations/openclaw-bot

Installation commands for different operating systems and package managers.

```bash
curl -fsSL https://openclaw.ai/install.sh | bash
```

```powershell
iwr -useb https://openclaw.ai/install.ps1 | iex
```

```bash
npm install -g openclaw@latest
```

--------------------------------

### Install Dependencies with pip

Source: https://docs.venice.ai/guides/projects/private-research-agent

Alternative installation method using a standard virtual environment and pip.

```bash
python -m venv .venv
source .venv/bin/activate
pip install "httpx>=0.28.0" "beautifulsoup4>=4.13.0" "python-dotenv>=1.0.0"
```

--------------------------------

### Install and build project dependencies

Source: https://docs.venice.ai/guides/integrations/venice-video-harness

Installs required Node.js packages and compiles the project.

```bash
npm install
npm run build
```

--------------------------------

### Input Audio Object Example

Source: https://docs.venice.ai/api-reference/endpoint/chat/completions

Example structure for providing base64-encoded audio input.

```yaml
input_audio:
  data: <base64-encoded-audio>
  format: wav
type: input_audio
```

--------------------------------

### Install Hermes Agent

Source: https://docs.venice.ai/guides/integrations/hermes-agent

Run the installation script for macOS, Linux, or WSL2 environments.

```bash
curl -fsSL https://raw.githubusercontent.com/NousResearch/hermes-agent/main/scripts/install.sh | bash
```

--------------------------------

### Install RAG dependencies

Source: https://docs.venice.ai/guides/projects/private-rag-bot

Install the required OpenAI SDK and Qdrant client with FastEmbed support via pip.

```bash
pip install "openai>=1.0.0" "qdrant-client[fastembed]>=1.14.1"
```

```text
openai>=1.0.0
qdrant-client[fastembed]>=1.14.1
```

--------------------------------

### Install Media Skills

Source: https://docs.venice.ai/guides/integrations/openclaw-bot

Install the Venice AI Media skill to enable image and video generation capabilities.

```bash
openclaw skills install nhannah/venice-ai-media
```

--------------------------------

### Install OpenAI SDK

Source: https://docs.venice.ai/getting-started/quick-start

Install the OpenAI SDK to interact with the Venice API, which is fully OpenAI-compatible.

```bash
pip install openai
```

```bash
npm install openai
```

--------------------------------

### Install LiveKit Agent Dependencies

Source: https://docs.venice.ai/guides/integrations/livekit-agents

Install the required LiveKit framework and plugins for OpenAI, Silero, and turn detection.

```bash
pip install \
  "livekit-agents[openai,silero,turn-detector]" \
  livekit-plugins-openai \
  livekit-plugins-silero
```

--------------------------------

### Install Venice AI SDK

Source: https://docs.venice.ai/api-reference/endpoint/audio/retrieve

Use the npm package manager to install the client library for interacting with the API.

```bash
npm install @venice-ai/x402-client
```

--------------------------------

### Retrieve Usage Analytics via cURL

Source: https://docs.venice.ai/api-reference/endpoint/billing/usage-analytics

Examples for fetching usage data over different timeframes using standard HTTP GET requests.

```bash
# Get usage analytics for the past 7 days (default)
curl -X GET "https://api.venice.ai/api/v1/billing/usage-analytics" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Get usage analytics for the past 30 days
curl -X GET "https://api.venice.ai/api/v1/billing/usage-analytics?lookback=30d" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Get usage analytics for a specific date range
curl -X GET "https://api.venice.ai/api/v1/billing/usage-analytics?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

--------------------------------

### Run Onboarding Wizard

Source: https://docs.venice.ai/guides/integrations/openclaw-bot

Initiate the interactive setup process to configure the Venice AI provider.

```bash
openclaw onboard
```

--------------------------------

### Create Configuration Directory and File

Source: https://docs.venice.ai/guides/integrations/claude-code

Prepare the configuration directory and open the config file for editing.

```bash
mkdir -p ~/.claude-code-router
```

```bash
# Using nano
nano ~/.claude-code-router/config.json

# Or using VS Code
code ~/.claude-code-router/config.json
```

--------------------------------

### Run Model Setup Wizard

Source: https://docs.venice.ai/guides/integrations/hermes-agent

Initiate the interactive model configuration wizard.

```bash
hermes model
```

--------------------------------

### Install Skills for Hermes Agent

Source: https://docs.venice.ai/guides/integrations/venice-skills

Commands to install skills using the built-in installer or via symlink.

```bash
hermes skills install veniceai/skills
```

```bash
git clone https://github.com/veniceai/skills.git ~/src/venice-skills
ln -s ~/src/venice-skills/skills ~/.hermes/skills/venice
```

--------------------------------

### Initialize Project with uv

Source: https://docs.venice.ai/guides/projects/private-research-agent

Create a new directory and initialize a project using the uv package manager.

```bash
mkdir venice-research-agent
cd venice-research-agent
uv init
```

--------------------------------

### Install and run Venice CLI

Source: https://docs.venice.ai/guides/integrations/venice-cli

Install the CLI globally using npm or execute it directly without installation.

```bash
npm install -g veniceai-cli
```

```bash
npx veniceai-cli chat 'Hello, world!'
```

--------------------------------

### Verify Setup with Prompt

Source: https://docs.venice.ai/guides/integrations/hermes-agent

Send a test prompt to verify the integration.

```text
Summarize this repo in 5 bullets and tell me what the main entrypoint is.
```

--------------------------------

### Install Skills for Cline

Source: https://docs.venice.ai/guides/integrations/venice-skills

Command to install skills locally for Cline.

```bash
git clone https://github.com/veniceai/skills.git .clinerules/skills-venice
```

--------------------------------

### Initialize Rust Project

Source: https://docs.venice.ai/guides/projects/rust-llm-gateway

Create a new Rust binary project and navigate into the directory.

```bash
cargo new llm-gateway
cd llm-gateway
```

--------------------------------

### Install Skills for Codex

Source: https://docs.venice.ai/guides/integrations/venice-skills

Commands to install skills globally for Codex.

```bash
git clone https://github.com/veniceai/skills.git ~/src/venice-skills
ln -s ~/src/venice-skills/skills ~/.codex/skills/venice
```

--------------------------------

### Start development server

Source: https://docs.venice.ai/guides/integrations/mastra

Launch the development server to test the agent in Mastra Studio.

```bash
npm run dev
```

--------------------------------

### Start Hermes Interface

Source: https://docs.venice.ai/guides/integrations/hermes-agent

Launch the classic CLI or the recommended TUI.

```bash
hermes            # classic CLI
hermes --tui      # modern TUI (recommended)
```

--------------------------------

### Text Content Object Example

Source: https://docs.venice.ai/api-reference/endpoint/chat/completions

Example of a text message content object.

```yaml
text: Why is the sky blue?
type: text
```

--------------------------------

### JSON-RPC Request Examples

Source: https://docs.venice.ai/api-reference/endpoint/crypto/rpc

Examples of single and batch JSON-RPC requests for the API.

```json
{
  "jsonrpc": "2.0",
  "method": "eth_chainId",
  "params": [],
  "id": 1
}
```

```json
[
  {
    "jsonrpc": "2.0",
    "method": "eth_chainId",
    "params": [],
    "id": 1
  },
  {
    "jsonrpc": "2.0",
    "method": "eth_blockNumber",
    "params": [],
    "id": 2
  }
]
```

--------------------------------

### Build X-402-Payment Header and Top-up (Bash)

Source: https://docs.venice.ai/guides/integrations/x402-venice-api

Creates a signed payment header for Base and executes the top-up request.

```bash
export EVM_PRIVATE_KEY=0xYOUR_PRIVATE_KEY
```

```bash
export X402_PAYMENT="$(
node --input-type=module <<'EOF'
import { createPaymentHeader } from "x402/client";
import { privateKeyToAccount } from "viem/accounts";

const signer = privateKeyToAccount(process.env.EVM_PRIVATE_KEY);
const amountUsd = 5;
const amountBaseUnits = String(Math.round(amountUsd * 1e6));

const header = await createPaymentHeader(signer, 2, {
  scheme: "exact",
  network: "base",
  maxAmountRequired: amountBaseUnits,
  resource: "https://api.venice.ai/api/v1/x402/top-up",
  description: "Venice x402 top-up",
  mimeType: "application/json",
  payTo: "0x2670B922ef37C7Df47158725C0CC407b5382293F",
  maxTimeoutSeconds: 300,
  asset: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
  extra: { name: "USD Coin", version: "2" },
});

process.stdout.write(header);
EOF
)"

curl -X POST "https://api.venice.ai/api/v1/x402/top-up" \
  -H "X-402-Payment: $X402_PAYMENT"
```

--------------------------------

### Speech Generation Request Example

Source: https://docs.venice.ai/api-reference/endpoint/audio/speech

Example payload for the speech generation endpoint.

```json
input: Hello, welcome to Venice Voice.
model: tts-xai-v1
response_format: mp3
speed: 1
streaming: false
voice: af_sky
```

--------------------------------

### Configure environment variables

Source: https://docs.venice.ai/guides/projects/security-code-reviewer

Example content for the .env file required for local development.

```bash
VENICE_API_KEY=your-venice-api-key-here
# Optional overrides
# VENICE_BASE_URL=https://api.venice.ai/api/v1
# VENICE_MODEL=zai-org-glm-5
```

--------------------------------

### Start Kilo CLI

Source: https://docs.venice.ai/guides/integrations/kilo-code

Command to initialize the Kilo agent within a project directory.

```bash
kilo
```

--------------------------------

### Initialize Venice and Qdrant Clients

Source: https://docs.venice.ai/guides/projects/private-rag-bot

Configures the OpenAI-compatible Venice client and the local Qdrant persistent storage client.

```python
venice = OpenAI(
    api_key=os.environ["VENICE_API_KEY"],
    base_url=VENICE_BASE_URL,
)
```

```python
qdrant = QdrantClient(path="./qdrant_data")
```

--------------------------------

### Install LlamaIndex dependencies

Source: https://docs.venice.ai/guides/integrations/llamaindex

Install the required LlamaIndex packages for OpenAI-compatible LLMs and embeddings.

```bash
pip install llama-index llama-index-llms-openai-like llama-index-embeddings-openai-like
```

```bash
uv add llama-index llama-index-llms-openai-like llama-index-embeddings-openai-like
```

--------------------------------

### Install LangChain Dependencies

Source: https://docs.venice.ai/guides/integrations/langchain

Install the necessary packages to use LangChain with OpenAI-compatible providers.

```bash
pip install langchain langchain-openai openai
```

--------------------------------

### Scan bundled demo applications

Source: https://docs.venice.ai/guides/projects/security-code-reviewer

Run the security reviewer against the provided example directories to test different reasoning capabilities.

```bash
uv run venice-security-reviewer scan examples/vulnerable_app
uv run venice-security-reviewer scan examples/csv_query
```

--------------------------------

### Install development dependencies

Source: https://docs.venice.ai/guides/projects/security-code-reviewer

Add the necessary testing and linting tools to the project environment.

```bash
uv add --dev "pytest>=8.3" "ruff>=0.7" "mypy>=1.13"
```

--------------------------------

### Install CrewAI dependencies

Source: https://docs.venice.ai/guides/integrations/crewai

Install the necessary packages to begin building multi-agent systems.

```bash
pip install crewai crewai-tools
```

--------------------------------

### Inpainting Prompt Example

Source: https://docs.venice.ai/guides/media/image-editing

An example of a descriptive prompt for broader scene changes in inpainting.

```text
Replace the background with a modern photo studio backdrop while preserving the subject pose, facial features, and clothing.
```

--------------------------------

### Run Setup Wizard

Source: https://docs.venice.ai/guides/integrations/nanoclaw-venice

Initiates the interactive configuration wizard within the Claude Code terminal.

```text
/setup
```

--------------------------------

### Cache TTL Example

Source: https://docs.venice.ai/api-reference/endpoint/chat/completions

Example value for the optional time-to-live setting in cache control.

```yaml
example: 1h
```

--------------------------------

### Run the RAG bot with sample documents

Source: https://docs.venice.ai/guides/projects/private-rag-bot

Executes the bot using built-in sample documents to verify the pipeline.

```bash
python rag_bot.py \
  --question "What does reranking improve in a RAG pipeline?"
```

--------------------------------

### Setup messaging gateway

Source: https://docs.venice.ai/guides/integrations/hermes-agent

Initiates the interactive setup process to connect messaging platforms like Telegram, Discord, and Slack.

```bash
hermes gateway setup
```

--------------------------------

### Cache Control Object Example

Source: https://docs.venice.ai/api-reference/endpoint/chat/completions

Example of the cache control configuration for prompt caching.

```yaml
type: ephemeral
```

--------------------------------

### Music Generation Pricing Examples

Source: https://docs.venice.ai/api-reference/endpoint/models/list

Examples of pricing fields for music generation models.

```yaml
example: 0.02
```

```yaml
example: 0.87
```

```yaml
example: 1
```

```yaml
example: 60
```

```yaml
example: 0.005
```
Tokens:
Raw