Venice API Docs: /chat/completions

POST

chat

completions

curl --request POST \
  --url https://api.venice.ai/api/v1/chat/completions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "frequency_penalty": 0,
  "logprobs": true,
  "max_completion_tokens": 123,
  "max_temp": 1.5,
  "max_tokens": 123,
  "messages": [
    {
      "content": "<string>",
      "role": "user"
    }
  ],
  "min_p": 0.05,
  "min_temp": 0.1,
  "model": "mistral-31-24b",
  "n": 1,
  "presence_penalty": 0,
  "repetition_penalty": 1.2,
  "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>",
  "venice_parameters": {
    "character_slug": "venice",
    "enable_web_search": "auto",
    "include_venice_system_prompt": 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": [
    {
      "function": {
        "description": "<string>",
        "name": "<string>",
        "parameters": {}
      },
      "id": "<string>",
      "type": "<string>"
    }
  ]
}'

{
  "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,
  "id": "chatcmpl-a81fbc2d81a7a083bb83ccf9f44c6e5e",
  "model": "qwen-2.5-vl",
  "object": "chat.completion",
  "prompt_logprobs": null,
  "usage": {
    "completion_tokens": 146,
    "prompt_tokens": 612,
    "prompt_tokens_details": null,
    "total_tokens": 758
  },
  "venice_parameters": {
    "include_venice_system_prompt": true,
    "web_search_citations": []
  }
}

Postman Collection

For additional examples, please see this Postman Collection.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Accept-Encoding

string

Supported compression encodings (gzip, br). Only applied when stream is false.

Example:

"gzip, br"

Body

application/json

messages

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. For compatibility purposes, the schema supports submitting multiple image_url messages, however, only the last image_url message will be passed to and processed by the model.

The user message is the input from the user. It is part of the conversation and is visible to the assistant.

model

string

required

The ID of the model you wish to prompt. May also be a model trait, or a 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:

"mistral-31-24b"

frequency_penalty

number

default:0

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 <= 2

logprobs

boolean

Whether to include log probabilities in the response. This is not supported by all models.

Example:

true

max_completion_tokens

integer

An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.

max_temp

number

Maximum temperature value for dynamic temperature scaling.

Required range: 0 <= x <= 2

Example:

1.5

max_tokens

integer

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. This value is now deprecated in favor of max_completion_tokens.

min_p

number

Sets a minimum probability threshold for token selection. Tokens with probabilities below this value are filtered out.

Required range: 0 <= x <= 1

Example:

0.05

min_temp

number

Minimum temperature value for dynamic temperature scaling.

Required range: 0 <= x <= 2

Example:

0.1

integer

default: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.

presence_penalty

number

default:0

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 <= 2

repetition_penalty

number

The parameter for repetition penalty. 1.0 means no penalty. Values > 1.0 discourage repetition.

Required range: x >= 0

Example:

1.2

seed

integer

The random seed used to generate the response. This is useful for reproducibility.

Required range: x > 0

Example:

42

stop

Up to 4 sequences where the API will stop generating further tokens. Defaults to null.

stop_token_ids

number[]

Array of token IDs where the API will stop generating further tokens.

Example:

[151643, 151645]

stream

boolean

Whether to stream back partial progress. Defaults to false.

Example:

true

stream_options

object

temperature

number

default:0.15

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 <= 2

Example:

0.7

top_k

integer

The number of highest probability vocabulary tokens to keep for top-k-filtering.

Required range: x >= 0

Example:

40

top_p

number

default:0.9

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 <= 1

Example:

0.9

user

string

This field is discarded on the request but is supported in the Venice API for compatibility with OpenAPI clients.

venice_parameters

object

Unique parameters to Venice's API implementation.

parallel_tool_calls

boolean

default:true

Whether to enable parallel function calling during tool use.

Example:

false

response_format

object

Format in which the response should be returned.

Example:

{
  "json_schema": {
    "properties": {
      "age": { "type": "number" },
      "name": { "type": "string" }
    },
    "required": ["name", "age"],
    "type": "object"
  },
  "type": "json_schema"
}

