Class Client

Api

public

Classdesc

An API client for Craiyon.

Hierarchy

Client

Index

Constructors

Properties

GENERATE_IMAGES_URL MODELS VERSION

Methods

generate withApiToken withBaseUrl withMaxRetries withModelVersion

Constructors

constructor

new Client(): Client
Returns Client
- Defined in api/clientv3.ts:45

Properties

`Static` GENERATE_IMAGES_URL

GENERATE_IMAGES_URL: string = '/v3'

`Static` MODELS

MODELS: typeof CraiyonModel = CraiyonModel

`Static` VERSION

VERSION: number = 3

Methods

generate

generate(options: CraiyonGenerateRequestOptions): Promise<CraiyonOutput>
Generates an image for the given prompt. The retries will be throttled by 10 seconds if an HTTP Too Many Requests error is returned.

Returns
A promise that resolves to the output of the image generation.

Throws
If the request fails after the maximum number of retries.
Parameters
- options: CraiyonGenerateRequestOptions
  
  The options to use for the request.
Returns Promise<CraiyonOutput>
- Defined in api/clientv3.ts:106

withApiToken

withApiToken(apiToken: string): Client
A builder function that sets the model version.

Returns
The modified client instance.
Parameters
- apiToken: string
Returns Client
- Defined in api/clientv3.ts:92

withBaseUrl

withBaseUrl(baseUrl: string): Client
A builder function that sets the base URL of the Craiyon backend instance.

Returns
The modified client instance.
Parameters
- baseUrl: string
  
  The base URL to use. Must not include the /draw endpoint.
Returns Client
- Defined in api/clientv3.ts:59

withMaxRetries

withMaxRetries(maxRetries: number): Client
A builder function that sets the maximum number of retries to attempt.

Returns
The modified client instance.
Parameters
- maxRetries: number
  
  The maximum number of retries to attempt.
Returns Client
- Defined in api/clientv3.ts:70

withModelVersion

withModelVersion(modelVersion: string): Client
A builder function that sets the model version.

Returns
The modified client instance.
Parameters
- modelVersion: string
  
  The craiyon model to use.
Returns Client
- Defined in api/clientv3.ts:81

Generated using TypeDoc