Blazor Diffusion

<back to all web services

QueryArtifacts

Artifacts
QueryArtifacts Parameters:
NameParameterData TypeRequiredDescription
Idqueryint?No
IdsqueryList<int>No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>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
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

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/QueryArtifacts HTTP/1.1 
Host: blazordiffusion.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	ids: 
	[
		0
	],
	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,
			creativeId: 0,
			fileName: String,
			filePath: String,
			contentType: String,
			contentLength: 0,
			width: 0,
			height: 0,
			seed: 0,
			prompt: String,
			nsfw: False,
			averageHash: 0,
			perceptualHash: 0,
			differenceHash: 0,
			background: String,
			lqip: String,
			quality: 0,
			likesCount: 0,
			albumsCount: 0,
			downloadsCount: 0,
			searchCount: 0,
			temporalScore: 0,
			score: 0,
			rank: 0,
			refId: String,
			versions: 
			{
				String: String
			},
			createdDate: 0001-01-01,
			createdBy: String,
			modifiedDate: 0001-01-01,
			modifiedBy: String,
			deletedDate: 0001-01-01,
			deletedBy: String
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}