Cuopt Server API Python

What it does

When your agent uses it

• The user is deploying
• Calling the REST API

Example prompts

• “/cuopt-server-api-python”

Requirements

• Python 3
• Docker

Workflow steps

3 steps, taken from the first numbered list in SKILL.md.

1. 1Problem type — Routing or LP/MILP? (QP not available via REST.)
2. 2Deployment — Local, Docker, Kubernetes, or cloud?
3. 3Client — Which language or tool will call the API (e.g. Python, curl, another service)?

What it can do on your machine

Read from SKILL.md and the folder at commit dfdd080. It shows what the files ask for, not the result of running them.

• Tool permissions

  Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

  From allowed-tools in the SKILL.md frontmatter.

• Runs code

  Ships script files (Python, from the files we listed), which the agent can run.

  Shell commands in SKILL.md call:

  • python
  • docker
  • curl

  From the folder's file list and the shell code blocks in SKILL.md.

• Network

  No URLs in SKILL.md. Its commands use docker and curl, which can reach the network depending on how they are called.

  From URLs in SKILL.md, links to its own repository left out.

• Credentials

  Names no API keys, tokens, secrets or passwords.

  From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Cuopt Server API Python loads about 1.5k tokens when it runs. Until then it costs about 38 tokens; SKILL.md has 592 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it

~38

When it runs · the whole SKILL.md, loaded when a task matches

~1.5k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from NVIDIA/skills at commit dfdd080, republished under its Apache-2.0 licence (© NVIDIA). 592 words, ~1,528 tokens.

name

cuopt-server-api-python

description

cuOpt REST server — start server, endpoints, Python/curl client examples. Use when the user is deploying or calling the REST API.

version

26.10.00

license

Apache-2.0

metadata.author

NVIDIA cuOpt Team

metadata.tags

cuopt, server, rest-api, python, deployment

# Development
python -m cuopt_server.cuopt_service --ip 0.0.0.0 --port 8000

# Docker — pick the tag matching your CUDA major version
docker run --gpus all -d -p 8000:8000 -e CUOPT_SERVER_PORT=8000 \
  nvidia/cuopt:latest-cu13

import requests, time
SERVER = "http://localhost:8000"
HEADERS = {"Content-Type": "application/json", "CLIENT-VERSION": "custom"}
payload = {
    "cost_matrix_data": {"data": {"0": [[0,10,15],[10,0,12],[15,12,0]]}},
    "travel_time_matrix_data": {"data": {"0": [[0,10,15],[10,0,12],[15,12,0]]}},
    "task_data": {"task_locations": [1, 2], "demand": [[10, 20]], "task_time_windows": [[0,100],[0,100]], "service_times": [5, 5]},
    "fleet_data": {"vehicle_locations": [[0, 0]], "capacities": [[50]], "vehicle_time_windows": [[0, 200]]},
    "solver_config": {"time_limit": 5}
}
r = requests.post(f"{SERVER}/cuopt/request", json=payload, headers=HEADERS, timeout=30)
req_id = r.json()["reqId"]
# Poll: GET /cuopt/solution/{req_id}

© NVIDIA, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 15 other files (assets) in skills/cuopt-server-api-python of NVIDIA/skills.

• SKILL.md
• BENCHMARK.md
• assets/README.md
• assets/lp_basic/README.md
• assets/lp_basic/client.py
• assets/milp_basic/README.md
• assets/milp_basic/client.py
• assets/pdp_basic/README.md
• assets/pdp_basic/client.py
• assets/vrp_basic/README.md
• assets/vrp_basic/client.py
• assets/vrp_simple/README.md
• assets/vrp_simple/client.py
• evals/evals.json
• … and 2 more

Open the folder on GitHubat commit dfdd080