Package Exports

@webgpt/sdk
@webgpt/sdk/dist/esm/index.es.js
@webgpt/sdk/dist/umd/index.umd.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@webgpt/sdk) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

⏣ WebGPT SDK

WebGPT SDK is a TypeScript / JavaScript library for interacting with the WebGPT API.

Usage

First, install the package:

npm i @webgpt/sdk

Then, you can use the SDK in your code:

import { WebgptSdk } from '@webgpt/sdk';

const webgpt = new WebgptSdk({
    apiKey: 'YOUR_API_KEY',
});

const { assignment } = webgpt
    .makeAssignment({
        idea: `Crocodile zoo`,
        language: `en`,
    })
    .asPromise();

console.info(`Assignment:`, '\n', assignment);

See more usage examples in the /samples directory.

Capabilities of SDK

Make assignment Creates assignment from idea.
Make website Makes website from from idea and publishes it.

Terminology

Idea is short description of the website, email from client or any other input that describes the desired website.
Assignment is precise and professional description of the website, content structure, name, domain, keywords, etc.
Website Preview is website inside the WebGPT system in editable state, for example https://webgpt.cz/fuel-factor-x-2plub5fh5wws
Published Website is the final product, the website live on the the domain, for example https://www.jezdimelevneji.cz/
Task is the process of creating the assignment or website.
- Every task has its unique ID
- Once started, task is running independently of the SDK instance
- Task can be recovered by its ID
- You can list all tasks and their statuses with .asObservable()
- Or just get the result with .asPromise()

Access

This is internal SDK for our partners. If you are interested in using it, please contact us at pavol@webgpt.cz.