Class ClientV1

Api

public

Classdesc

An API client for Craiyon.

Hierarchy

ClientV1

Index

Constructors

Properties

GENERATE_IMAGES_URL VERSION

Methods

generate withBaseUrl withMaxRetries

Constructors

constructor

new ClientV1(): ClientV1
Returns ClientV1
- Defined in api/clientv1.ts:29

Properties

`Static` GENERATE_IMAGES_URL

GENERATE_IMAGES_URL: string = '/generate'

`Static` VERSION

VERSION: number = 1

Methods

generate

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

withBaseUrl

withBaseUrl(baseUrl: string): ClientV1
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 /generate endpoint.
Returns ClientV1
- Defined in api/clientv1.ts:41

withMaxRetries

withMaxRetries(maxRetries: number): ClientV1
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 ClientV1
- Defined in api/clientv1.ts:52

Generated using TypeDoc