Dev & Engineering ✓ NVIDIA · Official

cuOpt REST Server Deployment & Python Client

Deploy NVIDIA cuOpt as a REST service and call it with Python, curl, or another client.

45/ 100
Not recommended

Current benefit does not outweigh risk or uncertainty.

See how it was scored ↓
Works as-is in
Codex · Claude Code
Stars
★ 3.6k
Last updated
13d ago
License
Apache-2.0
cuoptrest-apipythoncurl
+4routinglinear-programmingmilpdeployment

What does this skill do, and when should you use it?

This skill is for users deploying or calling the cuOpt REST API. It covers local startup and Docker deployment, supported problem types, health checks, asynchronous request polling, and a Python routing example. It supports Routing, LP, and MILP through REST, while QP is unavailable. It also documents common payload-validation mistakes and runnable example asset directories.

Shows how to start cuOpt with the Python service module or Docker; checks availability through /cuopt/health; submits JSON to /cuopt/request and captures reqId; polls /cuopt/solution/{reqId}; builds a routing client with Python requests; maps Python API names to REST fields; diagnoses common 422 payload errors; and points users to VRP, pickup-and-delivery, LP, and MILP example assets.

Good fit
  • A Python engineer starting cuOpt locally for development.
  • An operator deploying the cuOpt REST server in Docker with GPU access.
  • A developer submitting vehicle-routing requests with Python requests.
  • A team calling cuOpt from curl, another language, or a separate service.
  • A cuOpt user troubleshooting 422 validation errors, failed request IDs, or capacity-shape mistakes.

How do you install this skill?

Before you use it
  • Do not expose the service directly to the public network: the example binds to 0.0.0.0 and provides no authentication or TLS configuration.
  • Do not rely on Docker latest; pin an image compatible with the skill version and API contract.
  • Add request timeouts, non-2xx handling, invalid reqId handling, server-error states, and explicit polling-timeout behavior.
  • Assets exit 0 when the server is unreachable, which can make CI or automation misinterpret a skipped run as success.
Before you start
Your agent needs
  • Shell / CLI
  • Network access
  • Local filesystem
Install first
  • Python
  • Python requests
  • Docker
  • NVIDIA GPU

Install the individual skill from NVIDIA/skills with the skills CLI: npx skills add nvidia/skills --skill cuopt-server-api-python --yes. The README states that the repository contains 324 skills and supports installation for clients including Codex, Claude Code, Cursor, and Kiro; the CLI manages the destination.

Generic route: install into Claude Code manually (macOS / Linux)
tmp="$(mktemp -d)"
git clone --depth 1 https://github.com/NVIDIA/skills.git "$tmp"
mkdir -p ~/.claude/skills
cp -R "$tmp/skills/cuopt-server-api-python" ~/.claude/skills/
rm -rf "$tmp"

Generated from the source repository and skill path; it copies only this skill's folder. If the author's install steps above differ, follow those first. To scope it to one project, replace ~/.claude/skills with that project's .claude/skills.

How do you use this skill?

Try saying

Once installed, send your agent any of these to trigger it:

  • Deploy or call the cuOpt REST service in Python for a routing problem.

Ask an agent with this skill loaded for a cuOpt REST deployment or API task, for example: “Deploy or call the cuOpt REST service in Python for a routing problem.” Clarify the problem type, deployment target, and client language or tool first. The skill provides local and Docker startup commands, a health check, request submission, and polling workflow. It names Kubernetes and cloud deployment options but does not provide their detailed procedures in this SKILL.md.

What are this skill's strengths and limitations?

Pros
  • Covers both local and Docker server startup.
  • Provides a REST workflow for Python, curl, and other-language clients.
  • Clearly states support for Routing, LP, and MILP and the lack of REST support for QP.
  • Calls out common REST field-name and capacity-shape errors.
  • Includes example assets for VRP, pickup and delivery, LP, and MILP.
Limitations
  • QP cannot be used through this REST interface.
  • Examples depend on a running server, Python requests, and an appropriate GPU environment.
  • Kubernetes and cloud are listed as deployment choices without detailed instructions.
  • The SKILL.md does not document a standalone test suite or complete API coverage.

How does this skill compare with similar options?

Side by side with related skills; every score comes from the same FSRS standard.

