Request response from the model

post

https://ai.api.nvidia.com/v1/vlm/nvidia/neva-22b

Invokes inference using the model chat parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

messages

array of objects

required

length ≥ 1

A list of messages comprising the conversation so far. The roles of the messages must be alternating between user and assistant. The last input message should have role user or assistant. A message with the system role is optional, and must be the very first message if it is present.

Messages*

role

string

enum

required

The role of the message author.

Allowed:

content

string | array | null

Defaults to null

The contents of the message.

To pass media (only with role=user):

- Use content parts. Text is passed with type=text.

- Images are passed with type=image_url; set image_url.url to an image URL or a base64 data URI like data:image/{format};base64,{base64encodedimage}.

For system and assistant roles, the object list format is not supported.

name

length ≤ 64

The name of the author of this message. Cannot be used with role=system. May contain a-z, A-Z, 0-9, and underscores, with a maximum length of 64 characters.

temperature

number

0 to 1

Defaults to 0.2

The sampling temperature to use for text generation. The higher the temperature value is, the less deterministic the output text will be. It is not recommended to modify both temperature and top_p in the same call.

top_p

number

0 to 1

Defaults to 0.7

The top-p sampling mass used for text generation. The top-p value determines the probability mass that is sampled at sampling time. For example, if top_p = 0.2, only the most likely tokens (summing to 0.2 cumulative probability) will be sampled. It is not recommended to modify both temperature and top_p in the same call.

max_tokens

integer

1 to 1024

Defaults to 1024

The maximum number of tokens to generate in any given call. Note that the model is not aware of this value, and generation will simply stop at the number of tokens specified.

seed

0 to 18446744073709552000

If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result.

stream

boolean

Defaults to false

If set, partial message deltas will be sent. Tokens will be sent as data-only server-sent events (SSE) as they become available (JSON responses are prefixed by data: ), with the stream terminated by a data: [DONE] message.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/event-stream

200Invocation is fulfilled

202Result is pending. Client should poll using the requestId.

422Validation failed, provided entity could not be processed.

500The invocation ended with an error.