Class SdkOptions

Namespace

CivitaiSharp.Core

Assembly

CivitaiSharp.Core.dll

Configuration options for the Sdk library (Generator/Orchestration API).

public sealed class SdkOptions

Inheritance

object

SdkOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Fields

DefaultBaseUrl

Default base URL for the Civitai Orchestration API.

public const string DefaultBaseUrl = "https://orchestration.civitai.com"

Field Value

string

DefaultTimeoutSeconds

Default timeout in seconds for HTTP requests. Set to 10 minutes to accommodate long-running generation jobs.

public const int DefaultTimeoutSeconds = 600

Field Value

int

DefaultVersion

Default API version path segment.

public const string DefaultVersion = "v1"

Field Value

string

MaxTimeoutSeconds

Maximum allowed timeout in seconds.

public const int MaxTimeoutSeconds = 1800

Field Value

int

Properties

Key

API token for authentication. Required for all Sdk operations. Obtain from: https://civitai.com/user/account

public string? Key { get; set; }

Property Value

string

Timeout

Gets the timeout as a TimeSpan.

public TimeSpan Timeout { get; }

Property Value

TimeSpan

TimeoutSeconds

Timeout in seconds for HTTP requests. Must be between 1 and 1800 seconds. Default is 600 seconds (10 minutes) to accommodate long-running generation jobs.

public int TimeoutSeconds { get; set; }

Property Value

int

Version

API version path segment (e.g., "v1").

public string Version { get; set; }

Property Value

string

Methods

GetApiPath(string)

Constructs the full API path for a relative endpoint.

public string GetApiPath(string relativePath)

Parameters

relativePath string

Returns

string

Validate()

Validates configuration and normalizes values.

public void Validate()