Class ApiOptions

Namespace

CivitaiSharp.Core

Assembly

CivitaiSharp.Core.dll

Configuration options for the Core library (public API).

public sealed class ApiOptions

Inheritance

object

ApiOptions

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 API.

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

Field Value

string

DefaultTimeoutSeconds

Default timeout in seconds for HTTP requests.

public const int DefaultTimeoutSeconds = 30

Field Value

int

DefaultVersion

Default API version.

public const string DefaultVersion = "v1"

Field Value

string

MaxTimeoutSeconds

Maximum allowed timeout in seconds.

public const int MaxTimeoutSeconds = 300

Field Value

int

Properties

Key

Optional API key for authenticated requests. Required for favorites, and hidden models, and NSFW models. 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 300 seconds.

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()