Skill FS score Stars Last updated License
cuOpt REST Server Deployment & Python Client this page ✓ NVIDIA · Official 45 · Not recommended ★ 3.6k 13d ago Apache-2.0
cuOpt Numerical Optimization API ✓ NVIDIA · Official 54 · Use with care ★ 3.6k 13d ago Apache-2.0
AMC Sample Dataset Calibration ✓ NVIDIA · Official 55 · Use with care ★ 3.6k 13d ago Apache-2.0
AutoMagicCalib Video Calibration ✓ NVIDIA · Official 53 · Use with care ★ 3.6k 13d ago Apache-2.0
FastAPI Router Builder ✓ Microsoft · Official 51 · Use with care ★ 2.7k 3mo ago MIT

The skill explicitly contrasts the Python API with REST: for example, Python API order_locations maps to REST task_locations, and set_order_time_windows() maps to task_time_windows. Its scope is REST-server deployment and Python/curl clients, rather than a standalone native Python API guide.

How did FollowSkills review this skill?

FollowSkills review · FSRS-2.0
Not recommended
45/ 100 5-point scale 2.3 / 5
The upstream repository has new commits since this review. The score still applies to the reviewed revision shown and may not cover the latest changes.
1Trust10 / 25 · 2.0/5

The skill asks for confirmation of problem type, deployment mode, and client, and its examples focus mainly on local REST calls; however, the server example binds to 0.0.0.0, Docker uses latest, and there is no guidance for authentication/TLS, sensitive data, least privilege, exposure, user confirmation, or rollback, so points are deducted.

2Reliability8 / 20 · 2.0/5

The workflow, health check, request/poll sequence, and several client assets are broadly consistent, with diagnosable messaging when the server is unreachable; however, the core example lacks timeouts, HTTP error handling, polling failure states, and compatibility guidance, while silent skip behavior can mask missing execution. Static calibration caps this at 10.

3Adaptability9 / 15 · 3.0/5

The audience, problem types, deployment choices, and client selection are reasonably clear, and QP is explicitly unsupported; however, cloud/Kubernetes options are listed without guidance, input/output contracts and non-fit boundaries remain incomplete, and Chinese-language support is not addressed. The core function can be self-hosted, so no extra mainland-China reachability deduction is applied.

4Convention8 / 15 · 2.7/5

The skill has a name, version, Apache-2.0 metadata, author, asset directory, README, and evaluation report, with readable organization; however, the benchmark notes missing recommended Instructions/Examples sections, and the material lacks dependency installation, pinned API/image versions, changelog, maintenance update path, limitation disclosure, and fuller troubleshooting. The relationship between repository-level CC-BY-4.0 and the skill metadata's Apache-2.0 is also unexplained.

5Effectiveness6 / 15 · 2.0/5

The material can directly guide REST-server startup, health verification, request/polling, and includes Routing, LP, MILP, and PDP assets; however, successful outputs are not statically verifiable, cloud/Kubernetes client coverage is incomplete, and results still require an appropriate runtime and review, so points are conservatively deducted under the static cap.

6Verifiability4 / 10 · 2.0/5

The pinned revision, concrete commands, client source, and benchmark report provide auditable material, including reported single-task results; however, the evaluation has only one task, no negative-trigger sample, no committed test suite covering this skill's key paths, and no execution logs, leaving the conclusion largely author-reported and capped at 5.

1 2 3 4 5 6

Open a dimension to read why it scored that way

Reviewed Jul 20, 2026 Reviewed revision 55f18499943e Review evidence[1][2][3][4][5][6][7][8][9][10][11][12][13][14][15][16][17][18]

Evidence confidence:Low — Mostly static review, author material or a limited demo; useful for discovery, not high-risk decisions.

See the full review method →

FAQ

Which optimization problem types are supported?
REST supports Routing, LP, and MILP. QP is not available through REST.
Does using the REST API require network access?
Yes. The client must reach a running cuOpt server, such as http://localhost:8000.
How do I check that the server is running?
Run curl http://localhost:8000/cuopt/health.
What should I check after a failed request?
Review the OpenAPI field names, response body, and reqId. Common mistakes include using transit_time_matrix_data instead of travel_time_matrix_data and using vehicle-shaped rather than per-dimension capacities.

More skills from this repository

All from NVIDIA/skills

Dev & Engineering ✓ NVIDIA · Official

cuOpt Numerical Optimization API

Guide agents through GPU-accelerated LP, MILP, and QP modeling with cuOpt

