Class ProjectsApi

Hierarchy (View Summary)

ApiGroup<ProjectApiEvents>
- ProjectsApi

Index

Constructors

constructor

new ProjectsApi(config: ApiConfig): ProjectsApi
Parameters
- config: ApiConfig
Returns ProjectsApi
Overrides ApiGroup.constructor
- Defined in Projects/index.ts:188

Properties

`Protected`client

client: ApiClient

`Protected`eip712

eip712: EIP712Helper

`Protected`listeners

listeners: {
    availableModels?: (data: AvailableModel[]) => void[];
    job?: (data: JobEvent) => void[];
    project?: (data: ProjectEvent) => void[];
} = {}

Accessors

availableModels

get availableModels(): AvailableModel[]
Returns AvailableModel[]
- Defined in Projects/index.ts:157

trackedProjects

get trackedProjects(): Project[]
Retrieves a list of projects created and tracked by this SogniClient instance.

Note: When a project is finished, it will be removed from this list after 30 seconds

Returns Project[]
A copy of the array containing the tracked projects.
- Defined in Projects/index.ts:216

Methods

cancel

cancel(projectId: string): Promise<void>
Cancel project by id. This will cancel all jobs in the project and mark project as canceled. Client may still receive job events for the canceled jobs as it takes some time, but they will be ignored
Parameters
- projectId: string
Returns Promise<void>
- Defined in Projects/index.ts:677

create

create(data: ProjectParams): Promise<Project>
Send new project request to the network. Returns project instance which can be used to track progress and get resulting images or videos.
Parameters
- data: ProjectParams
Returns Promise<Project>
- Defined in Projects/index.ts:591

`Protected`emit

emit<T extends keyof ProjectApiEvents>(
event: T,
data: ProjectApiEvents[T],
): void
Dispatch an event to all listeners
Type Parameters
- T extends keyof ProjectApiEvents
Parameters
- event: T
- data: ProjectApiEvents[T]
Returns void
Inherited from ApiGroup.emit
- Defined in lib/TypedEventEmitter.ts:57

estimateAudioCost

estimateAudioCost(params: AudioEstimateRequest): Promise<CostEstimation>
Estimate the cost of an audio generation job.
Parameters
- params: AudioEstimateRequest
  The parameters required for audio cost estimation. This includes:
  - tokenType: The type of token to be used for generation.
  - model: The model to be used for audio generation.
  - duration: Duration of the audio in seconds.
  - steps: Number of inference steps.
  - numberOfMedia: Number of audio tracks to generate.
Returns Promise<CostEstimation>
Returns an object containing the estimated costs in different units.
- Defined in Projects/index.ts:1016

estimateCost

estimateCost(__namedParameters: EstimateRequest): Promise<CostEstimation>
Estimate image project cost
Parameters
- __namedParameters: EstimateRequest
Returns Promise<CostEstimation>
- Defined in Projects/index.ts:890

estimateEnhancementCost

estimateEnhancementCost(
strength: EnhancementStrength,
tokenType?: TokenType,
): Promise<CostEstimation>
Estimate image enhancement cost
Parameters
- strength: EnhancementStrength
- tokenType: TokenType = 'spark'
Returns Promise<CostEstimation>
- Defined in Projects/index.ts:952

estimateVideoCost

estimateVideoCost(
params: VideoEstimateRequest,
): Promise<{ sogni: string; spark: string; token: string; usd: string }>
Estimates the cost of generating a video based on the provided parameters.
Parameters
- params: VideoEstimateRequest
  The parameters required for video cost estimation. This includes:
  - tokenType: The type of token to be used for generation.
  - model: The model to be used for video generation.
  - width: The width of the video in pixels.
  - height: The height of the video in pixels.
  - frames: The total number of frames in the video.
  - fps: The frames per second for the video.
  - steps: Number of steps.
Returns Promise<{ sogni: string; spark: string; token: string; usd: string }>
Returns an object containing the estimated costs for the video in different units:
- token: Cost in tokens.
- usd: Cost in USD.
- spark: Cost in Spark.
- sogni: Cost in Sogni.
- Defined in Projects/index.ts:982

getAvailableModels

getAvailableModels(network: SupernetType): Promise<AvailableModel[]>
Get available models and their worker counts. Normally, you would get list once you connect to the server, but you can also call this method to get the list of available models manually.
Parameters
- network: SupernetType
Returns Promise<AvailableModel[]>
- Defined in Projects/index.ts:1206

getModelOptions

getModelOptions(modelId: string): Promise<ModelOptions>
Parameters
- modelId: string
Returns Promise<ModelOptions>
- Defined in Projects/index.ts:1223

getSizePresets

getSizePresets(
    network: SupernetType,
    modelId: string,
    forceRefresh?: boolean,
): Promise<SizePreset[]>
Get supported size presets for the model and network. Size presets are cached for 10 minutes.
Parameters
- network: SupernetType
  'fast' or 'relaxed'
- modelId: string
  model id (e.g. 'flux1-schnell-fp8')
- forceRefresh: boolean = false
  force refresh cache
Returns Promise<SizePreset[]>
Example
```
const presets = await sogni.projects.getSizePresets('fast', 'flux1-schnell-fp8');
console.log(presets);
```
- Defined in Projects/index.ts:1145

getSupportedModels

getSupportedModels(forceRefresh?: boolean): Promise<SupportedModel[]>
Parameters
- forceRefresh: boolean = false
Returns Promise<SupportedModel[]>
- Defined in Projects/index.ts:1098

getVideoAssetConfig

