docs.hubert2.titanq.infinityq.io Open in urlscan Pro
18.66.122.69  Public Scan

Form analysis
0 forms found in the DOM

Text Content

 * Quickstart
 * SDK
 * postSend compute job to the solver
 * getObtain the remaining credits and the expiration date
 * getObtain InfinityQ managed storage.

API docs by Redocly





TITANQ OPTIMIZATION PLATFORM (V0.16.22)

Download OpenAPI specification:Download

Support: support@infinityq.tech


Platform to access and use InfinityQ's QUBO solver.

Copyright (c) 2023, InfinityQ Technology, Inc.


QUICKSTART

For a detailed quickstart and some examples, see the quickstart documentation


SDK

TitanQ has a Python SDK, see the SDK documentation


SEND COMPUTE JOB TO THE SOLVER

AUTHORIZATIONS:

ApiKeyAuthorizer

REQUEST BODY SCHEMA: APPLICATION/JSON
REQUIRED



input
required
GCP (object) or S3 (object) or URL (object)

Information to send the input files of the problem in QUBO format.

--------------------------------------------------------------------------------

The InfinityQ solver looks at QUBO and Ising problems with an objective function
of:



 * The weight matrix W is expected to be a SYMMETRIC N × N matrix of real
   values.
 * The bias b is defined as a N × 1 vector of real values.
 * Supported range for N: [2, 100 000].

output
required
GCP (object) or S3 (object) or URL (object)

parameters
required
object (SolvingParameters)

Solving parameters used by the solver.

For more information on how to tune those parameters, see the parameter tuning
guide


RESPONSES

202

The computation have been queued.

400

The computation have been rejected due to a bad request.

402

The computation have been rejected because there isn't enough credit in the user
account to process this particular request.

415

The computation have been rejected because the request had unsupported media
type.

500

The computation have been rejected due to an internal server error.

post/solve
https://docs.hubert2.titanq.infinityq.io/api/hubert2.titanq.infinityq.io/solve


REQUEST SAMPLES

 * Payload

Content type
application/json
Copy
Expand all Collapse all
{
 * "input": {
    * "gcp": {
       * "bucket_name": "string",
       * "json_key": { }
      
      },
    * "bias_file_name": "string",
    * "weights_file_name": "string",
    * "constraint_bounds_file_name": "string",
    * "constraint_weights_file_name": "string",
    * "variable_bounds_file_name": "string",
    * "manifest": {
       * "has_inequality_constraint": false,
       * "has_equality_constraint": false,
       * "has_set_partitioning_constraint": false,
       * "has_cardinality_constraint": false
      
      }
   
   },
 * "output": {
    * "gcp": {
       * "bucket_name": "string",
       * "json_key": { }
      
      },
    * "result_archive_file_name": "string"
   
   },
 * "parameters": {
    * "beta": [
       * 20000
      
      ],
    * "coupling_mult": 0.5,
    * "timeout_in_secs": 10,
    * "num_chains": 8,
    * "num_engines": 1,
    * "variable_types": "bbbbbii",
    * "penalty_scaling": 0,
    * "precision": "auto"
   
   }

}


RESPONSE SAMPLES

 * 202
 * 400
 * 402
 * 415
 * 500

Content type
application/json
Copy
{
 * "computation_id": "00000000-0000-0000-0000-000000000000",
 * "status": "Queued",
 * "message": "Computation have successfully been queued"

}






OBTAIN THE REMAINING CREDITS AND THE EXPIRATION DATE

AUTHORIZATIONS:

ApiKeyAuthorizer


RESPONSES

200

Remaining credits and the expiration date.

500

The request could not complete due to an internal server error.

get/credits
https://docs.hubert2.titanq.infinityq.io/api/hubert2.titanq.infinityq.io/credits


RESPONSE SAMPLES

 * 200
 * 500

Content type
application/json
Copy
{
 * "remaining_credits": 0,
 * "expiration_date": "string"

}



OBTAIN INFINITYQ MANAGED STORAGE.

Obtain a storage location that is directly managed by InfinityQ.

NOTE: These urls limit the size of the input file to 10k variables

AUTHORIZATIONS:

ApiKeyAuthorizer


RESPONSES

200

Download and upload URLs for every possible input and output

500

The request could not complete due to an internal server error.

get/temp_storage
https://docs.hubert2.titanq.infinityq.io/api/hubert2.titanq.infinityq.io/temp_storage


RESPONSE SAMPLES

 * 200
 * 500

Content type
application/json
Copy
Expand all Collapse all
{
 * "input": {
    * "weights.npy": {
       * "upload": "string",
       * "download": "string"
      
      },
    * "constraint_weights.npy": {
       * "upload": "string",
       * "download": "string"
      
      },
    * "bias.npy": {
       * "upload": "string",
       * "download": "string"
      
      },
    * "constraint_bounds.npy": {
       * "upload": "string",
       * "download": "string"
      
      },
    * "variable_bounds.npy": {
       * "upload": "string",
       * "download": "string"
      
      }
   
   },
 * "output": {
    * "result.zip": {
       * "upload": "string",
       * "download": "string"
      
      }
   
   }

}