★ 3.6k FS 54 Use with care 13d ago
Automation & Ops ✓ NVIDIA · Official

cuOpt Installation Guide

Install and verify NVIDIA cuOpt for Python, C, or REST deployment.

★ 3.6k FS 51 Use with care 13d ago
Dev & Engineering ✓ NVIDIA · Official

AMC Sample Dataset Calibration

Verify a running NVIDIA AutoMagicCalib service end to end with its bundled sample dataset.

★ 3.6k FS 55 Use with care 13d ago
Data & Analysis ✓ NVIDIA · Official

cuOpt Numerical Optimization Formulation

Turn natural-language problems into clear LP, MILP, or QP mathematical formulations.

★ 3.6k FS 54 Use with care 13d ago
Dev & Engineering ✓ NVIDIA · Official

AutoMagicCalib Video Calibration

Turn local multi-camera MP4 recordings into AutoMagicCalib calibration results through a REST API.

★ 3.6k FS 53 Use with care 13d ago
Dev & Engineering ✓ NVIDIA · Official

cuOpt Python Routing

Model and solve TSP, VRP, and pickup-and-delivery routes with the cuOpt Python API.

★ 3.6k FS 53 Use with care 13d ago
Dev & Engineering ✓ NVIDIA · Official

NVIDIA cuOpt Developer

Guides source-level cuOpt modification, builds, tests, debugging, and contributions.

★ 3.6k FS 62 Recommended 13d ago
Automation & Ops ✓ NVIDIA · Official

VSS Video Embedding Deployment

Deploy and operate NVIDIA’s video embedding service for files, text, and live streams.

★ 3.6k FS 57 Use with care 13d ago
Automation & Ops ✓ NVIDIA · Official

RTVI-CV 2D Detection & Tracking Operations

Deploy and operate the RTVI-CV 2D video detection and tracking microservice.

★ 3.6k FS 54 Use with care 13d ago
Automation & Ops ✓ NVIDIA · Official

VSS Standalone Video Analytics API

Deploy and verify NVIDIA’s VSS video analytics REST API without the full warehouse stack.

★ 3.6k FS 54 Use with care 13d ago
Automation & Ops ✓ NVIDIA · Official

VIOS Video I/O and Storage Manager

Manage VIOS sensors, streams, recordings, snapshots, clips, and storage through its REST API.

★ 3.6k FS 53 Use with care 13d ago
Automation & Ops ✓ NVIDIA · Official

RT-VLM Dense Captioning Deployment

Deploy and operate NVIDIA RT-VLM to generate dense video captions and manage live streams through a REST API.

★ 3.6k FS 45 Not recommended 13d ago
Dev & Engineering ✓ NVIDIA · Official

NeMo Relay Installation Guide

Choose and verify the right NeMo Relay path for CLIs, language packages, and maintained frameworks.

★ 3.6k FS 62 Recommended 13d ago
Dev & Engineering ✓ NVIDIA · Official

NeMo Relay Quick Start

Helps first-time NeMo Relay users prove observable execution value through the smallest suitable trial.

★ 3.6k FS 61 Recommended 13d ago
Data & Analysis ✓ NVIDIA · Official

DICOM Series Preflight

Header-only validation for one DICOM series before conversion or inference.

★ 3.6k FS 60 Recommended 13d ago
Finance & Investment Banking ✓ NVIDIA · Official

cuFOLIO Portfolio Optimization

GPU-accelerated CVaR portfolio optimization, backtesting, and rebalancing.

★ 3.6k FS 59 Recommended 13d ago
Dev & Engineering ✓ NVIDIA · Official

DALI Dynamic Mode Assistant

Helps agents write, review, and migrate NVIDIA DALI imperative dynamic-mode code.

★ 3.6k FS 58 Recommended 13d ago
Automation & Ops ✓ NVIDIA · Official

NVIDIA AI-Q Deployment

Deploy, verify, and operate NVIDIA AI-Q Blueprint infrastructure.

★ 3.6k FS 57 Use with care 13d ago
Dev & Engineering ✓ NVIDIA · Official

NeMo Relay Migration Assistant

Safely migrate NeMo Flow projects to NeMo Relay.

★ 3.6k FS 57 Use with care 13d ago
Data & Analysis ✓ NVIDIA · Official

cuOpt Multi-Objective Explorer

Map Pareto tradeoffs between competing objectives with cuOpt.

★ 3.6k FS 56 Use with care 13d ago

Related skills