How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
NVIDIA Run:ai

NVIDIA Run:ai NVIDIA NIM API

The NVIDIA NIM API provides endpoints to create and manage workloads that deploy NVIDIA Inference Microservices (NIM) through the NIM Operator. These workloads package optimized NVIDIA model servers and run as managed services on the NVIDIA Run:ai platform.Each request includes NVIDIA Run:ai scheduling metadata (for example, project, priority, and category) and a NIM service specification that defines the container image, compute resources, environment variables, storage, and networking configuration. Once submitted, NVIDIA Run:ai handles scheduling, orchestration, and lifecycle management of the NIM service to ensure reliable and efficient model serving.

Documentation Provider Profile APIs.io OpenAPI GitHub

NVIDIA Run:ai NVIDIA NIM API is one of 62 APIs that NVIDIA Run:ai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include NVIDIA NIM. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 3 operations across 2 paths, and defines 85 schemas. It is described by OpenAPI 3.2.0, at version latest.

Requests are made against a single base URL, https://app.run.ai.

3 operations 2 paths 85 schemas 1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
latest
Base URL
https://app.run.ai
Authentication
HTTP Bearer
License
NVIDIA Run:ai
Resource Areas
1

Authentication & Security 1

NVIDIA Run:ai NVIDIA NIM API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer authentication

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

NVIDIA NIM 3

The NVIDIA NIM API provides endpoints to create and manage workloads that deploy NVIDIA Inference Microservices (NIM) through the NIM Operator.

POST
/api/v2/workloads/nim-services
Create a NVIDIA NIM service. [Experimental]
create_nim_service body → 202400401403409500503
GET
/api/v2/workloads/nim-services/{WorkloadV2Id}
Get a NVIDIA NIM service. [Experimental]
get_nim_service_by_id 1 param → 200401403404500503
PATCH
/api/v2/workloads/nim-services/{WorkloadV2Id}
Update NVIDIA NIM service spec. [Experimental]
update_nim_service_spec 1 param body → 202401403404500503

Schemas 85

The contract defines 85 schemas that model the data the API accepts and returns. The most detailed are WorkloadV2MetadataAutoFill (13 properties), EnvironmentVariable (8 properties), Toleration (7 properties), NimServiceServingPort (7 properties). Each schema is shown below with its type and property counts.

