Chat
Chat Completions
Run text inference based on the supplied parameters. Supports multimodal inputs including text, images (image_url), audio (input_audio), video (video_url), and files (file) for compatible models. File inputs (PDF, DOCX, PPTX, XLSX, TXT, etc.) are automatically extracted to text before being sent to the model. Long running requests should use the streaming API by setting stream=true in your request.
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.
POST
/
chat
/
completions
/api/v1/chat/completions
curl --request POST \
--url https://api.venice.ai/api/v1/chat/completions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"messages": [
{
"content": "<string>",
"role": "user",
"name": "<string>"
}
],
"model": "zai-org-glm-5-1",
"frequency_penalty": 0,
"logprobs": true,
"top_logprobs": 1,
"max_completion_tokens": 123,
"max_temp": 1.5,
"max_tokens": 123,
"min_p": 0.05,
"min_temp": 0.1,
"n": 1,
"presence_penalty": 0,
"prompt_cache_key": "random-string",
"prompt_cache_retention": "24h",
"repetition_penalty": 1.2,
"reasoning": {
"effort": "medium",
"enabled": false,
"summary": "auto"
},
"reasoning_effort": "medium",
"seed": 42,
"stop": "<string>",
"stop_token_ids": [
151643,
151645
],
"stream": true,
"stream_options": {
"include_usage": true
},
"temperature": 0.7,
"top_k": 40,
"top_p": 0.9,
"user": "<string>",
"anon_user_id": "end-user-123",
"fallbacks": [
{
"model": "claude-opus-4-8"
}
],
"store": true,
"verbosity": "low",
"text": {
"verbosity": "low"
},
"include": [
"<string>"
],
"metadata": {},
"venice_parameters": {
"character_slug": "<string>",
"strip_thinking_response": false,
"disable_thinking": false,
"enable_e2ee": true,
"enable_web_search": "off",
"enable_web_scraping": false,
"enable_web_citations": false,
"include_search_results_in_stream": false,
"return_search_results_as_documents": true,
"include_venice_system_prompt": true,
"enable_x_search": true
},
"parallel_tool_calls": false,
"response_format": {
"json_schema": {
"properties": {
"age": {
"type": "number"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"age"
],
"type": "object"
},
"type": "json_schema"
},
"tool_choice": {
"function": {
"name": "<string>"
},
"type": "<string>"
},
"tools": [
{}
]
}
'import requests
url = "https://api.venice.ai/api/v1/chat/completions"
payload = {
"messages": [
{
"content": "<string>",
"role": "user",
"name": "<string>"
}
],
"model": "zai-org-glm-5-1",
"frequency_penalty": 0,
"logprobs": True,
"top_logprobs": 1,
"max_completion_tokens": 123,
"max_temp": 1.5,
"max_tokens": 123,
"min_p": 0.05,
"min_temp": 0.1,
"n": 1,
"presence_penalty": 0,
"prompt_cache_key": "random-string",
"prompt_cache_retention": "24h",
"repetition_penalty": 1.2,
"reasoning": {
"effort": "medium",
"enabled": False,
"summary": "auto"
},
"reasoning_effort": "medium",
"seed": 42,
"stop": "<string>",
"stop_token_ids": [151643, 151645],
"stream": True,
"stream_options": { "include_usage": True },
"temperature": 0.7,
"top_k": 40,
"top_p": 0.9,
"user": "<string>",
"anon_user_id": "end-user-123",
"fallbacks": [{ "model": "claude-opus-4-8" }],
"store": True,
"verbosity": "low",
"text": { "verbosity": "low" },
"include": ["<string>"],
"metadata": {},
"venice_parameters": {
"character_slug": "<string>",
"strip_thinking_response": False,
"disable_thinking": False,
"enable_e2ee": True,
"enable_web_search": "off",
"enable_web_scraping": False,
"enable_web_citations": False,
"include_search_results_in_stream": False,
"return_search_results_as_documents": True,
"include_venice_system_prompt": True,
"enable_x_search": True
},
"parallel_tool_calls": False,
"response_format": {
"json_schema": {
"properties": {
"age": { "type": "number" },
"name": { "type": "string" }
},
"required": ["name", "age"],
"type": "object"
},
"type": "json_schema"
},
"tool_choice": {
"function": { "name": "<string>" },
"type": "<string>"
},
"tools": [{}]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
messages: [{content: '<string>', role: 'user', name: '<string>'}],
model: 'zai-org-glm-5-1',
frequency_penalty: 0,
logprobs: true,
top_logprobs: 1,
max_completion_tokens: 123,
max_temp: 1.5,
max_tokens: 123,
min_p: 0.05,
min_temp: 0.1,
n: 1,
presence_penalty: 0,
prompt_cache_key: 'random-string',
prompt_cache_retention: '24h',
repetition_penalty: 1.2,
reasoning: {effort: 'medium', enabled: false, summary: 'auto'},
reasoning_effort: 'medium',
seed: 42,
stop: '<string>',
stop_token_ids: [151643, 151645],
stream: true,
stream_options: {include_usage: true},
temperature: 0.7,
top_k: 40,
top_p: 0.9,
user: '<string>',
anon_user_id: 'end-user-123',
fallbacks: [{model: 'claude-opus-4-8'}],
store: true,
verbosity: 'low',
text: {verbosity: 'low'},
include: ['<string>'],
metadata: {},
venice_parameters: {
character_slug: '<string>',
strip_thinking_response: false,
disable_thinking: false,
enable_e2ee: true,
enable_web_search: 'off',
enable_web_scraping: false,
enable_web_citations: false,
include_search_results_in_stream: false,
return_search_results_as_documents: true,
include_venice_system_prompt: true,
enable_x_search: true
},
parallel_tool_calls: false,
response_format: {
json_schema: {
properties: {age: {type: 'number'}, name: {type: 'string'}},
required: ['name', 'age'],
type: 'object'
},
type: 'json_schema'
},
tool_choice: {function: {name: '<string>'}, type: '<string>'},
tools: [{}]
})
};
fetch('https://api.venice.ai/api/v1/chat/completions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.venice.ai/api/v1/chat/completions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'messages' => [
[
'content' => '<string>',
'role' => 'user',
'name' => '<string>'
]
],
'model' => 'zai-org-glm-5-1',
'frequency_penalty' => 0,
'logprobs' => true,
'top_logprobs' => 1,
'max_completion_tokens' => 123,
'max_temp' => 1.5,
'max_tokens' => 123,
'min_p' => 0.05,
'min_temp' => 0.1,
'n' => 1,
'presence_penalty' => 0,
'prompt_cache_key' => 'random-string',
'prompt_cache_retention' => '24h',
'repetition_penalty' => 1.2,
'reasoning' => [
'effort' => 'medium',
'enabled' => false,
'summary' => 'auto'
],
'reasoning_effort' => 'medium',
'seed' => 42,
'stop' => '<string>',
'stop_token_ids' => [
151643,
151645
],
'stream' => true,
'stream_options' => [
'include_usage' => true
],
'temperature' => 0.7,
'top_k' => 40,
'top_p' => 0.9,
'user' => '<string>',
'anon_user_id' => 'end-user-123',
'fallbacks' => [
[
'model' => 'claude-opus-4-8'
]
],
'store' => true,
'verbosity' => 'low',
'text' => [
'verbosity' => 'low'
],
'include' => [
'<string>'
],
'metadata' => [
],
'venice_parameters' => [
'character_slug' => '<string>',
'strip_thinking_response' => false,
'disable_thinking' => false,
'enable_e2ee' => true,
'enable_web_search' => 'off',
'enable_web_scraping' => false,
'enable_web_citations' => false,
'include_search_results_in_stream' => false,
'return_search_results_as_documents' => true,
'include_venice_system_prompt' => true,
'enable_x_search' => true
],
'parallel_tool_calls' => false,
'response_format' => [
'json_schema' => [
'properties' => [
'age' => [
'type' => 'number'
],
'name' => [
'type' => 'string'
]
],
'required' => [
'name',
'age'
],
'type' => 'object'
],
'type' => 'json_schema'
],
'tool_choice' => [
'function' => [
'name' => '<string>'
],
'type' => '<string>'
],
'tools' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.venice.ai/api/v1/chat/completions"
payload := strings.NewReader("{\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"role\": \"user\",\n \"name\": \"<string>\"\n }\n ],\n \"model\": \"zai-org-glm-5-1\",\n \"frequency_penalty\": 0,\n \"logprobs\": true,\n \"top_logprobs\": 1,\n \"max_completion_tokens\": 123,\n \"max_temp\": 1.5,\n \"max_tokens\": 123,\n \"min_p\": 0.05,\n \"min_temp\": 0.1,\n \"n\": 1,\n \"presence_penalty\": 0,\n \"prompt_cache_key\": \"random-string\",\n \"prompt_cache_retention\": \"24h\",\n \"repetition_penalty\": 1.2,\n \"reasoning\": {\n \"effort\": \"medium\",\n \"enabled\": false,\n \"summary\": \"auto\"\n },\n \"reasoning_effort\": \"medium\",\n \"seed\": 42,\n \"stop\": \"<string>\",\n \"stop_token_ids\": [\n 151643,\n 151645\n ],\n \"stream\": true,\n \"stream_options\": {\n \"include_usage\": true\n },\n \"temperature\": 0.7,\n \"top_k\": 40,\n \"top_p\": 0.9,\n \"user\": \"<string>\",\n \"anon_user_id\": \"end-user-123\",\n \"fallbacks\": [\n {\n \"model\": \"claude-opus-4-8\"\n }\n ],\n \"store\": true,\n \"verbosity\": \"low\",\n \"text\": {\n \"verbosity\": \"low\"\n },\n \"include\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"venice_parameters\": {\n \"character_slug\": \"<string>\",\n \"strip_thinking_response\": false,\n \"disable_thinking\": false,\n \"enable_e2ee\": true,\n \"enable_web_search\": \"off\",\n \"enable_web_scraping\": false,\n \"enable_web_citations\": false,\n \"include_search_results_in_stream\": false,\n \"return_search_results_as_documents\": true,\n \"include_venice_system_prompt\": true,\n \"enable_x_search\": true\n },\n \"parallel_tool_calls\": false,\n \"response_format\": {\n \"json_schema\": {\n \"properties\": {\n \"age\": {\n \"type\": \"number\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"age\"\n ],\n \"type\": \"object\"\n },\n \"type\": \"json_schema\"\n },\n \"tool_choice\": {\n \"function\": {\n \"name\": \"<string>\"\n },\n \"type\": \"<string>\"\n },\n \"tools\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.venice.ai/api/v1/chat/completions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"role\": \"user\",\n \"name\": \"<string>\"\n }\n ],\n \"model\": \"zai-org-glm-5-1\",\n \"frequency_penalty\": 0,\n \"logprobs\": true,\n \"top_logprobs\": 1,\n \"max_completion_tokens\": 123,\n \"max_temp\": 1.5,\n \"max_tokens\": 123,\n \"min_p\": 0.05,\n \"min_temp\": 0.1,\n \"n\": 1,\n \"presence_penalty\": 0,\n \"prompt_cache_key\": \"random-string\",\n \"prompt_cache_retention\": \"24h\",\n \"repetition_penalty\": 1.2,\n \"reasoning\": {\n \"effort\": \"medium\",\n \"enabled\": false,\n \"summary\": \"auto\"\n },\n \"reasoning_effort\": \"medium\",\n \"seed\": 42,\n \"stop\": \"<string>\",\n \"stop_token_ids\": [\n 151643,\n 151645\n ],\n \"stream\": true,\n \"stream_options\": {\n \"include_usage\": true\n },\n \"temperature\": 0.7,\n \"top_k\": 40,\n \"top_p\": 0.9,\n \"user\": \"<string>\",\n \"anon_user_id\": \"end-user-123\",\n \"fallbacks\": [\n {\n \"model\": \"claude-opus-4-8\"\n }\n ],\n \"store\": true,\n \"verbosity\": \"low\",\n \"text\": {\n \"verbosity\": \"low\"\n },\n \"include\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"venice_parameters\": {\n \"character_slug\": \"<string>\",\n \"strip_thinking_response\": false,\n \"disable_thinking\": false,\n \"enable_e2ee\": true,\n \"enable_web_search\": \"off\",\n \"enable_web_scraping\": false,\n \"enable_web_citations\": false,\n \"include_search_results_in_stream\": false,\n \"return_search_results_as_documents\": true,\n \"include_venice_system_prompt\": true,\n \"enable_x_search\": true\n },\n \"parallel_tool_calls\": false,\n \"response_format\": {\n \"json_schema\": {\n \"properties\": {\n \"age\": {\n \"type\": \"number\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"age\"\n ],\n \"type\": \"object\"\n },\n \"type\": \"json_schema\"\n },\n \"tool_choice\": {\n \"function\": {\n \"name\": \"<string>\"\n },\n \"type\": \"<string>\"\n },\n \"tools\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.venice.ai/api/v1/chat/completions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"role\": \"user\",\n \"name\": \"<string>\"\n }\n ],\n \"model\": \"zai-org-glm-5-1\",\n \"frequency_penalty\": 0,\n \"logprobs\": true,\n \"top_logprobs\": 1,\n \"max_completion_tokens\": 123,\n \"max_temp\": 1.5,\n \"max_tokens\": 123,\n \"min_p\": 0.05,\n \"min_temp\": 0.1,\n \"n\": 1,\n \"presence_penalty\": 0,\n \"prompt_cache_key\": \"random-string\",\n \"prompt_cache_retention\": \"24h\",\n \"repetition_penalty\": 1.2,\n \"reasoning\": {\n \"effort\": \"medium\",\n \"enabled\": false,\n \"summary\": \"auto\"\n },\n \"reasoning_effort\": \"medium\",\n \"seed\": 42,\n \"stop\": \"<string>\",\n \"stop_token_ids\": [\n 151643,\n 151645\n ],\n \"stream\": true,\n \"stream_options\": {\n \"include_usage\": true\n },\n \"temperature\": 0.7,\n \"top_k\": 40,\n \"top_p\": 0.9,\n \"user\": \"<string>\",\n \"anon_user_id\": \"end-user-123\",\n \"fallbacks\": [\n {\n \"model\": \"claude-opus-4-8\"\n }\n ],\n \"store\": true,\n \"verbosity\": \"low\",\n \"text\": {\n \"verbosity\": \"low\"\n },\n \"include\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"venice_parameters\": {\n \"character_slug\": \"<string>\",\n \"strip_thinking_response\": false,\n \"disable_thinking\": false,\n \"enable_e2ee\": true,\n \"enable_web_search\": \"off\",\n \"enable_web_scraping\": false,\n \"enable_web_citations\": false,\n \"include_search_results_in_stream\": false,\n \"return_search_results_as_documents\": true,\n \"include_venice_system_prompt\": true,\n \"enable_x_search\": true\n },\n \"parallel_tool_calls\": false,\n \"response_format\": {\n \"json_schema\": {\n \"properties\": {\n \"age\": {\n \"type\": \"number\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"age\"\n ],\n \"type\": \"object\"\n },\n \"type\": \"json_schema\"\n },\n \"tool_choice\": {\n \"function\": {\n \"name\": \"<string>\"\n },\n \"type\": \"<string>\"\n },\n \"tools\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"choices": [
{
"finish_reason": "stop",
"index": 0,
"logprobs": null,
"message": {
"content": "The sky appears blue because of the way Earth's atmosphere scatters sunlight. When sunlight reaches Earth's atmosphere, it is made up of various colors of the spectrum, but blue light waves are shorter and scatter more easily when they hit the gases and particles in the atmosphere. This scattering occurs in all directions, but from our perspective on the ground, it appears as a blue hue that dominates the sky's color. This phenomenon is known as Rayleigh scattering. During sunrise and sunset, the sunlight has to travel further through the atmosphere, which allows more time for the blue light to scatter away from our direct line of sight, leaving the longer wavelengths, such as red, yellow, and orange, to dominate the sky's color.",
"reasoning_content": null,
"role": "assistant",
"tool_calls": []
},
"stop_reason": null
}
],
"created": 1739928524,
"cost": {
"diem": 0,
"usd": 0.00042
},
"id": "chatcmpl-a81fbc2d81a7a083bb83ccf9f44c6e5e",
"model": "zai-org-glm-5-1",
"object": "chat.completion",
"prompt_logprobs": null,
"usage": {
"completion_tokens": 146,
"completion_tokens_details": null,
"prompt_tokens": 612,
"prompt_tokens_details": null,
"total_tokens": 758
},
"venice_parameters": {
"enable_e2ee": true,
"include_venice_system_prompt": true,
"include_search_results_in_stream": false,
"return_search_results_as_documents": false,
"web_search_citations": [],
"enable_web_search": "auto",
"enable_web_scraping": false,
"enable_web_citations": true,
"strip_thinking_response": true,
"disable_thinking": true,
"character_slug": "venice"
}
}{
"error": "<string>",
"details": {
"_errors": [],
"field": {
"_errors": [
"Field is required"
]
}
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "This API key is restricted to configured IP addresses, and this request's source IP is not allowed"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Venice-specific parameters live in
venice_parameters. This endpoint is OpenAI-compatible, but the venice_parameters object unlocks features that aren’t part of the standard OpenAI API — and many integrators miss them:- Web search & citations —
enable_web_search,enable_web_citations,enable_web_scraping - Character personas —
character_slug - System prompt control —
include_venice_system_prompt - Reasoning controls —
disable_thinking,strip_thinking_response - Privacy —
enable_e2ee
venice_parameters section below.Postman Collection
For additional examples, please see this Postman Collection.Authorizations
BearerAuthsiwx
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Supported compression encodings (gzip, br). Only applied when stream is false.
Example:
"gzip, br"
Body
application/json
messages
(User Message · object | Assistant Message · object | Tool Message · object | System Message · object | Developer Message · object)[]
required
A list of messages comprising the conversation so far. Depending on the model you use, different message types (modalities) are supported, like text and images. Non-multimodal models reject image content. For vision models that support multiple images (supportsMultipleImages), images are preserved across all messages in the conversation history. For single-image vision models, only the last image-containing message retains its images.
Minimum array length:
1The user message is the input from the user. It is part of the conversation and is visible to the assistant.
- User Message
- Assistant Message
- Tool Message
- System Message
- Developer Message
Show child attributes
Show child attributes
The ID of the model you wish to prompt. May also be a model trait, or a model compatibility mapping. See the models endpoint for a list of models available to you. You can use feature suffixes to enable features from the venice_parameters object. Please see "Model Feature Suffix" documentation for more details.
Example:
"zai-org-glm-5-1"
Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.
Required range:
-2 <= x <= 2Whether to include log probabilities in the response. This is not supported by all models.
Example:
true
The number of highest probability tokens to return for each token position.
Required range:
x >= 0Example:
1
An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.
Maximum temperature value for dynamic temperature scaling.
Required range:
0 <= x <= 2Example:
1.5
The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. Values of 0 or less are ignored and the model will use its default maximum. This value is now deprecated in favor of max_completion_tokens.
Sets a minimum probability threshold for token selection. Tokens with probabilities below this value are filtered out.
Required range:
0 <= x <= 1Example:
0.05
Minimum temperature value for dynamic temperature scaling.
Required range:
0 <= x <= 2Example:
0.1
How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs.
Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.
Required range:
-2 <= x <= 2When supplied, this field may be used to optimize conversation routing to improve cache performance and thus reduce latency.
Example:
"random-string"
OpenAI-compatible parameter to control prompt cache retention. "extended" or "24h" extends retention to 24 hours for supported models.
Available options:
default, extended, 24h Example:
"24h"
The parameter for repetition penalty. 1.0 means no penalty. Values > 1.0 discourage repetition.
Required range:
x >= 0Example:
1.2
Configuration for reasoning behavior on supported models.
Show child attributes
Show child attributes
OpenAI-compatible parameter to control reasoning effort level for supported models. Takes precedence over reasoning.effort if both are provided. Direct OpenAI models validate concrete levels against their reasoningEffortOptions; none and minimal may map to the minimum supported effort on mandatory-reasoning models, with reasoning tokens still billed.
Available options:
none, minimal, low, medium, high, xhigh, max Example:
"medium"
The random seed used to generate the response. This is useful for reproducibility.
Required range:
x > 0Example:
42
Up to 4 sequences where the API will stop generating further tokens. Defaults to null.
Array of token IDs where the API will stop generating further tokens.
Example:
[151643, 151645]
Whether to stream back partial progress. Defaults to false.
Example:
true
Show child attributes
Show child attributes
What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both.
Required range:
0 <= x <= 2Example:
0.7
The number of highest probability vocabulary tokens to keep for top-k-filtering.
Required range:
x >= 0Example:
40
An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.
Required range:
0 <= x <= 1Example:
0.9
This field is discarded on the request but is supported in the Venice API for compatibility with OpenAI clients. It is not an alias of anon_user_id.
Optional identifier for the API customer's end user. Combined with the Venice user id when attributing the request to upstream providers. Distinct from the discarded OpenAI user field. Must be printable ASCII and must not contain ||.
Required string length:
1 - 128Pattern:
^[\x20-\x7E]+$Example:
"end-user-123"
Anthropic beta parameter for Claude Fable 5 server-side refusal fallback. Forwarded only for direct Anthropic routes; ignored for other providers.
Maximum array length:
10Show child attributes
Show child attributes
Example:
[{ "model": "claude-opus-4-8" }]
This field is accepted for OpenAI compatibility but is not used by Venice.
Controls the verbosity of the text response. Currently supported values are low, medium, and high.
Available options:
low, medium, high, auto Example:
"low"
OpenAI-compatible text configuration parameter.
Show child attributes
Show child attributes
OpenAI-compatible parameter specifying additional data to include in the response.
OpenAI-compatible metadata parameter for request tracking.
Show child attributes
Show child attributes
Unique parameters to Venice's API implementation. Customize these to control the behavior of the model.
Show child attributes
Show child attributes
Whether to enable parallel function calling during tool use.
Example:
false
Format in which the response should be returned.
- json_schema
- json_object
- text
Show child attributes
Show child attributes
Example:
{
"json_schema": {
"properties": {
"age": { "type": "number" },
"name": { "type": "string" }
},
"required": ["name", "age"],
"type": "object"
},
"type": "json_schema"
}
Show child attributes
Show child attributes
A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for.
A tool that can be called by the model. Currently, only functions are supported as tools.
- Tool Call
- Tool Call
Show child attributes
Show child attributes
Response
OK
The time at which the request was created.
Example:
1677858240
The ID of the request.
Example:
"chatcmpl-abc123"
The model id used for the request.
Example:
"zai-org-glm-5-1"
The type of the object returned.
Available options:
chat.completion Example:
"chat.completion"
Show child attributes
Show child attributes
A list of chat completion choices. Can be more than one if n is greater than 1. Certain models may not return this field under certain conditions.
Show child attributes
Show child attributes
Example:
[
{
"finish_reason": "stop",
"index": 0,
"logprobs": null,
"message": {
"content": "The sky appears blue because of the way Earth's atmosphere scatters sunlight. When sunlight reaches Earth's atmosphere, it is made up of various colors of the spectrum, but blue light waves are shorter and scatter more easily when they hit the gases and particles in the atmosphere. This scattering occurs in all directions, but from our perspective on the ground, it appears as a blue hue that dominates the sky's color. This phenomenon is known as Rayleigh scattering. During sunrise and sunset, the sunlight has to travel further through the atmosphere, which allows more time for the blue light to scatter away from our direct line of sight, leaving the longer wavelengths, such as red, yellow, and orange, to dominate the sky's color.",
"reasoning_content": null,
"role": "assistant",
"tool_calls": []
},
"stop_reason": null
}
]
The request cost split by billing currency.
Show child attributes
Show child attributes
Log probability information for the prompt.
Unique parameters to Venice's API implementation.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
/api/v1/chat/completions
curl --request POST \
--url https://api.venice.ai/api/v1/chat/completions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"messages": [
{
"content": "<string>",
"role": "user",
"name": "<string>"
}
],
"model": "zai-org-glm-5-1",
"frequency_penalty": 0,
"logprobs": true,
"top_logprobs": 1,
"max_completion_tokens": 123,
"max_temp": 1.5,
"max_tokens": 123,
"min_p": 0.05,
"min_temp": 0.1,
"n": 1,
"presence_penalty": 0,
"prompt_cache_key": "random-string",
"prompt_cache_retention": "24h",
"repetition_penalty": 1.2,
"reasoning": {
"effort": "medium",
"enabled": false,
"summary": "auto"
},
"reasoning_effort": "medium",
"seed": 42,
"stop": "<string>",
"stop_token_ids": [
151643,
151645
],
"stream": true,
"stream_options": {
"include_usage": true
},
"temperature": 0.7,
"top_k": 40,
"top_p": 0.9,
"user": "<string>",
"anon_user_id": "end-user-123",
"fallbacks": [
{
"model": "claude-opus-4-8"
}
],
"store": true,
"verbosity": "low",
"text": {
"verbosity": "low"
},
"include": [
"<string>"
],
"metadata": {},
"venice_parameters": {
"character_slug": "<string>",
"strip_thinking_response": false,
"disable_thinking": false,
"enable_e2ee": true,
"enable_web_search": "off",
"enable_web_scraping": false,
"enable_web_citations": false,
"include_search_results_in_stream": false,
"return_search_results_as_documents": true,
"include_venice_system_prompt": true,
"enable_x_search": true
},
"parallel_tool_calls": false,
"response_format": {
"json_schema": {
"properties": {
"age": {
"type": "number"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"age"
],
"type": "object"
},
"type": "json_schema"
},
"tool_choice": {
"function": {
"name": "<string>"
},
"type": "<string>"
},
"tools": [
{}
]
}
'import requests
url = "https://api.venice.ai/api/v1/chat/completions"
payload = {
"messages": [
{
"content": "<string>",
"role": "user",
"name": "<string>"
}
],
"model": "zai-org-glm-5-1",
"frequency_penalty": 0,
"logprobs": True,
"top_logprobs": 1,
"max_completion_tokens": 123,
"max_temp": 1.5,
"max_tokens": 123,
"min_p": 0.05,
"min_temp": 0.1,
"n": 1,
"presence_penalty": 0,
"prompt_cache_key": "random-string",
"prompt_cache_retention": "24h",
"repetition_penalty": 1.2,
"reasoning": {
"effort": "medium",
"enabled": False,
"summary": "auto"
},
"reasoning_effort": "medium",
"seed": 42,
"stop": "<string>",
"stop_token_ids": [151643, 151645],
"stream": True,
"stream_options": { "include_usage": True },
"temperature": 0.7,
"top_k": 40,
"top_p": 0.9,
"user": "<string>",
"anon_user_id": "end-user-123",
"fallbacks": [{ "model": "claude-opus-4-8" }],
"store": True,
"verbosity": "low",
"text": { "verbosity": "low" },
"include": ["<string>"],
"metadata": {},
"venice_parameters": {
"character_slug": "<string>",
"strip_thinking_response": False,
"disable_thinking": False,
"enable_e2ee": True,
"enable_web_search": "off",
"enable_web_scraping": False,
"enable_web_citations": False,
"include_search_results_in_stream": False,
"return_search_results_as_documents": True,
"include_venice_system_prompt": True,
"enable_x_search": True
},
"parallel_tool_calls": False,
"response_format": {
"json_schema": {
"properties": {
"age": { "type": "number" },
"name": { "type": "string" }
},
"required": ["name", "age"],
"type": "object"
},
"type": "json_schema"
},
"tool_choice": {
"function": { "name": "<string>" },
"type": "<string>"
},
"tools": [{}]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
messages: [{content: '<string>', role: 'user', name: '<string>'}],
model: 'zai-org-glm-5-1',
frequency_penalty: 0,
logprobs: true,
top_logprobs: 1,
max_completion_tokens: 123,
max_temp: 1.5,
max_tokens: 123,
min_p: 0.05,
min_temp: 0.1,
n: 1,
presence_penalty: 0,
prompt_cache_key: 'random-string',
prompt_cache_retention: '24h',
repetition_penalty: 1.2,
reasoning: {effort: 'medium', enabled: false, summary: 'auto'},
reasoning_effort: 'medium',
seed: 42,
stop: '<string>',
stop_token_ids: [151643, 151645],
stream: true,
stream_options: {include_usage: true},
temperature: 0.7,
top_k: 40,
top_p: 0.9,
user: '<string>',
anon_user_id: 'end-user-123',
fallbacks: [{model: 'claude-opus-4-8'}],
store: true,
verbosity: 'low',
text: {verbosity: 'low'},
include: ['<string>'],
metadata: {},
venice_parameters: {
character_slug: '<string>',
strip_thinking_response: false,
disable_thinking: false,
enable_e2ee: true,
enable_web_search: 'off',
enable_web_scraping: false,
enable_web_citations: false,
include_search_results_in_stream: false,
return_search_results_as_documents: true,
include_venice_system_prompt: true,
enable_x_search: true
},
parallel_tool_calls: false,
response_format: {
json_schema: {
properties: {age: {type: 'number'}, name: {type: 'string'}},
required: ['name', 'age'],
type: 'object'
},
type: 'json_schema'
},
tool_choice: {function: {name: '<string>'}, type: '<string>'},
tools: [{}]
})
};
fetch('https://api.venice.ai/api/v1/chat/completions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.venice.ai/api/v1/chat/completions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'messages' => [
[
'content' => '<string>',
'role' => 'user',
'name' => '<string>'
]
],
'model' => 'zai-org-glm-5-1',
'frequency_penalty' => 0,
'logprobs' => true,
'top_logprobs' => 1,
'max_completion_tokens' => 123,
'max_temp' => 1.5,
'max_tokens' => 123,
'min_p' => 0.05,
'min_temp' => 0.1,
'n' => 1,
'presence_penalty' => 0,
'prompt_cache_key' => 'random-string',
'prompt_cache_retention' => '24h',
'repetition_penalty' => 1.2,
'reasoning' => [
'effort' => 'medium',
'enabled' => false,
'summary' => 'auto'
],
'reasoning_effort' => 'medium',
'seed' => 42,
'stop' => '<string>',
'stop_token_ids' => [
151643,
151645
],
'stream' => true,
'stream_options' => [
'include_usage' => true
],
'temperature' => 0.7,
'top_k' => 40,
'top_p' => 0.9,
'user' => '<string>',
'anon_user_id' => 'end-user-123',
'fallbacks' => [
[
'model' => 'claude-opus-4-8'
]
],
'store' => true,
'verbosity' => 'low',
'text' => [
'verbosity' => 'low'
],
'include' => [
'<string>'
],
'metadata' => [
],
'venice_parameters' => [
'character_slug' => '<string>',
'strip_thinking_response' => false,
'disable_thinking' => false,
'enable_e2ee' => true,
'enable_web_search' => 'off',
'enable_web_scraping' => false,
'enable_web_citations' => false,
'include_search_results_in_stream' => false,
'return_search_results_as_documents' => true,
'include_venice_system_prompt' => true,
'enable_x_search' => true
],
'parallel_tool_calls' => false,
'response_format' => [
'json_schema' => [
'properties' => [
'age' => [
'type' => 'number'
],
'name' => [
'type' => 'string'
]
],
'required' => [
'name',
'age'
],
'type' => 'object'
],
'type' => 'json_schema'
],
'tool_choice' => [
'function' => [
'name' => '<string>'
],
'type' => '<string>'
],
'tools' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.venice.ai/api/v1/chat/completions"
payload := strings.NewReader("{\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"role\": \"user\",\n \"name\": \"<string>\"\n }\n ],\n \"model\": \"zai-org-glm-5-1\",\n \"frequency_penalty\": 0,\n \"logprobs\": true,\n \"top_logprobs\": 1,\n \"max_completion_tokens\": 123,\n \"max_temp\": 1.5,\n \"max_tokens\": 123,\n \"min_p\": 0.05,\n \"min_temp\": 0.1,\n \"n\": 1,\n \"presence_penalty\": 0,\n \"prompt_cache_key\": \"random-string\",\n \"prompt_cache_retention\": \"24h\",\n \"repetition_penalty\": 1.2,\n \"reasoning\": {\n \"effort\": \"medium\",\n \"enabled\": false,\n \"summary\": \"auto\"\n },\n \"reasoning_effort\": \"medium\",\n \"seed\": 42,\n \"stop\": \"<string>\",\n \"stop_token_ids\": [\n 151643,\n 151645\n ],\n \"stream\": true,\n \"stream_options\": {\n \"include_usage\": true\n },\n \"temperature\": 0.7,\n \"top_k\": 40,\n \"top_p\": 0.9,\n \"user\": \"<string>\",\n \"anon_user_id\": \"end-user-123\",\n \"fallbacks\": [\n {\n \"model\": \"claude-opus-4-8\"\n }\n ],\n \"store\": true,\n \"verbosity\": \"low\",\n \"text\": {\n \"verbosity\": \"low\"\n },\n \"include\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"venice_parameters\": {\n \"character_slug\": \"<string>\",\n \"strip_thinking_response\": false,\n \"disable_thinking\": false,\n \"enable_e2ee\": true,\n \"enable_web_search\": \"off\",\n \"enable_web_scraping\": false,\n \"enable_web_citations\": false,\n \"include_search_results_in_stream\": false,\n \"return_search_results_as_documents\": true,\n \"include_venice_system_prompt\": true,\n \"enable_x_search\": true\n },\n \"parallel_tool_calls\": false,\n \"response_format\": {\n \"json_schema\": {\n \"properties\": {\n \"age\": {\n \"type\": \"number\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"age\"\n ],\n \"type\": \"object\"\n },\n \"type\": \"json_schema\"\n },\n \"tool_choice\": {\n \"function\": {\n \"name\": \"<string>\"\n },\n \"type\": \"<string>\"\n },\n \"tools\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.venice.ai/api/v1/chat/completions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"role\": \"user\",\n \"name\": \"<string>\"\n }\n ],\n \"model\": \"zai-org-glm-5-1\",\n \"frequency_penalty\": 0,\n \"logprobs\": true,\n \"top_logprobs\": 1,\n \"max_completion_tokens\": 123,\n \"max_temp\": 1.5,\n \"max_tokens\": 123,\n \"min_p\": 0.05,\n \"min_temp\": 0.1,\n \"n\": 1,\n \"presence_penalty\": 0,\n \"prompt_cache_key\": \"random-string\",\n \"prompt_cache_retention\": \"24h\",\n \"repetition_penalty\": 1.2,\n \"reasoning\": {\n \"effort\": \"medium\",\n \"enabled\": false,\n \"summary\": \"auto\"\n },\n \"reasoning_effort\": \"medium\",\n \"seed\": 42,\n \"stop\": \"<string>\",\n \"stop_token_ids\": [\n 151643,\n 151645\n ],\n \"stream\": true,\n \"stream_options\": {\n \"include_usage\": true\n },\n \"temperature\": 0.7,\n \"top_k\": 40,\n \"top_p\": 0.9,\n \"user\": \"<string>\",\n \"anon_user_id\": \"end-user-123\",\n \"fallbacks\": [\n {\n \"model\": \"claude-opus-4-8\"\n }\n ],\n \"store\": true,\n \"verbosity\": \"low\",\n \"text\": {\n \"verbosity\": \"low\"\n },\n \"include\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"venice_parameters\": {\n \"character_slug\": \"<string>\",\n \"strip_thinking_response\": false,\n \"disable_thinking\": false,\n \"enable_e2ee\": true,\n \"enable_web_search\": \"off\",\n \"enable_web_scraping\": false,\n \"enable_web_citations\": false,\n \"include_search_results_in_stream\": false,\n \"return_search_results_as_documents\": true,\n \"include_venice_system_prompt\": true,\n \"enable_x_search\": true\n },\n \"parallel_tool_calls\": false,\n \"response_format\": {\n \"json_schema\": {\n \"properties\": {\n \"age\": {\n \"type\": \"number\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"age\"\n ],\n \"type\": \"object\"\n },\n \"type\": \"json_schema\"\n },\n \"tool_choice\": {\n \"function\": {\n \"name\": \"<string>\"\n },\n \"type\": \"<string>\"\n },\n \"tools\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.venice.ai/api/v1/chat/completions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"role\": \"user\",\n \"name\": \"<string>\"\n }\n ],\n \"model\": \"zai-org-glm-5-1\",\n \"frequency_penalty\": 0,\n \"logprobs\": true,\n \"top_logprobs\": 1,\n \"max_completion_tokens\": 123,\n \"max_temp\": 1.5,\n \"max_tokens\": 123,\n \"min_p\": 0.05,\n \"min_temp\": 0.1,\n \"n\": 1,\n \"presence_penalty\": 0,\n \"prompt_cache_key\": \"random-string\",\n \"prompt_cache_retention\": \"24h\",\n \"repetition_penalty\": 1.2,\n \"reasoning\": {\n \"effort\": \"medium\",\n \"enabled\": false,\n \"summary\": \"auto\"\n },\n \"reasoning_effort\": \"medium\",\n \"seed\": 42,\n \"stop\": \"<string>\",\n \"stop_token_ids\": [\n 151643,\n 151645\n ],\n \"stream\": true,\n \"stream_options\": {\n \"include_usage\": true\n },\n \"temperature\": 0.7,\n \"top_k\": 40,\n \"top_p\": 0.9,\n \"user\": \"<string>\",\n \"anon_user_id\": \"end-user-123\",\n \"fallbacks\": [\n {\n \"model\": \"claude-opus-4-8\"\n }\n ],\n \"store\": true,\n \"verbosity\": \"low\",\n \"text\": {\n \"verbosity\": \"low\"\n },\n \"include\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"venice_parameters\": {\n \"character_slug\": \"<string>\",\n \"strip_thinking_response\": false,\n \"disable_thinking\": false,\n \"enable_e2ee\": true,\n \"enable_web_search\": \"off\",\n \"enable_web_scraping\": false,\n \"enable_web_citations\": false,\n \"include_search_results_in_stream\": false,\n \"return_search_results_as_documents\": true,\n \"include_venice_system_prompt\": true,\n \"enable_x_search\": true\n },\n \"parallel_tool_calls\": false,\n \"response_format\": {\n \"json_schema\": {\n \"properties\": {\n \"age\": {\n \"type\": \"number\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"age\"\n ],\n \"type\": \"object\"\n },\n \"type\": \"json_schema\"\n },\n \"tool_choice\": {\n \"function\": {\n \"name\": \"<string>\"\n },\n \"type\": \"<string>\"\n },\n \"tools\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"choices": [
{
"finish_reason": "stop",
"index": 0,
"logprobs": null,
"message": {
"content": "The sky appears blue because of the way Earth's atmosphere scatters sunlight. When sunlight reaches Earth's atmosphere, it is made up of various colors of the spectrum, but blue light waves are shorter and scatter more easily when they hit the gases and particles in the atmosphere. This scattering occurs in all directions, but from our perspective on the ground, it appears as a blue hue that dominates the sky's color. This phenomenon is known as Rayleigh scattering. During sunrise and sunset, the sunlight has to travel further through the atmosphere, which allows more time for the blue light to scatter away from our direct line of sight, leaving the longer wavelengths, such as red, yellow, and orange, to dominate the sky's color.",
"reasoning_content": null,
"role": "assistant",
"tool_calls": []
},
"stop_reason": null
}
],
"created": 1739928524,
"cost": {
"diem": 0,
"usd": 0.00042
},
"id": "chatcmpl-a81fbc2d81a7a083bb83ccf9f44c6e5e",
"model": "zai-org-glm-5-1",
"object": "chat.completion",
"prompt_logprobs": null,
"usage": {
"completion_tokens": 146,
"completion_tokens_details": null,
"prompt_tokens": 612,
"prompt_tokens_details": null,
"total_tokens": 758
},
"venice_parameters": {
"enable_e2ee": true,
"include_venice_system_prompt": true,
"include_search_results_in_stream": false,
"return_search_results_as_documents": false,
"web_search_citations": [],
"enable_web_search": "auto",
"enable_web_scraping": false,
"enable_web_citations": true,
"strip_thinking_response": true,
"disable_thinking": true,
"character_slug": "venice"
}
}{
"error": "<string>",
"details": {
"_errors": [],
"field": {
"_errors": [
"Field is required"
]
}
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "This API key is restricted to configured IP addresses, and this request's source IP is not allowed"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}