tool_choice

tools

object[] | null

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.

Response

200

application/json

choices

object[]

required

A list of chat completion choices. Can be more than one if n is greater than 1.

choices.finish_reason

enum<string>

required

The reason the completion finished.

Available options:

stop,

length

Example:

"stop"

choices.index

integer

required

The index of the choice in the list.

Example:

0

choices.logprobs

object | null

required

choices.logprobs.logprob

number

required

The log probability of this token

Example:

-0.34

choices.logprobs.token

string

required

The token string

Example:

"hello"

choices.logprobs.bytes

number[]

Raw bytes of the token

Example:

[104, 101, 108, 108, 111]

choices.logprobs.top_logprobs

object[]

Top tokens considered with their log probabilities

choices.message

object

required

The assistant message contains the response from the LLM.

choices.stop_reason

enum<string> | null

The reason the completion stopped.

Available options:

stop,

length

Example:

"stop"

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
  }
]

created

integer

required

The time at which the request was created.

Example:

1677858240

string

required

The ID of the request.

Example:

"chatcmpl-abc123"

model

string

required

The model id used for the request.

Example:

"mistral-31-24b"

object

enum<string>

required

The type of the object returned.

Available options:

chat.completion

Example:

"chat.completion"

usage

object

required

venice_parameters

object

required

venice_parameters.include_venice_system_prompt

boolean

required

Did the request include the Venice system prompt?

Example:

true

venice_parameters.web_search_citations

object[]

Citations from web search results.

Example:

[
  {
    "content": "Gases and particles in Earth&#x27;s atmosphere scatter sunlight in all directions. Blue light is scattered more than other colors because it travels as shorter, smaller waves. This is why we see a blue sky most of the time.",
    "date": "2020-12-15T00:00:00.000Z",
    "title": "Why Is the Sky Blue? | NOAA SciJinks – All About Weather",
    "url": "https://scijinks.gov/blue-sky/"
  },
  {
    "content": "1.1K votes, 162 comments. I’ve been trying to understand why the sky changes colors, and I think I understand most of it, but something in the online…",
    "date": "2025-01-22T12:24:13.000Z",
    "title": "r/askscience on Reddit: Why is the sky blue? Do I understand it correctly:",
    "url": "https://www.reddit.com/r/askscience/comments/14566ig/why_is_the_sky_blue_do_i_understand_it_correctly/"
  }
]

prompt_logprobs

Log probability information for the prompt.

Error Codes Model Feature Suffix

curl --request POST \
  --url https://api.venice.ai/api/v1/chat/completions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "frequency_penalty": 0,
  "logprobs": true,
  "max_completion_tokens": 123,
  "max_temp": 1.5,
  "max_tokens": 123,
  "messages": [
    {
      "content": "<string>",
      "role": "user"
    }
  ],
  "min_p": 0.05,
  "min_temp": 0.1,
  "model": "mistral-31-24b",
  "n": 1,
  "presence_penalty": 0,
  "repetition_penalty": 1.2,
  "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>",
  "venice_parameters": {
    "character_slug": "venice",
    "enable_web_search": "auto",
    "include_venice_system_prompt": 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": [
    {
      "function": {
        "description": "<string>",
        "name": "<string>",
        "parameters": {}
      },
      "id": "<string>",
      "type": "<string>"
    }
  ]
}'

{
  "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,
  "id": "chatcmpl-a81fbc2d81a7a083bb83ccf9f44c6e5e",
  "model": "qwen-2.5-vl",
  "object": "chat.completion",
  "prompt_logprobs": null,
  "usage": {
    "completion_tokens": 146,
    "prompt_tokens": 612,
    "prompt_tokens_details": null,
    "total_tokens": 758
  },
  "venice_parameters": {
    "include_venice_system_prompt": true,
    "web_search_citations": []
  }
}

Venice APIs

Chat Completions

Postman Collection

Authorizations

Headers

Body

Response

Venice APIs

​Postman Collection

Authorizations

Headers

Body

Response

Postman Collection