EnvironmentVariableSecret
objectnull
Details of the secret and key use to populate the environment variable
2 properties
PriorityClass
stringnull
Specifies the priority class for the workload, which determines its scheduling behavior. Valid values are: very-low, low, medium-low, medium, medium-high, high…
WorkloadId3
string
A unique ID of the workload.
DesiredPhase
string
The desired phase of the workload.
Tolerations
arraynull
Set of tolerations to apply to the workload.
AutoScalingMetricThreshold
integernull
The threshold to use with the specified metric for autoscaling (mandatory).
GpuRequestType
stringnull
Sets the unit type for GPU resources requests. Stated in terms of portion or memory. Sets the unit type for other GPU request fields. If gpuDevicesRequest 1, o…
ImagePullSecrets
arraynull
A list of references to Kubernetes secrets in the same namespace used for pulling container images.
Category
stringnull
Specify the workload category assigned to the workload. Categories are used to classify and monitor different types of workloads within the NVIDIA Run:ai platf…
NimCache
objectnull
The specification of a NIM cache volume.
2 properties
WorkloadV2MetadataResponse
object
5 properties 2 required
Image
stringnull
Docker image name. For more information, see [Images](https://kubernetes.io/docs/concepts/containers/images). The image name is mandatory for creating a worklo…
EnvironmentVariable
objectnull
Details of an environment variable which is populated into the container.
8 properties
NimServiceWorkers
integernull
Specifies the number of worker nodes to use when running the NIM service in multi-node.
ProbeHandler
objectnull
The action taken to determine the health of the container. (mandatory)
1 property
WorkloadV2MetadataAutoFill
object
13 properties 11 required
PvcAddedAttrValues
array
an optional array of key-values pairs that are written as annotations on the created PVC. the allowed attributes are determined according to the storage class…
DepartmentName1
string
The name of the department
NimServiceServingPort
objectnull
A port for accessing the inference service
7 properties
EnvironmentVariablePodFieldReference
objectnull
Details of the field-reference and key use to populate the environment variable
1 property
ComplianceIssuesV2
objectnull
1 property
Probe
objectnull
6 properties
NIMServiceMetadataCreateParams
object
3 properties 2 required
ImagePullSecret
objectnull
A reference to a secret in the same namespace used to pull container images.
3 properties
TolerationOperator
stringnull
A key's relationship to the value. Equal uses key and value. Exists is equivalent to wildcard for value, so that a workload can tolerate all taints of a partic…
CpuMemoryLimit
stringnull
Limitations on the CPU memory to allocate for this workload (1G, 20M, .etc). The system guarantees that this workload will not be able to consume more than thi…
ServingPortPort
integernull
The port that the container running the inference service exposes (mandatory).
EnvironmentVariableConfigMap
objectnull
Details of the configMap and key use to populate the environment variable
2 properties
ServingPortExposedUrl
stringnull
The custom URL to use for the serving port. If empty (default), an autogenerated URL will be used.
NodePools
arraynull
A prioritized list of node pools for the scheduler to run the workload on. The scheduler will always try to use the first node pool before moving to the next o…
CpuCoreRequest
numbernull
CPU units to allocate for the created workload (0.5, 1, .etc). The workload will receive at least this amount of CPU. Note that the workload will not be schedu…
NimServiceSpec
AutoScalingMinReplicas
integernull
The minimum number of replicas for autoscaling. Defaults to 1.
NimServiceResponse
object
3 properties 3 required
NimServiceCreateRequest
object
2 properties 2 required
GpuMemoryRequest
stringnull
Required if and only if gpuRequestType is memory. States the GPU memory to allocate for the created workload, per GPU device. Note that the workload will not b…
GVK
object
Specifies the Group, Version, and Kind (GVK) of the Kubernetes resource that defines the workload.
3 properties 3 required
SubmissionErrorV2
CpuMemoryRequest
stringnull
The amount of CPU memory to allocate for this workload (1G, 20M, .etc). The workload will receive at least this amount of memory. Note that the workload will n…
PvcClaimSize
stringnull
Requested size for the PVC. Mandatory when existingPvc is false. Recommended sizes: TB/GB/MB/TIB/GIB/MIB
NimServiceMultiNode
objectnull
Defines whether the NIM service runs as a multi-node deployment. If workers is set to 1 or more, the service runs in multi-node.
1 property
DepartmentId3
string
The id of the department.
ProbeHandlerScheme
stringnull
Scheme to use for connecting to the host, defaults to HTTP.
PvcVolumeMode
stringnull
Default volume mode for the PVC. Choose between Filesystem (default) or Block.
EnvironmentVariableUserCredential
objectnull
Defines a reference to a user-created credential and a specific key within that credential whose value will populate the environment variable. User credentials…
2 properties
CpuCoreLimit
numbernull
Limitations on the number of CPUs consumed by the workload (0.5, 1, .etc). The system guarantees that this workload will not be able to consume more than this…
ServingPortExposedProtocol
stringnull
The protocol to use for the exposed URL. If grpcPort is set, this defaults to grpc. Otherwise, it defaults to http.
ProjectId
string
The id of the project.
Error
object
3 properties 2 required
Probes
objectnull
Probes are used to determine if the container is healthy and ready to accept traffic.
1 property
Labels
arraynull
Set of labels to populate into the container running the workload.
Label
objectnull
Label details to be populated into the container.
3 properties
GpuPortionRequest
numbernull
Required if and only if gpuRequestType is portion. States the portion of the GPU to allocate for the created workload, per GPU device, between 0 and 1. The def…
Annotations
arraynull
Set of annotations to populate into the container running the workload.
EnvironmentVariables
arraynull
Set of environment variables to populate into the container running the workload.
RunAsGid
integernull
The group id to run the entrypoint of the container which executes the workspace. Default to the value specified in the environment asset runAsGid field (optio…
PolicyRuleEnum
stringnull
Indicates which validation rule (e.g., min, max, step, options, required, canEdit, canAdd) conflicted with policy restrictions, causing the asset or template t…
AutoScalingMaxReplicas
integernull
The maximum number of replicas for autoscaling. Defaults to minReplicas. Must be no less than minReplicas.
ServingPortGrpcPort
integernull
The GRPC port that the container running the inference service exposes.
GpuDevicesRequest
integernull
Requested number of GPU devices. Currently if more than one device is requested, it is not possible to provide values for gpuMemory or gpuPortion.
ProjectName2
string
The name of the project
NimServiceReplicas
integernull
The number of replicas to deploy.
GpuPortionLimit
numbernull
Limitations on the portion consumed by the workload, per GPU device. The system guarantees The gpuPotionLimit must be no less than the gpuPortionRequest.
ImagePullPolicy
stringnull
Image pull policy. Defaults to Always if :latest tag is specified, otherwise it is IfNotPresent.
Annotation
objectnull
Annotation details to be populated into the container.
3 properties
AutoScalingScaleWindowSeconds
integernull
The time window for autoscaling decisions, in seconds. Defaults to 300 seconds.
Toleration
objectnull
Toleration details.
7 properties
ServingPortServiceType
stringnull
The type of Kubernetes service to create for the inference deployment. Options include 'ClusterIP' (default), 'NodePort', 'LoadBalancer', and 'ExternalName'.
PvcAddedAttrValue
object
2 properties 1 required
Preemptibility
stringnull
Specifies whether the workload can be preempted by higher-priority workloads. Valid values are preemptible and non-preemptible. If explicitly set, this value t…
TenantId
integer
The id of the tenant.
RunAsUid
integernull
The user id to run the entrypoint of the container which executes the workspace. Default to the value specified in the environment asset runAsUid field (option…
ServingPortMetricsPort
integernull
The port where metrics are exposed, required only if it's different than the main port.
NimServiceNgcAuthSecret
stringnull
The name of a Kubernetes secret containing the NGC access credentials. The secret must contain a key named NGCAPIKEY with the API key as the value.
ServingPortExposeExternally
booleannull
Indicates whether the inference serving endpoint should be accessible outside the cluster. If set to true, the endpoint will be exposed externally. To enable e…
ClusterId
string
The id of the cluster.
AutoScalingMetricNim
stringnull
The metric to use for autoscaling (mandatory).
ClaimInfo
objectnull
Claim information for the newly created PVC. The information should not be provided when attempting to use existing PVC.
5 properties
TolerationEffect
stringnull
The taint effect to match. (mandatory)
NimServiceUpdateRequest
object
1 property 1 required
PvcAccessModes
objectnull
Default access mode(s) applied to newly created PVCs unless explicitly overridden.
3 properties
NimServicePvcFields
objectnull
4 properties
WorkloadV2Metadata
WorkloadName
string
The name of the workload.
GpuMemoryLimit
stringnull
Limitation on the memory consumed by the workload, per GPU device. The system guarantees The gpuMemoryLimit must be no less than gpuMemoryRequest.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runai-nvidia-nim-api-openapi.yml Raw ↑

Other APIs NVIDIA Run:ai publishes across the network.

NVIDIA Run:ai Access Keys API
AE Profile APIs.io
NVIDIA Run:ai Access rules API
AE Profile APIs.io
NVIDIA Run:ai Administrator Command Line Interface API
AE Profile APIs.io
NVIDIA Run:ai AI Applications API
AE Profile APIs.io
NVIDIA Run:ai Applications API
AE Profile APIs.io
NVIDIA Run:ai Clusters API
AE Profile APIs.io
NVIDIA Run:ai Compute API
AE Profile APIs.io
NVIDIA Run:ai ConfigMap API
AE Profile APIs.io
NVIDIA Run:ai Credentials API
AE Profile APIs.io
NVIDIA Run:ai Departments API
AE Profile APIs.io
NVIDIA Run:ai Distributed API
AE Profile APIs.io
NVIDIA Run:ai Distributed Inferences API
AE Profile APIs.io
#NVIDIA NIM
← Back to N APIs
API Details
ID
runai:runai-nvidia-nim-api
Base URL
https://app.run.ai
Docs
https://run-ai-docs.nvidia.com/api/readme.md
Provider
NVIDIA Run:ai
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=runai-nvidia-nim-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/runai-nvidia-nim-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of NVIDIA Run:ai NVIDIA NIM API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.