Class ClientV2

Api

public

Classdesc

An API client for Craiyon.

Hierarchy

ClientV2

Index

Constructors

Properties

GENERATE_IMAGES_URL VERSION

Methods

generate withApiToken withBaseUrl withMaxRetries withModelVersion

Constructors

constructor

new ClientV2(): ClientV2
Returns ClientV2
- Defined in api/clientv2.ts:31

Properties

`Static` GENERATE_IMAGES_URL

GENERATE_IMAGES_URL: string = '/draw'

`Static` VERSION

VERSION: number = 2

Methods

generate

generate(options: CraiyonGenerateRequestOptionsV2): 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: CraiyonGenerateRequestOptionsV2
  
  The options to use for the request.
Returns Promise<CraiyonOutput>
- Defined in api/clientv2.ts:92

withApiToken

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

Returns
The modified client instance.
Parameters
- apiToken: string
Returns ClientV2
- Defined in api/clientv2.ts:78

withBaseUrl

withBaseUrl(baseUrl: string): ClientV2
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 ClientV2
- Defined in api/clientv2.ts:45

withMaxRetries

withMaxRetries(maxRetries: number): ClientV2
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 ClientV2
- Defined in api/clientv2.ts:56

withModelVersion

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

Returns
The modified client instance.
Parameters
- modelVersion: string
  
  The craiyon model to use.
Returns ClientV2
- Defined in api/clientv2.ts:67

Generated using TypeDoc