API Calls

You can use the Alisio API to use our models.

Type Endpoint Params Example Response Description Example with curl
POST /api/v1/login
  • username
  • password
This method returns your API_KEY. You can always use the guest/guest combo to get the guest API_KEY
POST /api/v1/upload
  • circuitid
  • input
Upload a job for a given model. You must provide an API_KEY in the HTTP header (see /api/v1/login)
GET /api/v1/listcircuits Lists all available models. You must provide an API_KEY in the HTTP header (see /api/v1/login)
GET /api/v1/circuitinfo/<circuitid>
  • circuitid
Lists details of a given model. You must provide an API_KEY in the HTTP header (see /api/v1/login)
GET /api/v1/listexecutions Lists all the jobs associated with this account. You must provide an API_KEY in the HTTP header (see /api/v1/login)
GET /api/v1/status/<execution_id>
  • executionid
Lists the details of a given job. You must provide an API_KEY in the HTTP header (see /api/v1/login)