> ## Documentation Index
> Fetch the complete documentation index at: https://docs.venice.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Edit (aka Inpaint)
> Edit or modify an image based on the supplied prompt. The image can be provided either as a multipart form-data file upload or as a base64-encoded string in a JSON request. For models with resolution tiers that require explicit dimensions, omit aspect_ratio or set it to auto to infer the closest supported aspect ratio from the input image; provide aspect_ratio directly when exact output dimensions are required. Use output_format to request jpeg, jpg, png, or webp output.
**Authentication:** This endpoint accepts either a Bearer API key or a `SIGN-IN-WITH-X` header for x402 wallet-based authentication. The legacy `X-Sign-In-With-X` header is also accepted during migration. When using x402, a `402 Payment Required` response indicates insufficient balance and includes top-up instructions.
This is an experimental endpoint and may be subject to change.
**Pricing:** Image editing pricing varies by model. The default model (`qwen-edit`) is **\$0.04 per edit**. See the [Models endpoint](/api-reference/endpoint/models/list) for all available edit models and their pricing.
## Quality Tiers
Some edit models accept an optional `quality` parameter (`low`, `medium`, `high`) that trades visual fidelity for cost. Currently supported by `gpt-image-2-edit`; other models ignore the parameter.
```json theme={"system"}
{
"model": "gpt-image-2-edit",
"image": "iVBORw0KGgo...",
"prompt": "change the sky to a sunrise",
"resolution": "2K",
"quality": "medium"
}
```
When you omit `quality`, the model uses its default tier (`high` for `gpt-image-2-edit`). Per-tier prices (1K/2K/4K × low/medium/high) live under `model_spec.pricing.quality` in the [Models endpoint](/api-reference/endpoint/models/list) and are listed in the [Pricing overview](/overview/pricing).
Quality-aware pricing is the default for all API and SDK callers — no opt-in header required. Requests that omit `quality` are billed at the model's default tier (`high` for `gpt-image-2-edit`).
## Postman Collection
For additional examples, please see this [Postman Collection](https://www.postman.com/veniceai/workspace/venice-ai-workspace/folder/38652128-2d156cd6-a9bc-4586-8a8b-98e4b5c4435d?action=share\&source=copy-link\&creator=38652128\&ctx=documentation).
***
The default model (`qwen-edit`) blocks requests that try to generate explicit sexual imagery, sexualize minors, or depict real-world violence. Other models may have different content policies.
## OpenAPI
````yaml POST /image/edit
openapi: 3.0.0
info:
description: The Venice.ai API.
termsOfService: https://venice.ai/legal/tos
title: Venice.ai API
version: '20260626.184905'
x-guidance: >-
Venice.ai is an OpenAI-compatible inference API supporting text, image,
audio, and video generation.
**Authentication options:**
- API Key: Use Bearer token in Authorization header
- x402 Wallet: Use USDC credits via EVM or Solana wallet (no account
required)
**For x402 wallet access:**
1. POST /x402/top-up without headers to get payment requirements
2. Choose one of the returned Base or Solana payment options and sign a USDC
payment using the x402 SDK
3. POST /x402/top-up with PAYMENT-SIGNATURE header to add credits
4. Call any inference endpoint with SIGN-IN-WITH-X header
**Pricing:** Prepaid credits consumed per request. Check /models for
available models and their capabilities.
servers:
- url: https://api.venice.ai/api/v1
security:
- BearerAuth: []
tags:
- description: >-
Generate speech/audio, transcribe audio, and manage asynchronous audio
generation jobs.
name: Audio
- description: >-
Given a list of messages comprising a conversation, the model will return
a response. Supports multimodal inputs including text, images, audio
(input_audio), and video (video_url) for compatible models.
name: Chat
- description: List and describe the various models available in the API.
name: Models
- description: Generate and manipulate images using AI models.
name: Image
- description: Generate videos using AI models.
name: Video
- description: List and retrieve character information for use in completions.
name: Characters
- description: >-
Billing and usage analytics. **Beta**: This API is currently in beta and
may be unstable. Endpoints, request/response schemas, and behavior may
change without notice.
name: Billing
- description: Proxy JSON-RPC requests to blockchain nodes. Billed per credit.
name: Crypto RPC
- description: >-
Wallet-based API access using the x402 protocol. No API key required —
authenticate with an EVM or Solana wallet.
**How it works:**
1. **Authenticate** — Send a `SIGN-IN-WITH-X` header (base64-encoded
signed SIWX payload) with any request. EVM wallets sign an EIP-4361 SIWE
message; Solana wallets sign the Solana SIWX message with Ed25519. See the
`siwx` security scheme for the exact format.
2. **Top up** — `POST /x402/top-up` without a payment header returns an
`accepts` array with Base and Solana USDC payment options. Choose one
entry, sign it using the x402 SDK (`npm install x402`), and re-submit with
the `PAYMENT-SIGNATURE` header (the legacy `X-402-Payment` and `X-PAYMENT`
names are also accepted).
3. **Use any endpoint** — All inference endpoints (chat, image, audio,
video, embeddings) accept `siwx` as an alternative to `BearerAuth`.
Charges are deducted from your USDC credit balance.
4. **Monitor balance** — `GET /x402/balance/{walletAddress}` returns your
current balance. The `X-Balance-Remaining` response header on inference
calls also reports it.
**Quick start (5 lines):**
```
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!' }] })
```
**Payment:** USDC on Base (chain ID 8453) or Solana mainnet. Minimum
top-up: $5. Alternatively, stake DIEM tokens for daily credits (1 DIEM =
$1/day).
name: x402
externalDocs:
description: Venice.ai API documentation
url: https://docs.venice.ai
paths:
/image/edit:
post:
tags:
- Image
summary: /api/v1/image/edit
description: >-
Edit or modify an image based on the supplied prompt. The image can be
provided either as a multipart form-data file upload or as a
base64-encoded string in a JSON request. For models with resolution
tiers that require explicit dimensions, omit aspect_ratio or set it to
auto to infer the closest supported aspect ratio from the input image;
provide aspect_ratio directly when exact output dimensions are required.
Use output_format to request jpeg, jpg, png, or webp output.
**Authentication:** This endpoint accepts either a Bearer API key or a
`SIGN-IN-WITH-X` header for x402 wallet-based authentication. The legacy
`X-Sign-In-With-X` header is also accepted during migration. When using
x402, a `402 Payment Required` response indicates insufficient balance
and includes top-up instructions.
operationId: editImage
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/EditImageRequest'
- type: object
properties:
modelId:
type: string
enum:
- firered-image-edit
- qwen-edit-uncensored
- grok-imagine-edit
- grok-imagine-quality-edit
- qwen-image-2-edit
- qwen-image-2-pro-edit
- wan-2-7-pro-edit
- flux-2-max-edit
- gpt-image-2-edit
- gpt-image-1-5-edit
- nano-banana-2-edit
- nano-banana-pro-edit
- luma-uni-1-edit
- luma-uni-1-max-edit
- seedream-v5-lite-edit
- seedream-v4-edit
multipart/form-data:
schema:
allOf:
- $ref: '#/components/schemas/EditImageRequest'
- type: object
properties:
modelId:
type: string
enum:
- firered-image-edit
- qwen-edit-uncensored
- grok-imagine-edit
- grok-imagine-quality-edit
- qwen-image-2-edit
- qwen-image-2-pro-edit
- wan-2-7-pro-edit
- flux-2-max-edit
- gpt-image-2-edit
- gpt-image-1-5-edit
- nano-banana-2-edit
- nano-banana-pro-edit
- luma-uni-1-edit
- luma-uni-1-max-edit
- seedream-v5-lite-edit
- seedream-v4-edit
responses:
'200':
description: OK
headers:
X-Balance-Remaining:
description: >-
Remaining x402 credit balance in USD after this request (only
present for x402 auth).
required: false
schema:
type: string
example: '4.230000'
x-venice-is-content-violation:
description: >-
Indicates if the generated image does not meet Venice terms of
service.
required: false
schema:
type: boolean
x-venice-model-id:
description: The ID of the model used for the edit.
required: false
schema:
type: string
x-venice-model-name:
description: The friendly name of the model used for the edit.
required: false
schema:
type: string
x-venice-model-deprecation-warning:
description: A warning that the model is scheduled for deprecation
required: false
schema:
type: string
x-venice-model-deprecation-date:
description: The date the model is scheduled for deprecation
required: false
schema:
type: string
format: date-time
x-venice-deprecated:
description: >-
Present and set to "true" when the model is deprecated. Absent
otherwise.
required: false
schema:
type: string
enum:
- 'true'
x-venice-deprecated-replacement:
description: >-
Public API model ID clients should migrate to. Only present when
a replacement is published.
required: false
schema:
type: string
content:
image/png:
schema:
type: string
format: binary
image/jpeg:
schema:
type: string
format: binary
image/webp:
schema:
type: string
format: binary
'400':
description: Invalid request parameters
content:
application/json:
schema:
$ref: '#/components/schemas/DetailedError'
'401':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/StandardError'
'402':
description: >-
Payment or balance required. Response varies by authentication
state:
**API Key users:** Standard error response with
`INSUFFICIENT_BALANCE` code. Top up your Venice balance at
venice.ai.
**Unauthenticated x402 discovery:** Structured x402 response with
`x402Version`, `resource`, `accepts`, and
`extensions["sign-in-with-x"]`. The `accepts` array advertises Base
and Solana payment requirements.
**Authenticated x402 wallet users with insufficient credit:**
Structured response with `PAYMENT_REQUIRED` code containing:
- `topUpInstructions`: Step-by-step guide to top up via x402
protocol
- `supportedTokens` / `supportedChains`: Accepted payment methods
- `siwxChallenge`: Fresh Sign-In-With-X challenge metadata
The `PAYMENT-REQUIRED` header also contains a base64-encoded x402
protocol object with the payment requirements for programmatic
discovery.
headers:
PAYMENT-REQUIRED:
description: >-
Base64-encoded JSON with x402 payment requirements. Present on
x402 middleware 402 responses. Decode to choose and sign one
accepted payment requirement programmatically.
required: false
schema:
type: string
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/StandardError'
- $ref: '#/components/schemas/X402InferencePaymentRequired'
'415':
description: Invalid request content-type
content:
application/json:
schema:
$ref: '#/components/schemas/StandardError'
'429':
description: Rate limit exceeded
content:
application/json:
schema:
$ref: '#/components/schemas/StandardError'
'500':
description: Inference processing failed
content:
application/json:
schema:
$ref: '#/components/schemas/StandardError'
'503':
description: The model is at capacity. Please try again later.
content:
application/json:
schema:
$ref: '#/components/schemas/StandardError'
security:
- BearerAuth: []
- siwx: []
components:
schemas:
EditImageRequest:
type: object
properties:
aspect_ratio:
type: string
enum:
- auto
- '1:1'
- '3:2'
- '16:9'
- '21:9'
- '9:16'
- '2:3'
- '3:4'
- '4:5'
description: >-
The aspect ratio for the output image. Use 'auto' or omit this
parameter to infer the closest supported aspect ratio from the input
image when explicit sizing is required by the model. Supported
values vary by model - check GET /api/v1/models for model-specific
options.
example: '16:9'
resolution:
type: string
minLength: 1
maxLength: 10
description: >-
Resolution tier for the output image (e.g. "1K", "2K", "4K").
Supported values vary by model - check GET /api/v1/models for
model-specific options. Defaults to "1K" when not specified.
example: 1K
image:
anyOf:
- {}
- type: string
- type: string
format: uri
description: >-
The image to edit. Can be either a file upload, a base64-encoded
string, or a URL starting with http:// or https://. Image dimensions
must be at least 65536 pixels and must not exceed 33177600 pixels.
File size must be less than 25MB.
model:
type: string
minLength: 1
default: firered-image-edit
description: The model ID to use for image editing.
modelId:
type: string
minLength: 1
description: >-
Deprecated: Use "model" instead. The model ID to use for image
editing.
deprecated: true
output_format:
type: string
enum:
- jpeg
- png
- webp
description: >-
Output format for the edited image. Accepts jpeg, jpg, png, or webp.
When omitted, the format is inferred from resolution: PNG for 1K
edits and JPEG for 2K/4K edits.
example: png
prompt:
type: string
minLength: 1
maxLength: 32768
description: >-
The text directions to edit or modify the image. Short, descriptive
prompts work best (e.g., "remove the tree", "change the sky to
sunrise"). Character limit is model specific and is listed in the
promptCharacterLimit setting in the model list endpoint.
example: Change the color of the sky to a sunrise
safe_mode:
type: boolean
default: true
description: >-
Whether to use safe mode. If enabled, this will blur images that are
classified as having adult content.
example: false
required:
- image
- prompt
additionalProperties: false
description: Edit an image based on the supplied prompt.
example:
prompt: Colorize
image: iVBORw0KGgoAAAANSUhEUgAAAgAAAAIACAIAAAB7GkOtAAAAIGNIUk0A...
DetailedError:
type: object
properties:
details:
type: object
properties: {}
description: Details about the incorrect input
example:
_errors: []
field:
_errors:
- Field is required
error:
type: string
description: A description of the error
required:
- error
StandardError:
type: object
properties:
error:
type: string
description: A description of the error
required:
- error
X402InferencePaymentRequired:
anyOf:
- type: object
properties:
x402Version:
type: number
description: x402 protocol version.
example: 2
error:
type: string
description: Human-readable payment requirement message.
example: Payment required
resource:
type: object
properties:
url:
type: string
description: Protected resource URL.
example: https://api.venice.ai/api/v1/chat/completions
description:
type: string
description: Human-readable resource description.
example: Venice API
mimeType:
type: string
description: Resource MIME type.
example: application/json
required:
- url
- description
- mimeType
additionalProperties: false
accepts:
type: array
items:
type: object
properties:
scheme:
type: string
enum:
- exact
description: x402 payment scheme.
example: exact
network:
type: string
description: Payment network for this requirement.
example: solana
asset:
type: string
description: USDC token address or mint for the selected network.
example: EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v
amount:
type: string
description: >-
Required payment amount in base units (USDC has 6
decimals).
example: '10000000'
payTo:
type: string
description: Receiver wallet address for the selected network.
example: 8qUL23aSj7mDWdoLMXGHFvnVCT9wd7jXcysiekroADEL
maxTimeoutSeconds:
type: number
description: Maximum time allowed for payment settlement.
example: 300
extra:
type: object
properties: {}
description: >-
Network-specific x402 metadata. Solana requirements
include a feePayer.
example:
name: USD Coin
version: '2'
feePayer: BFK9TLC3edb13K6v4YyH3DwPb5DSUpkWvb7XnqCL9b4F
required:
- scheme
- network
- asset
- amount
- payTo
- maxTimeoutSeconds
- extra
additionalProperties: false
description: >-
Protocol payment requirements. Clients should choose one entry,
such as Base or Solana, and sign exactly that requirement.
extensions:
type: object
properties: {}
description: >-
Protocol extensions. Inference 402 responses include
`sign-in-with-x` with a SIWX challenge for wallet-credit
authentication.
authOptions:
type: object
properties:
apiKey:
type: object
properties:
header:
type: string
description: API key authentication header format.
example: 'Authorization: Bearer YOUR_API_KEY'
getKey:
type: string
description: Where to create or manage API keys.
example: https://venice.ai/settings/api
docs:
type: string
description: API key documentation URL.
example: https://docs.venice.ai/api-reference
required:
- header
- getKey
- docs
additionalProperties: false
x402Wallet:
type: object
properties:
header:
type: string
description: Header used for Sign-In-With-X wallet authentication.
example: SIGN-IN-WITH-X
legacyHeader:
type: string
description: Legacy Sign-In-With-X header accepted during migration.
example: X-Sign-In-With-X
topUp:
type: string
description: >-
Endpoint used to discover and submit x402 top-up
payments.
example: POST /api/v1/x402/top-up
docs:
type: string
description: x402 top-up API documentation URL.
example: >-
https://docs.venice.ai/api-reference/endpoint/x402/top-up
required:
- header
- legacyHeader
- topUp
- docs
additionalProperties: false
required:
- apiKey
- x402Wallet
additionalProperties: false
required:
- x402Version
- resource
- accepts
- authOptions
additionalProperties: false
description: >-
Returned when an inference request has no API key or wallet
authentication. The JSON body includes x402 discovery requirements
and authentication options.
- type: object
properties:
error:
type: string
enum:
- Payment required
description: Error message indicating payment is required.
code:
type: string
enum:
- PAYMENT_REQUIRED
description: Machine-readable error code.
reason:
type: string
enum:
- insufficient_balance
description: Reason the x402-authenticated request could not proceed.
message:
type: string
description: Human-readable context about the payment requirement.
example: Insufficient x402 balance
currentBalanceUsd:
type: number
description: Current x402 credit balance for the wallet.
example: 0.01
minimumBalanceUsd:
type: number
description: Minimum x402 credit balance required before the request can run.
example: 0.1
description:
type: string
description: Protected resource description.
example: Venice API
suggestedTopUpUsd:
type: number
description: Suggested amount to top up in USD.
example: 10
minimumTopUpUsd:
type: number
description: Minimum allowed top-up amount in USD.
example: 5
supportedTokens:
type: array
items:
type: string
description: List of supported token symbols for payment.
example:
- USDC
supportedChains:
type: array
items:
type: string
description: List of supported top-up rails.
example:
- base
- solana
topUpInstructions:
type: object
properties:
step1:
type: string
description: 'First step: get payment requirements.'
example: >-
POST /api/v1/x402/top-up with no payment header to get
payment requirements
step2:
type: string
description: 'Second step: sign the payment.'
example: >-
Choose a payment option from accepts and sign a USDC
transfer authorization using the x402 SDK
(createPaymentHeader)
step3:
type: string
description: 'Third step: submit the payment.'
example: >-
POST /api/v1/x402/top-up with the signed PAYMENT-SIGNATURE
header
receiverWallet:
type: string
description: >-
Legacy Base receiver wallet address. Prefer the selected
accepts entry from /x402/top-up for network-specific payTo
values.
example:
tokenAddress:
type: string
description: >-
Legacy Base USDC token address. Prefer the selected accepts
entry from /x402/top-up for network-specific assets.
example:
tokenDecimals:
type: number
description: Token decimal places.
example: 6
network:
type: string
description: >-
Legacy Base target network. Prefer the selected accepts
entry from /x402/top-up for network-specific values.
example: eip155:8453
minimumAmountUsd:
type: number
description: Minimum top-up amount in USD.
example: 5
required:
- step1
- step2
- step3
- receiverWallet
- tokenAddress
- tokenDecimals
- network
- minimumAmountUsd
additionalProperties: false
siwxChallenge:
type: object
properties:
info:
type: object
properties:
domain:
type: string
description: Domain for the SIWX challenge.
example: api.venice.ai
uri:
type: string
description: Resource URI for the challenge.
example: https://api.venice.ai/api/v1/chat/completions
version:
type: string
description: SIWX version.
example: '1'
nonce:
type: string
description: Unique nonce for replay protection.
example: '{{nonce}}'
issuedAt:
type: string
description: ISO timestamp when the challenge was issued.
example: '2026-04-09T12:00:00.000Z'
expirationTime:
type: string
description: ISO timestamp when the challenge expires.
example: '2026-04-09T12:05:00.000Z'
statement:
type: string
description: Human-readable statement for the signature.
example: Sign in to Venice AI
required:
- domain
- uri
- version
- nonce
- issuedAt
- expirationTime
- statement
additionalProperties: false
supportedChains:
type: array
items:
type: object
properties:
chainId:
type: string
description: Supported chain identity.
example: solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp
type:
type: string
enum:
- eip191
- eip1271
- ed25519
description: Signature type accepted for this chain.
example: ed25519
required:
- chainId
- type
additionalProperties: false
description: Supported SIWX chains and signature types.
required:
- info
- supportedChains
additionalProperties: false
required:
- error
- code
- reason
- suggestedTopUpUsd
- minimumTopUpUsd
- supportedTokens
- supportedChains
- topUpInstructions
- siwxChallenge
additionalProperties: false
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: http
siwx:
description: >-
Wallet-based authentication using the x402 protocol (Sign-In-With-X).
Supports EVM SIWE signatures on Base and Ed25519 signatures on Solana
mainnet.
**Header format:** Base64-encoded JSON object with the following fields:
- `address` — EVM or Solana wallet address
- `message` — Signed SIWX message. EVM wallets use EIP-4361 SIWE; Solana
wallets use the Solana SIWX message format.
- `signature` — Signature of the message, signed by the wallet's private
key. EVM signatures are hex; Solana signatures may be base58 or base64.
- `timestamp` — Unix timestamp in milliseconds
- `chainId` — Chain identity. Use `8453`, `"8453"`, or `"eip155:8453"`
for Base; use `"solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp"` for Solana.
- `type` — Optional signature type. Use `"ed25519"` for Solana. Omitted
means EVM/EIP-191 for backward compatibility.
**EVM SIWE message fields:**
- `domain`: `api.venice.ai`
- `uri`: `https://api.venice.ai`
- `version`: `"1"`
- `chainId`: `8453`
- `nonce`: Random 16-character hex string
- `issuedAt` / `expirationTime`: ISO timestamps (recommended TTL: 10
minutes)
- `statement`: `"Sign in to Venice API"`
**Example (TypeScript):**
```
import { Wallet } from 'ethers'
import { SiweMessage } from 'siwe'
const wallet = new Wallet(PRIVATE_KEY)
const msg = new SiweMessage({ domain: 'api.venice.ai', address:
wallet.address, statement: 'Sign in to Venice API', uri:
'https://api.venice.ai', version: '1', chainId: 8453, nonce:
crypto.randomUUID().replace(/-/g, '').slice(0, 16), issuedAt: new
Date().toISOString(), expirationTime: new Date(Date.now() +
600000).toISOString() })
const signature = await wallet.signMessage(msg.prepareMessage())
const header = btoa(JSON.stringify({ address: wallet.address, message:
msg.prepareMessage(), signature, timestamp: Date.now(), chainId: 8453
}))
// Set header: SIGN-IN-WITH-X:
```
**Solana message fields:** The signed message starts with `
wants you to sign in with your Solana account:`, followed by the wallet
address and the standard `URI`, `Version`, `Chain ID`, `Nonce`, `Issued
At`, and optional `Expiration Time` fields. Use `type: "ed25519"` and
`chainId: "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp"` in the encoded JSON
payload.
**SDK:** `npm install @venice-ai/x402-client` provides `VeniceClient`
and `createAuthFetch` which handle this automatically.
**Billing:** x402 users pay from a prepaid USDC credit balance. Top up
via `POST /x402/top-up`. When balance is insufficient, endpoints return
`402` with structured top-up instructions.
in: header
name: SIGN-IN-WITH-X
type: apiKey
````