API Reference

Submit to solver

post
https://optimize.api.nvidia.com/v1/nvidia/cuopt

Note: This is for managed service. Takes all the data and options at once, solves the routing problem and returns result. This POST should be used in conjunction with the NVCF API which allows for the upload of large assets.
You can find details on how to use NVCF Asset APIs here: https://docs.api.nvidia.com/cloud-functions/reference/createasset

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
enum

Action to be performed by the service, validator action just validates input against format and base rules.

data
required

The data that needs to be processed by the service. For detailed explanations of each field, please consult the following link: data requirements . To ensure best practices, please refer to: best practices. For examples, you can find them at: notebooks. If the size of the data exceeds 250KB, please utilize the large assets API to upload it to s3. In such cases, set the data as null and include the header NVCF-INPUT-ASSET-REFERENCES: $ASSET_ID in the POST request.

parameters

unused/ignored but retained for compatibility

cuOpt client version. Set to 'custom' to skip version check.

Headers
string

String of asset IDs separated by commas. Data is uploaded to AWS S3 using NVCF Asset APIs and associated with these asset IDs.If the size of the json is more than 200KB, it needs to be uploaded to a presigned S3 URL bucket. The presigned URL allows for secure and temporary access to the S3 bucket for uploading the image. Once the asset is requested, an asset ID is generated for it. Please include this asset ID in this header and to use the uploaded json the 'data' field in the request body should be null; otherwise, it will be ignored.

Responses

Updated almost 2 years ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated almost 2 years ago

country_code