getVideoAssetConfig(
    modelId: string,
): Promise<
    | { assets?: undefined; workflowType: null }
    | {
        assets: Record<VideoAssetKey, AssetRequirement>;
        workflowType:
            | "t2v"
            | "i2v"
            | "s2v"
            | "ia2v"
            | "a2v"
            | "v2v"
            | "animate-move"
            | "animate-replace";
    },
>
Retrieves the video asset configuration for a given video model identifier. Validates whether the provided model ID corresponds to a video model. If it does, returns the appropriate video asset configuration based on the workflow type.
Parameters
- modelId: string
  The identifier of the video model to retrieve the configuration for.
Returns Promise<
    | { assets?: undefined; workflowType: null }
    | {
        assets: Record<VideoAssetKey, AssetRequirement>;
        workflowType:
            | "t2v"
            | "i2v"
            | "s2v"
            | "ia2v"
            | "a2v"
            | "v2v"
            | "animate-move"
            | "animate-replace";
    },
>
The video asset configuration object where key is asset field and value is either required, forbidden or optional. Returns null if no rules defined for the model.
Example: Returned object for a model that implements image to video workflow:
```
{
  "workflowType": "i2v",
  "assets": {
    "referenceImage": "required",
    "referenceImageEnd": "optional",
    "referenceAudio": "forbidden",
    "referenceVideo": "forbidden"
  }
}
```
Throws
Throws an error if the provided model ID is not a video model.
- Defined in Projects/index.ts:1181

isAudioModelId

isAudioModelId(modelId: string): boolean
Check if a model produces audio output using the cached models list. Uses the media property from the models API when available, falls back to model ID prefix check if models aren't loaded yet.
Parameters
- modelId: string
Returns boolean
- Defined in Projects/index.ts:180

isVideoModelId

isVideoModelId(modelId: string): boolean
Check if a model produces video output using the cached models list. Uses the media property from the models API when available, falls back to model ID prefix check if models aren't loaded yet.
Parameters
- modelId: string
Returns boolean
- Defined in Projects/index.ts:166

off

off<T extends keyof ProjectApiEvents>(
event: T,
listener: (data: ProjectApiEvents[T]) => void,
): void
Remove an event listener
Type Parameters
- T extends keyof ProjectApiEvents
Parameters
- event: T
- listener: (data: ProjectApiEvents[T]) => void
Returns void
Inherited from ApiGroup.off
- Defined in lib/TypedEventEmitter.ts:45

on

on<T extends keyof ProjectApiEvents>(
event: T,
listener: (data: ProjectApiEvents[T]) => void,
): () => void
Add an event listener, returns a function that can be called to remove the listener
Type Parameters
- T extends keyof ProjectApiEvents
Parameters
- event: T
- listener: (data: ProjectApiEvents[T]) => void
Returns () => void
Inherited from ApiGroup.on
- Defined in lib/TypedEventEmitter.ts:17

once

once<T extends keyof ProjectApiEvents>(
event: T,
listener: (data: ProjectApiEvents[T]) => void,
): () => void
Add an event listener that will be called only once
Type Parameters
- T extends keyof ProjectApiEvents
Parameters
- event: T
- listener: (data: ProjectApiEvents[T]) => void
Returns () => void
Inherited from ApiGroup.once
- Defined in lib/TypedEventEmitter.ts:32

waitForModels

waitForModels(timeout?: number): Promise<AvailableModel[]>
Wait for available models to be received from the network. Useful for scripts that need to run after the models are loaded.
Parameters
- timeout: number = 10000
  timeout in milliseconds until the promise is rejected
Returns Promise<AvailableModel[]>
- Defined in Projects/index.ts:557

Class ProjectsApi

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ProjectsApi

Properties

Protectedclient

Protectedeip712

Protectedlisteners

Accessors

availableModels

Returns AvailableModel[]

trackedProjects

Returns Project[]

Methods

cancel

Parameters

Returns Promise<void>

create

Parameters

Returns Promise<Project>

Protectedemit

Type Parameters

Parameters

Returns void

estimateAudioCost

Parameters

Returns Promise<CostEstimation>

estimateCost

Parameters

Returns Promise<CostEstimation>

estimateEnhancementCost

Parameters

Returns Promise<CostEstimation>

estimateVideoCost

Parameters

Returns Promise<{ sogni: string; spark: string; token: string; usd: string }>

getAvailableModels

Parameters

Returns Promise<AvailableModel[]>

getModelOptions

Parameters

Returns Promise<ModelOptions>

getSizePresets

Parameters

Returns Promise<SizePreset[]>

Example

getSupportedModels

Parameters

Returns Promise<SupportedModel[]>

getVideoAssetConfig

Parameters

Returns Promise< | { assets?: undefined; workflowType: null } | { assets: Record<VideoAssetKey, AssetRequirement>; workflowType: | "t2v" | "i2v" | "s2v" | "ia2v" | "a2v" | "v2v" | "animate-move" | "animate-replace"; },>

Example: Returned object for a model that implements image to video workflow:

Throws

isAudioModelId

Parameters

Returns boolean

isVideoModelId

Parameters

Returns boolean

off

Type Parameters

Parameters

Returns void

on

Type Parameters

Parameters

Returns () => void

once

Type Parameters

Parameters

Returns () => void

waitForModels

`Protected`client

`Protected`eip712

`Protected`listeners

`Protected`emit

Returns Promise<
| { assets?: undefined; workflowType: null }
| {
assets: Record<VideoAssetKey, AssetRequirement>;
workflowType:
| "t2v"
| "i2v"
| "s2v"
| "ia2v"
| "a2v"
| "v2v"
| "animate-move"
| "animate-replace";
},
>