Preparing search index...
The search index is not available
@sogni-ai/sogni-client
@sogni-ai/sogni-client
@sogni-ai/sogni-client
Modules
<internal>
Classes
ApiError
ApiKeyAuthManager
ChatJobError
ChatStream
ChatToolsApi
CreativeWorkflowsApi
CreativeWorkflowTemplatesApi
CurrentAccount
DataEntity
Job
Project
ReplayApi
SogniClient
Interfaces
AgentAttributionMetadata
AudioProjectParams
AuthenticatedData
AvailableModel
Balances
ChatCompletionChunk
ChatCompletionParams
ChatCompletionResult
ChatJobErrorFields
ChatJobStateEvent
ChatMessage
ChatRunEvent
ChatRunRecord
ChatTokenUsage
ConnectionAttribution
ControlNetParams
CostEstimation
CreateSubscriptionCheckoutOptions
CreativeWorkflowArtifact
CreativeWorkflowEvent
CreativeWorkflowRecord
CreativeWorkflowSseEvent
ErrorData
EstimateRequest
ForkWorkflowTemplateBody
GetReplayRecordResult
HostedChatCompletionChoice
HostedChatCompletionMessage
HostedChatCompletionResult
HostedCreativeWorkflowReference
HostedToolExecutionParams
HostedToolExecutionResult
ImageProjectParams
ImageUrlContentPart
ListCreativeWorkflowOptions
ListReplayRecordsOptions
ListReplayRecordsResult
ListWorkflowTemplatesOptions
ListWorkflowTemplatesResult
LLMCostEstimation
LLMJobCost
LLMModelInfo
LLMParamConstraint
LLMSamplingDefaults
Logger
OperationLineage
RawProject
ReplayRecordSummary
ReplayRequestOptions
ReplayWriteResult
ReseedCreativeWorkflowOptions
ReseedCreativeWorkflowParams
ReseedCreativeWorkflowResult
ResumeCreativeWorkflowOptions
ResumeCreativeWorkflowParams
ResumeCreativeWorkflowResult
Reward
RunRecord
SizePreset
SocketEventSubscriptionUpdate
SocketSubscriptionEntitlementData
SocketSubscriptionFairUseState
SocketSubscriptionLimitNoticeData
SogniAttributionConfig
SogniClientConfig
StartChatRunParams
StartCreativeWorkflowDependency
StartCreativeWorkflowInput
StartCreativeWorkflowOptions
StartCreativeWorkflowParams
StartCreativeWorkflowStep
StreamChatRunEventsOptions
StreamCreativeWorkflowEventsOptions
SubscriptionCheckoutResult
SubscriptionEntitlementSnapshot
SubscriptionFairUseState
SubscriptionPlan
SubscriptionPortalSession
SubscriptionUsage
TextContentPart
ToolCall
ToolCallDelta
ToolCallFunction
ToolDefinition
ToolExecutionOptions
ToolExecutionProgress
ToolExecutionResult
ToolFunction
ToolHistoryEntry
TrialEligibility
TxHistoryEntry
VideoControlNetParams
VideoProjectParams
WorkflowTemplate
WorkflowTemplateRequestOptions
WorkloadAttribution
WorkloadAttributionDefaults
WorkloadAttributionInput
Type Aliases
AgentSurface
AudioFormat
AudioOutputFormat
BillingMode
ChatResponseFormat
ChatRunStatus
ContentPart
ControlNetMode
ControlNetName
CreativeWorkflowHostedToolName
CreativeWorkflowStatus
ExecutionMode
HostedChatCompletionParams
HostedSynchronousToolName
ImageOutputFormat
InputMedia
InteractionKind
JobEvent
JobPreparation
JobStatus
LogLevel
OperationScope
ProjectEvent
ProjectParams
ProjectStatus
SocketEventName
SocketEventSubscriptionInput
SocketEventSubscriptionName
SocketEventSubscriptions
SocketEventSubscriptionsUpdatedData
SogniToolsMode
SubscriptionErrorCode
SubscriptionPlanId
SubscriptionPlanInterval
SubscriptionRedirectType
SubscriptionStatus
SubscriptionTerm
SupernetType
ToastMessage
TokenType
ToolChoice
TrialReasonCode
VideoControlNetName
VideoFormat
VideoOutputFormat
VideoWorkflowType
WorkflowTemplateAuthor
WorkflowTemplateStability
WorkflowTemplateVisibility
WorkflowTemplateVisibilityFilter
WorkloadKind
Variables
SogniTools
SUBSCRIPTION_ERROR_CODES
Functions
isSogniToolCall
isSubscriptionLimitError
parseCreativeWorkflowSseChunk
parseToolCallArguments
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Modules
<internal>
Classes
Api
Error
Api
Key
Auth
Manager
Chat
Job
Error
Chat
Stream
Chat
Tools
Api
Creative
Workflows
Api
Creative
Workflow
Templates
Api
Current
Account
Data
Entity
Job
Project
Replay
Api
Sogni
Client
Interfaces
Agent
Attribution
Metadata
Audio
Project
Params
Authenticated
Data
Available
Model
Balances
Chat
Completion
Chunk
Chat
Completion
Params
Chat
Completion
Result
Chat
Job
Error
Fields
Chat
Job
State
Event
Chat
Message
Chat
Run
Event
Chat
Run
Record
Chat
Token
Usage
Connection
Attribution
Control
Net
Params
Cost
Estimation
Create
Subscription
Checkout
Options
Creative
Workflow
Artifact
Creative
Workflow
Event
Creative
Workflow
Record
Creative
Workflow
Sse
Event
Error
Data
Estimate
Request
Fork
Workflow
Template
Body
Get
Replay
Record
Result
Hosted
Chat
Completion
Choice
Hosted
Chat
Completion
Message
Hosted
Chat
Completion
Result
Hosted
Creative
Workflow
Reference
Hosted
Tool
Execution
Params
Hosted
Tool
Execution
Result
Image
Project
Params
Image
Url
Content
Part
List
Creative
Workflow
Options
List
Replay
Records
Options
List
Replay
Records
Result
List
Workflow
Templates
Options
List
Workflow
Templates
Result
LLMCost
Estimation
LLMJob
Cost
LLMModel
Info
LLMParam
Constraint
LLMSampling
Defaults
Logger
Operation
Lineage
Raw
Project
Replay
Record
Summary
Replay
Request
Options
Replay
Write
Result
Reseed
Creative
Workflow
Options
Reseed
Creative
Workflow
Params
Reseed
Creative
Workflow
Result
Resume
Creative
Workflow
Options
Resume
Creative
Workflow
Params
Resume
Creative
Workflow
Result
Reward
Run
Record
Size
Preset
Socket
Event
Subscription
Update
Socket
Subscription
Entitlement
Data
Socket
Subscription
Fair
Use
State
Socket
Subscription
Limit
Notice
Data
Sogni
Attribution
Config
Sogni
Client
Config
Start
Chat
Run
Params
Start
Creative
Workflow
Dependency
Start
Creative
Workflow
Input
Start
Creative
Workflow
Options
Start
Creative
Workflow
Params
Start
Creative
Workflow
Step
Stream
Chat
Run
Events
Options
Stream
Creative
Workflow
Events
Options
Subscription
Checkout
Result
Subscription
Entitlement
Snapshot
Subscription
Fair
Use
State
Subscription
Plan
Subscription
Portal
Session
Subscription
Usage
Text
Content
Part
Tool
Call
Tool
Call
Delta
Tool
Call
Function
Tool
Definition
Tool
Execution
Options
Tool
Execution
Progress
Tool
Execution
Result
Tool
Function
Tool
History
Entry
Trial
Eligibility
Tx
History
Entry
Video
Control
Net
Params
Video
Project
Params
Workflow
Template
Workflow
Template
Request
Options
Workload
Attribution
Workload
Attribution
Defaults
Workload
Attribution
Input
Type Aliases
Agent
Surface
Audio
Format
Audio
Output
Format
Billing
Mode
Chat
Response
Format
Chat
Run
Status
Content
Part
Control
Net
Mode
Control
Net
Name
Creative
Workflow
Hosted
Tool
Name
Creative
Workflow
Status
Execution
Mode
Hosted
Chat
Completion
Params
Hosted
Synchronous
Tool
Name
Image
Output
Format
Input
Media
Interaction
Kind
Job
Event
Job
Preparation
Job
Status
Log
Level
Operation
Scope
Project
Event
Project
Params
Project
Status
Socket
Event
Name
Socket
Event
Subscription
Input
Socket
Event
Subscription
Name
Socket
Event
Subscriptions
Socket
Event
Subscriptions
Updated
Data
Sogni
Tools
Mode
Subscription
Error
Code
Subscription
Plan
Id
Subscription
Plan
Interval
Subscription
Redirect
Type
Subscription
Status
Subscription
Term
Supernet
Type
Toast
Message
Token
Type
Tool
Choice
Trial
Reason
Code
Video
Control
Net
Name
Video
Format
Video
Output
Format
Video
Workflow
Type
Workflow
Template
Author
Workflow
Template
Stability
Workflow
Template
Visibility
Workflow
Template
Visibility
Filter
Workload
Kind
Variables
Sogni
Tools
SUBSCRIPTION_
ERROR_
CODES
Functions
is
Sogni
Tool
Call
is
Subscription
Limit
Error
parse
Creative
Workflow
Sse
Chunk
parse
Tool
Call
Arguments
@sogni-ai/sogni-client
Loading...