Blazor Diffusion

<back to all web services

QueryApiProviders

QueryApiProviders Parameters:
NameParameterData TypeRequiredDescription
NamequerystringYes
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
ApiProvider Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringYes
ApiBaseUrlformstringYes
ApiTypeIdformintNo
ApiKeyVarformstringYes
ApiKeyformstringYes
ApiKeyHeaderformstringYes
HeartbeatUrlformstringYes
ConcurrencyformintNo
PriorityformintNo
EnabledformboolNo
OfflineDateformDateTime?No
CreatedDateformDateTimeNo
ModelsformList<ApiProviderModel>Yes
ApiTypeformApiTypeYes
SelectedModelsformList<string>Yes
ApiProviderModel Parameters:
NameParameterData TypeRequiredDescription
ModelformstringYes
ApiModelformstringYes
ApiType Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ProviderformAiProviderNo
NameformstringYes
WebsiteformstringYes
ApiBaseUrlformstringYes
HeartbeatUrlformstringYes
IconformstringYes
ApiModelsformDictionary<string, string>Yes
AiProvider Enum:
OpenAiProvider
GoogleAiProvider
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<ArtifactResult>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
ArtifactResult Parameters:
NameParameterData TypeRequiredDescription
UserPromptformstringYes
ArtistNamesformList<string>Yes
ModifierNamesformList<string>Yes
PrimaryArtifactIdformint?No
OwnerRefformstringYes
Similarityformdouble?No
Artifact Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CreativeIdformintNo
FileNameformstringYes
FilePathformstringYes
ContentTypeformstringYes
ContentLengthformlongNo
WidthformintNo
HeightformintNo
SeedformulongNo
PromptformstringYes
Nsfwformbool?No
AverageHashformlong?No
PerceptualHashformlong?No
DifferenceHashformlong?No
BackgroundformstringNo
LqipformstringNo
QualityformintNo
LikesCountformintNo
AlbumsCountformintNo
DownloadsCountformintNo
SearchCountformintNo
TemporalScoreformintNo
ScoreformintNo
RankformintNo
RefIdformstringYes
VersionsformDictionary<string, string>Yes
AuditBase Parameters:
NameParameterData TypeRequiredDescription
CreatedDateformDateTimeNo
CreatedByformstringYes
ModifiedDateformDateTimeNo
ModifiedByformstringYes
DeletedDateformDateTime?No
DeletedByformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/QueryApiProviders HTTP/1.1 
Host: blazordiffusion.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	name: String,
	skip: 0,
	take: 0,
	orderBy: String,
	orderByDesc: String,
	include: String,
	fields: String,
	meta: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			id: 0,
			name: String,
			apiBaseUrl: String,
			apiTypeId: 0,
			apiKeyVar: String,
			apiKey: String,
			apiKeyHeader: String,
			heartbeatUrl: String,
			concurrency: 0,
			priority: 0,
			enabled: False,
			offlineDate: 0001-01-01,
			createdDate: 0001-01-01,
			models: 
			[
				{
					model: String,
					apiModel: String
				}
			],
			apiType: 
			{
				id: 0,
				provider: OpenAiProvider,
				name: String,
				website: String,
				apiBaseUrl: String,
				heartbeatUrl: String,
				icon: String,
				apiModels: 
				{
					String: String
				}
			},
			selectedModels: 
			[
				String
			]
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}