cuopt-server-api-python

Deploy cuOpt REST server and access routing endpoints with Python clients.

2.8k|332|Updated Feb 25, 2026
One-click install
npx skills add https://github.com/NVIDIA/skills --skill cuopt-server-api-python
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: cuopt-server-api-python
Source: https://github.com/NVIDIA/skills/tree/main/skills/cuopt/cuopt-server-api-python
Command: npx skills add https://github.com/NVIDIA/skills --skill cuopt-server-api-python

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires requests, and includes assets (resource) components.

What problem does it solve?

This skill helps developers deploy cuOpt REST server and access endpoints for routing and optimization tasks.

Core Features & Use Cases

  • Start a cuOpt REST server (development or Docker) and verify health.
  • Use Python and curl clients to submit requests, retrieve solutions, and compare results.
  • Use cases include deploying, testing, and integrating cuOpt routing endpoints into automation workflows.

Quick Start

Start the cuOpt server locally and run the Python client to submit a routing request.

Frequently Asked Questions about cuopt-server-api-python

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I deploy a cuOpt REST server for routing workloads?

To deploy a cuOpt REST server, start it locally in development or Docker mode and verify health using Python or curl clients. This enables you to access endpoints for routing and optimization tasks.

What endpoints are available on the cuOpt REST API?

The cuOpt REST API exposes /cuopt/request for submitting routing tasks, /cuopt/solution for retrieving optimization results, and health check endpoints to verify server status using Python requests.

Can I use Python requests to submit routing problems to a cuOpt server?

Yes, you can use Python requests-based clients to submit routing problems to the cuOpt server. The API accepts requests at /cuopt/request and returns solutions at /cuopt/solution.

Do I need Docker to run a cuOpt REST server?

No, Docker is not required to run a cuOpt REST server. You can deploy the server in development mode locally or use Docker, then verify health and run Python clients to access endpoints.

How do I check if my cuOpt server is running and healthy?

You can check if your cuOpt server is running by accessing its health check endpoints. Use Python requests or curl clients to verify the server status before submitting routing and optimization workloads.

What's the best way to integrate cuOpt routing endpoints into automation workflows?

The best way to integrate cuOpt routing endpoints into automation workflows is using Python requests-based clients to submit requests to /cuopt/request and retrieve solutions from /cuopt/solution.