API Reference#
OpenAPI Schema#
The OpenAPI specification details the endpoints for NVIDIA NIM for VLMs:
/v1/models - List available models
/v1/health/ready - Health check
/v1/health/live - Service liveness check
/v1/chat/completions - OpenAI-compatible chat endpoint
API Examples#
Use the examples in this section to help you get started with using the API.
List Models#
cURL Request
Use the following command to list the available models.
curl -X 'GET' 'http://0.0.0.0:8000/v1/models'
Response
{
"object": "list",
"data": [
{
"id": "mistralai/mistral-large-3-675b-instruct-2512",
"object": "model",
"created": 1770352805,
"owned_by": "system",
"root": "mistralai/mistral-large-3-675b-instruct-2512",
"parent": null,
"max_model_len": 294912,
"permission": [
{
"id": "modelperm-0c8d032b941f466dbba38f3eebfda1e5",
"object": "model_permission",
"created": 1770352805,
"allow_create_engine": false,
"allow_sampling": true,
"allow_logprobs": true,
"allow_search_indices": false,
"allow_view": true,
"allow_fine_tuning": false,
"organization": "*",
"group": null,
"is_blocking": false
}
]
}
]
}
Check Health#
Use the following command to check server health.
cURL Request
curl -X 'GET' 'http://0.0.0.0:8000/v1/health/ready'
Response
{
"object": "health.response",
"message": "Service is ready."
}
Check Service Liveness#
Use the following command to check service liveness.
cURL Request
curl -X 'GET' 'http://0.0.0.0:8000/v1/health/live'
Response
{
"object": "readyhealth.response",
"message": "Service is live."
}
OpenAI Chat Completions#
Use the following command to query the OpenAI chat completions endpoint.
cURL Request
curl -X 'POST' \
'http://0.0.0.0:8000/v1/chat/completions' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"model": "mistralai/mistral-large-3-675b-instruct-2512",
"messages": [
{
"role":"user",
"content": [
{
"type": "image_url",
"image_url":
{
"url": "https://assets.ngc.nvidia.com/products/api-catalog/phi-3-5-vision/example1b.jpg"
}
},
{
"type": "text",
"text": "What is in this image?"
}
]
}
],
"max_tokens": 256,
"temperature": 0
}'
Response
{
"id": "chatcmpl-8a11f6b4d00c4287b655c34579d764f4",
"object": "chat.completion",
"created": 1770352991,
"model": "mistralai/mistral-large-3-675b-instruct-2512",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "The image depicts a serene landscape featuring a wooden boardwalk or pathway that extends straight into the distance. The boardwalk is flanked by tall, lush green grass on both sides, suggesting a wetland or marsh area. The sky above is mostly clear with some scattered, wispy clouds, and it appears to be either early morning or late afternoon based on the lighting. In the background, there are some trees and possibly distant structures or buildings, adding depth to the scene. The overall atmosphere is calm and picturesque.",
"refusal": null,
"annotations": null,
"audio": null,
"function_call": null,
"tool_calls": [],
"reasoning_content": null
},
"logprobs": null,
"finish_reason": "stop",
"stop_reason": null,
"token_ids": null
}
],
"service_tier": null,
"system_fingerprint": null,
"usage": {
"prompt_tokens": 579,
"total_tokens": 686,
"completion_tokens": 107,
"prompt_tokens_details": null
},
"prompt_logprobs": null,
"prompt_token_ids": null,
"kv_transfer_params": null
}