cog

Cog - JavaScript client for cog No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.1.0
• Package version: 0.1.0
• Generator version: 7.4.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install cog --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your cog from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/YOUR_USERNAME/cog then install it via:

    npm install YOUR_USERNAME/cog --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var Cog = require('cog');


var api = new Cog.DefaultApi()
var predictionId = "predictionId_example"; // {String} 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cancelPredictionsPredictionIdCancelPost(predictionId, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- Cog.DefaultApi | cancelPredictionsPredictionIdCancelPost | POST /predictions/{prediction_id}/cancel | Cancel Cog.DefaultApi | healthcheckHealthCheckGet | GET /health-check | Healthcheck Cog.DefaultApi | predictIdempotentPredictionsPredictionIdPut | PUT /predictions/{prediction_id} | Predict Idempotent Cog.DefaultApi | predictPredictionsPost | POST /predictions/stability-ai/stable-diffusion | Predict Cog.DefaultApi | rootGet | GET / | Root Cog.DefaultApi | startShutdownShutdownPost | POST /shutdown | Start Shutdown

Documentation for Models

• Cog.HTTPValidationError
• Cog.Height
• Cog.Input
• Cog.Input1
• Cog.PredictionRequest
• Cog.PredictionResponse
• Cog.Scheduler
• Cog.Status
• Cog.ValidationError
• Cog.ValidationError1
• Cog.ValidationError1LocInner
• Cog.WebhookEvent
• Cog.Width

Documentation for Authorization

Endpoints do not require authorization.