Request response from the model

Invokes inference using the model chat parameters. If uploading large images or audios, this POST should be used in conjunction with the NVCF API which allows for the upload of large assets.
You can find details on how to use NVCF Asset APIs here: https://docs.api.nvidia.com/cloud-functions/reference/createasset

Body Params
messages
array of objects
required
length ≥ 1

A list of messages comprising the conversation so far.

Messages*
string
enum
required

The role of the message's author.

Allowed:
required

The contents of the message.

To pass images or audios (only with role=user):

- When content is a string, image or audio can be passed together with the text with HTML-style tags that wraps an image or audio URL (<img src="{url}" /> or <audio src="{url}" />), base64 encoded image or audio data (<img src="data:image/{format};base64,{base64encodedimage}" /> or <audio src="data:audio/{format};base64,{base64encodedaudio}" />), or an NVCF asset ID (<img src="data:image/{format};asset_id,{asset_id}" /> or <audio src="data:audio/{format};asset_id,{asset_id}" />) when the container is hosted in NVCF and the payload exceeds 200KB.
- When content is a list of objects, images can be passed as objects with type=image_url, and audios can be passed as objects with type=audio_url or input_audio.

- In both cases, images can be PNG, JPG or JPEG, and audios can be WAV or MP3.

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

string
required
Defaults to google/gemma-3n-e2b-it

The model to use.

-2 to 2

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.

1 to 8192

The maximum number of tokens that can be generated.

-2 to 2

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.

-9223372036854776000 to 9223372036854776000

Changing the seed will produce a different response with similar characteristics. Fixing the seed will reproduce the same results if all other parameters are also kept constant.

Sequences where the API will stop generating further tokens.

If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE]

0 to 2

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.

≤ 1

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. We generally recommend altering this or temperature but not both.

Headers
uuid
length ≤ 370

String of asset IDs separated by commas. Data is uploaded to AWS S3 using NVCF Asset APIs and associated with these asset IDs.If the size of an image or audio is more than 180KB, it needs to be uploaded to a presigned S3 URL bucket. The presigned URL allows for secure and temporary access to the S3 bucket for uploading the image or audio. Once the asset is requested, an asset ID is generated for it. Please include this asset ID in this header. Insert an uploaded image in a prompt using the following format: <img src="data:image/png;asset_id,{asset_id}" />. Insert an uploaded audio in a prompt using the following format: <audio src="data:audio/wav;asset_id,{asset_id}" />

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/event-stream
country_code