Light Logo
JavaScript SDK (v0.49.0)Reference

Uploads

Resource for operations related to uploads.

Class: Uploads

Resource for operations related to uploads.

Extends

Constructors

Constructor

new Uploads(api): Uploads

Create a new resource.

Parameters

api

API

API client instance used to communicate with WriftAI's API.

Returns

Uploads

Inherited from

Resource.constructor

Methods

complete()

complete(id, params, signal?): Promise<UploadCompletionResult>

Complete an upload.

Parameters

id

string

The unique identifier of the upload.

params

CompleteUploadParams

Parameters to complete an upload.

signal?

AbortSignal

Optional AbortSignal to cancel the request.

Returns

Promise<UploadCompletionResult>

The completion result.


create()

create(params, signal?): Promise<Upload>

Create an upload.

Parameters

params

CreateUploadParams

Upload creation parameters.

signal?

AbortSignal

Optional AbortSignal to cancel the request.

Returns

Promise<Upload>

The new upload.